3.0.0-RC

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

DualStreamer

open class DualStreamer(val context: Context, val withAudio: Boolean = true, val withVideo: Boolean = true, firstEndpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), secondEndpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation) : IDualStreamer, IAudioDualStreamer, IVideoDualStreamer

A class that handles 2 outputs.

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

Parameters

context

the application context

withAudio

Boolean.true to capture audio. It can't be changed after instantiation.

withVideo

Boolean.true to capture video. It can't be changed after instantiation.

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.

Constructors

constructor(context: Context, withAudio: Boolean = true, withVideo: Boolean = true, firstEndpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), secondEndpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation)

Properties

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.

protected val context: Context

open override val first: IConfigurableAudioVideoEncodingPipelineOutput

First output of the streamer.

open override val isOpenFlow: StateFlow<Boolean>

Whether any of the output is opening.

val IWithVideoSource.isPreviewable: Boolean

Whether the video source has a preview.

isStreamingFlow

open override val isStreamingFlow: StateFlow<Boolean>

Whether any of the output is streaming.

open override val second: IConfigurableAudioVideoEncodingPipelineOutput

Second output of the streamer.

open override val throwableFlow: StateFlow<Throwable?>

Returns the last throwable that occurred.

videoSourceFlow

open override val videoSourceFlow: StateFlow<IVideoSource?>

A video source flow to access to advanced settings.

val withAudio: Boolean = true

val withVideo: Boolean = true

Functions

open suspend override fun close()

Closes the outputs. Same as calling first.close and second.close.

open suspend override fun release()

Clean and reset the streamer.

releaseBlocking

fun IStreamer.releaseBlocking()

Clean and reset the streamer synchronously.

setActivityResult

fun IVideoStreamer<*>.setActivityResult(activityResult: ActivityResult)

Sets activity result from ComponentActivity.registerForActivityResult callback.

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

open suspend override fun setAudioConfig(audioConfig: DualStreamerAudioConfig)

Sets audio configuration.

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

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

Sets video configuration.

open suspend override 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.