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

AudioOnlySingleStreamer

class AudioOnlySingleStreamer(context: Context, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory()) : ISingleStreamer, IAudioSingleStreamer

A ISingleStreamer implementation for audio only (without video).

Parameters

context

the application context

endpointFactory

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

Constructors

AudioOnlySingleStreamer

constructor(context: Context, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory())

Properties

audioConfigFlow

open override val audioConfigFlow: StateFlow<AudioConfig?>

The audio configuration flow.

audioEncoder

open override val audioEncoder: IEncoder?

Advanced settings for the audio encoder.

audioProcessor

open override val audioProcessor: IAudioFrameProcessor?

Advanced settings for the audio processor.

audioSourceFlow

open override val audioSourceFlow: StateFlow<IAudioSource?>

An audio source flow 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.

Functions

addBitrateRegulatorController

open override fun addBitrateRegulatorController(controllerFactory: IBitrateRegulatorController.Factory)

Adds a bitrate regulator controller to the streamer.

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()

Clean and reset the streamer synchronously.

removeBitrateRegulatorController

open override fun removeBitrateRegulatorController()

Removes the bitrate regulator controller from the streamer.

setAudioConfig

open suspend override fun setAudioConfig(audioConfig: AudioConfig)

Configures only audio settings.

setAudioSource

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

Sets the 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.