streampack-core/io.github.thibaultbee.streampack.core.pipelines.inputs/IVideoInput

IVideoInput

interface IVideoInput : ISnapshotable(source)

The public interface for the video input. It provides access to the video source, the video processor, and the streaming state.

Properties

open var isMuted: Boolean

Mute the video stream. The video stream will be replaced by a black screen. It is a shortcut to ISurfaceProcessor.isMuted

isStreamingFlow

abstract val isStreamingFlow: StateFlow<Boolean>

Whether the video input is streaming.

abstract val processor: ISurfaceProcessorInternal

The video processor for adding effects to the video frames.

abstract val sourceFlow: StateFlow<IVideoSource?>

The video source

abstract val withConfig: Boolean

Whether the video input has a configuration. It is true if the video source has been configured.

val IVideoInput.withSource: Boolean

Whether the pipeline has a video source.

Functions

abstract suspend fun setSource(videoSourceFactory: IVideoSourceInternal.Factory)

Sets the video source.

takeJpegSnapshot

suspend fun ISnapshotable.takeJpegSnapshot(outputStream: OutputStream, @IntRange(from = 0, to = 100) quality: Int = 100, @IntRange(from = 0, to = 359) rotationDegrees: Int = 0)

Takes a snapshot of the current video frame.

suspend fun ISnapshotable.takeJpegSnapshot(file: File, @IntRange(from = 0, to = 100) quality: Int = 100, @IntRange(from = 0, to = 359) rotationDegrees: Int = 0, dispatcher: CoroutineDispatcher = Dispatchers.IO)

suspend fun ISnapshotable.takeJpegSnapshot(filePathString: String, @IntRange(from = 0, to = 100) quality: Int = 100, @IntRange(from = 0, to = 359) rotationDegrees: Int = 0, dispatcher: CoroutineDispatcher = Dispatchers.IO)

Takes a JPEG snapshot of the current video frame.

abstract suspend fun takeSnapshot(@IntRange(from = 0, to = 359) rotationDegrees: Int = 0): Bitmap

Takes a snapshot of the current video frame.