streampack-core/io.github.thibaultbee.streampack.core.streamers.dual/DualStreamer

DualStreamer

class DualStreamer(context: Context, firstEndpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), secondEndpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider()) : IDualStreamer, IAudioDualStreamer, IVideoDualStreamer(source)

A class that handles 2 outputs.

For example, you can use it to live stream and record simultaneously.

Parameters

context

the application context

firstEndpointFactory

the IEndpointInternal implementation of the first output. By default, it is a DynamicEndpoint.

secondEndpointFactory

the IEndpointInternal implementation of the second output. By default, it is a DynamicEndpoint.

defaultRotation

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

surfaceProcessorFactory

the ISurfaceProcessorInternal.Factory implementation to use to create the video processor. By default, it is a DefaultSurfaceProcessorFactory.

dispatcherProvider

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

Constructors

constructor(context: Context, firstEndpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), secondEndpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation, surfaceProcessorFactory: ISurfaceProcessorInternal.Factory = DefaultSurfaceProcessorFactory(), dispatcherProvider: IDispatcherProvider = DispatcherProvider())

Properties

open override val audioInput: IAudioInput

The audio input to access to advanced settings.

open override val first: IConfigurableAudioVideoEncodingPipelineOutput

First output of the streamer.

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.

val IWithVideoSource.isPreviewable: Boolean

Whether the video source has a preview.

isStreamingFlow

open override val isStreamingFlow: StateFlow<Boolean>

Returns true if stream is running.

open override val second: IConfigurableAudioVideoEncodingPipelineOutput

Second output of the streamer.

open override val throwableFlow: StateFlow<Throwable?>

Returns the last throwable that occurred.

open override val videoInput: IVideoInput

The video input to access to advanced settings.

Functions

open suspend override fun close()

Closes the streamer endpoint.

open suspend override fun release()

Clean and reset the streamer.

releaseBlocking

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

Clean and reset the streamer synchronously.

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

open suspend override fun setAudioConfig(audioConfig: DualStreamerAudioConfig)

Configures only audio settings.

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

suspend fun IAudioDualStreamer.setAudioConfig(audioConfig: AudioConfig)

Sets audio configuration.

open suspend fun setAudioSource(audioSourceFactory: IAudioSourceInternal.Factory)

Sets a new audio source.

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

suspend fun IWithVideoSource.setCameraId(cameraId: String)

Sets the camera id.

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

suspend fun DualStreamer.setConfig(audioConfig: DualStreamerAudioConfig, videoConfig: DualStreamerVideoConfig)

Configures both video and audio settings.

suspend fun IWithVideoSource.setPreview(surface: Surface)

Sets the preview surface.

suspend fun IWithVideoSource.setPreview(surfaceHolder: SurfaceHolder)

Sets a preview surface holder.

suspend fun IWithVideoSource.setPreview(surfaceView: SurfaceView)

suspend fun IWithVideoSource.setPreview(textureView: TextureView)

Sets a preview surface.

setTargetRotation

open suspend override fun setTargetRotation(rotation: Int)

Sets the target rotation.

open suspend override fun setVideoConfig(videoConfig: DualStreamerVideoConfig)

Configures only video settings.

suspend fun IVideoDualStreamer.setVideoConfig(videoConfig: VideoConfig)

Sets video configuration.

open suspend fun setVideoSource(videoSourceFactory: IVideoSourceInternal.Factory)

Sets the video source.

suspend fun IWithVideoSource.startPreview()

Starts video preview.

suspend fun IWithVideoSource.startPreview(surface: Surface)

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

suspend fun IWithVideoSource.startPreview(surfaceHolder: SurfaceHolder)

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

suspend fun IWithVideoSource.startPreview(surfaceView: SurfaceView)

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

suspend fun IWithVideoSource.startPreview(textureView: TextureView)

Sets preview surface and start video preview.

open suspend override fun startStream()

Starts audio/video stream.

suspend fun IWithVideoSource.stopPreview()

Stops video preview.

open suspend override fun stopStream()

Stops audio/video stream.