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

SingleStreamer

open class SingleStreamer(val context: Context, val withAudio: Boolean = true, val withVideo: Boolean = true, endpointFactory: IEndpointInternal.Factory = DynamicEndpointFactory(), defaultRotation: Int = context.displayRotation) : ISingleStreamer, IAudioSingleStreamer, IVideoSingleStreamer

A ISingleStreamer implementation for audio and video.

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.

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.

Constructors

SingleStreamer

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

Types

Companion

object Companion

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?>

The audio source. It allows advanced audio source settings.

context

protected val context: Context

endpoint

open override val endpoint: IEndpoint

Advanced settings for the endpoint.

info

open override val info: IConfigurationInfo

Gets 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.

videoSourceFlow

open override val videoSourceFlow: StateFlow<IVideoSource?>

The video source. It allows advanced video source settings.

withAudio

val withAudio: Boolean = true

withVideo

val withVideo: Boolean = true

Functions

addBitrateRegulatorController

open override fun addBitrateRegulatorController(controllerFactory: IBitrateRegulatorController.Factory)

Adds a bitrate regulator controller.

open suspend override fun close()

Closes the streamer endpoint.

getInfo

open override fun getInfo(descriptor: MediaDescriptor): IConfigurationInfo

Gets configuration information from MediaDescriptor.

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

Releases the streamer.

releaseBlocking

fun IStreamer.releaseBlocking()

Clean and reset the streamer synchronously.

removeBitrateRegulatorController

open override fun removeBitrateRegulatorController()

Removes the bitrate regulator controller.

setActivityResult

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

Sets activity result from ComponentActivity.registerForActivityResult callback.

setAudioConfig

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

open suspend override fun setAudioConfig(audioConfig: AudioConfig)

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

setAudioSource

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

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

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.

setVideoConfig

open suspend override fun setVideoConfig(videoConfig: VideoConfig)

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

setVideoSource

open suspend override fun setVideoSource(videoSourceFactory: IVideoSourceInternal.Factory)

Sets the video source.

startPreview

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.

startStream

open suspend override fun startStream()

Starts audio/video stream. Stream depends of the endpoint: Audio/video could be write to a file or send to a remote device. To avoid creating an unresponsive UI, do not call on main thread.

startStream

suspend fun IOpenableStreamer.startStream(uri: Uri)

suspend fun IOpenableStreamer.startStream(descriptor: MediaDescriptor)

suspend fun IOpenableStreamer.startStream(uriString: String)

Starts audio/video stream.

stopPreview

suspend fun IWithVideoSource.stopPreview()

Stops video preview.

stopStream

open suspend override fun stopStream()

Stops audio/video stream.