streampack-core/io.github.thibaultbee.streampack.core.elements.sources.video/AbstractPreviewableSource

AbstractPreviewableSource

abstract class AbstractPreviewableSource : ISurfaceSourceInternal, IVideoSourceInternal, IPreviewableSource(source)

Abstract class for previewable sources to manage requestRelease.

Constructors

AbstractPreviewableSource

constructor()

Properties

infoProviderFlow

abstract val infoProviderFlow: StateFlow<ISourceInfoProvider>

Orientation provider of the capture source. It is used to orientate the frame according to the source orientation.

isPreviewingFlow

abstract val isPreviewingFlow: StateFlow<Boolean>

Flow of the last previewing state.

isStreamingFlow

abstract val isStreamingFlow: StateFlow<Boolean>

Flow of the last streaming state.

open override val previewMutex: Mutex

Mutex for the preview. Use it when you have to synchronise access to the preview. It is used by the IPreviewableSource user.

abstract val timebase: Timebase

Gets the timebase used for the video source. If you can, prefer Timebase.REALTIME for video sources.

Functions

abstract suspend fun configure(config: VideoSourceConfig)

Configure the Configurable implementation.

abstract suspend fun getOutput(): Surface?

Gets the output surface for the video stream.

abstract fun <T> getPreviewSize(targetSize: Size, targetClass: Class<T>): Size

Gets the preview size from the target size.

abstract suspend fun hasPreview(): Boolean

Whether the video source has a preview.

abstract suspend fun release()

Closes and releases resources

open suspend override fun requestRelease()

Requests release.

open suspend override fun resetOutput()

Resets output and releases if isReleasedRequested is true.

resetOutputImpl

abstract suspend fun resetOutputImpl()

Resets output implementation.

open suspend override fun resetPreview()

Resets preview and releases if isReleasedRequested is true.

resetPreviewImpl

abstract suspend fun resetPreviewImpl()

Resets preview implementation.

abstract suspend fun setOutput(surface: Surface)

Sets the output surface for the video stream.

abstract suspend fun setPreview(surface: Surface)

Sets preview surface.

suspend fun IPreviewableSource.setPreview(surfaceHolder: SurfaceHolder)

Sets a preview surface holder.

suspend fun IPreviewableSource.setPreview(surfaceView: SurfaceView)

suspend fun IPreviewableSource.setPreview(textureView: TextureView)

Sets a preview surface.

abstract suspend fun startPreview()

Starts video preview.

open suspend fun startPreview(surface: Surface)

Sets preview surface and start video preview.

suspend fun IPreviewableSource.startPreview(surfaceHolder: SurfaceHolder)

suspend fun IPreviewableSource.startPreview(surfaceView: SurfaceView)

suspend fun IPreviewableSource.startPreview(textureView: TextureView)

Starts audio and video capture. If you can prefer to call SingleStreamer.setAudioConfig before starting preview. It is a shortcut for setPreview and startPreview.

abstract suspend fun startStream()

Starts frames or data stream generation Throws an exception if not ready for live stream

abstract suspend fun stopPreview()

Stops video preview.

abstract suspend fun stopStream()

Stops frames or data stream generation