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

SingleStreamer

class SingleStreamer(context: Context, audioInputMode: StreamerPipeline.AudioInputMode = StreamerPipeline.AudioInputMode.CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()) : ISingleStreamer, IAudioSingleStreamer, IVideoSingleStreamer(source)

A ISingleStreamer implementation for both audio and 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.

defaultRotation

the default rotation in Surface rotation (Surface.ROTATION_0, ...). By default, it is the current device orientation.

surfaceProcessorFactory

the ISurfaceProcessorInternal.Factory implementation. By default, it is a DefaultSurfaceProcessorFactory.

dispatcherProvider

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

Constructors

SingleStreamer

constructor(context: Context, audioInputMode: StreamerPipeline.AudioInputMode = StreamerPipeline.AudioInputMode.CALLBACK, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), 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.

bitrateRegulatorControllerFactory

open override var bitrateRegulatorControllerFactory: IBitrateRegulatorController.Factory?

Adds a bitrate regulator controller to the streamer.

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.

isPreviewable

val IWithVideoSource.isPreviewable: Boolean

Whether the video source has a preview.

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.

videoConfigFlow

open override val videoConfigFlow: StateFlow<VideoConfig?>

The video configuration flow.

videoEncoder

open override val videoEncoder: IEncoder?

Advanced settings for the video encoder.

videoInput

open override val videoInput: IVideoInput

The video input to access to advanced settings.

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 fun setAudioSource(audioSourceFactory: IAudioSourceInternal.Factory)

Sets a new audio source.

setCameraId

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

suspend fun IWithVideoSource.setCameraId(cameraId: String)

Sets the camera id.

setConfig

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

suspend fun SingleStreamer.setConfig(audioConfig: AudioConfig, videoConfig: VideoConfig)

Configures both video and audio settings. It is the first method to call after a SingleStreamer instantiation. It must be call when both stream and audio and video capture are not running.

setPreview