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

IAudioSingleStreamer

interface IAudioSingleStreamer : IAudioStreamer<AudioConfig> , ISingleStreamer(source)

An audio single Streamer

Inheritors

AudioOnlySingleStreamer

SingleStreamer

Properties

audioConfigFlow

abstract val audioConfigFlow: StateFlow<AudioConfig?>

The audio configuration flow.

audioEncoder

abstract val audioEncoder: IEncoder?

Advanced settings for the audio encoder.

audioInput

abstract val audioInput: IAudioInput

The audio input to access to advanced settings.

endpoint

abstract val endpoint: IEndpoint

Advanced settings for the endpoint.

info

abstract val info: IConfigurationInfo

Configuration information

isOpenFlow

abstract 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

abstract val isStreamingFlow: StateFlow<Boolean>

Returns true if stream is running.

throwableFlow

abstract val throwableFlow: StateFlow<Throwable?>

Returns the last throwable that occurred.

withAudio

val ISingleStreamer.withAudio: Boolean

withVideo

val ISingleStreamer.withVideo: Boolean

Functions

abstract suspend fun close()

Closes the streamer endpoint.

getInfo

abstract fun getInfo(descriptor: MediaDescriptor): IConfigurationInfo

Gets configuration information

open

abstract suspend 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

abstract suspend fun release()

Clean and reset the streamer.

releaseBlocking

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

Clean and reset the streamer synchronously.

setAudioConfig

abstract suspend fun setAudioConfig(audioConfig: AudioConfig)

Configures only audio settings.

setAudioSource

open suspend fun setAudioSource(audioSourceFactory: IAudioSourceInternal.Factory)

Sets a new audio source.

startStream

abstract suspend 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

abstract suspend fun stopStream()

Stops audio/video stream.