streampack-core/io.github.thibaultbee.streampack.core.streamers.single/AudioOnlySingleStreamer

AudioOnlySingleStreamer

class AudioOnlySingleStreamer(context: Context, audioInputMode: StreamerPipeline.AudioInputMode = CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()) : ISingleStreamer, IAudioSingleStreamer(source)

A ISingleStreamer implementation for audio only (without video).

Parameters

context

the application context

audioInputMode

the audio output mode. By default, it is StreamerPipeline.AudioInputMode.CALLBACK.

endpointFactory

the IEndpointInternal.Factory implementation. By default, it is a DynamicEndpointFactory.

dispatcherProvider

the IDispatcherProvider implementation. By default, it is a DispatcherProvider.

Constructors

AudioOnlySingleStreamer

constructor(context: Context, audioInputMode: StreamerPipeline.AudioInputMode = CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider())

Properties

audioConfigFlow

open override val audioConfigFlow: StateFlow<AudioConfig?>

The audio configuration flow.

audioEncoder

open override val audioEncoder: IEncoder?

Advanced settings for the audio encoder.

audioInput

open override val audioInput: IAudioInput

The audio input to access to advanced settings.

endpoint

open override val endpoint: IEndpoint

Advanced settings for the endpoint.

info

open override val info: IConfigurationInfo

Configuration information

isOpenFlow

open override val isOpenFlow: StateFlow<Boolean>

Returns true if output is opened. For example, if the streamer is connected to a server if the endpoint is SRT or RTMP.

isStreamingFlow

open override val isStreamingFlow: StateFlow<Boolean>

Returns true if stream is running.

throwableFlow

open override val throwableFlow: StateFlow<Throwable?>

Returns the last throwable that occurred.

withAudio

val ISingleStreamer.withAudio: Boolean

withVideo

val ISingleStreamer.withVideo: Boolean

Functions

open suspend override fun close()

Closes the streamer endpoint.

getInfo

open override fun getInfo(descriptor: MediaDescriptor): IConfigurationInfo

Gets configuration information

open

open suspend override fun open(descriptor: MediaDescriptor)

Opens the streamer endpoint.

open

suspend fun IOpenableStreamer.open(uri: Uri)

suspend fun IOpenableStreamer.open(uriString: String)

Opens the streamer endpoint.

release

open suspend override fun release()

Clean and reset the streamer.

releaseBlocking

fun IStreamer.releaseBlocking(dispatcher: CoroutineDispatcher = Dispatchers.Default)

Clean and reset the streamer synchronously.

setAudioConfig

@RequiresPermission(value = "android.permission.RECORD_AUDIO")

open suspend override fun setAudioConfig(audioConfig: AudioConfig)

Configures only audio settings.

setAudioSource

open suspend override fun setAudioSource(audioSourceFactory: IAudioSourceInternal.Factory)

Sets a new audio source.

startStream

open suspend override fun startStream()

Starts audio/video stream.

startStream

suspend fun IOpenableStreamer.startStream(uri: Uri)

suspend fun IOpenableStreamer.startStream(descriptor: MediaDescriptor)

suspend fun IOpenableStreamer.startStream(uriString: String)

Starts audio/video stream.

stopStream

open suspend override fun stopStream()

Stops audio/video stream.