sdk-media/com.pexip.sdk.media/LocalVideoTrack

LocalVideoTrack

interface LocalVideoTrack : LocalMediaTrack, VideoTrack

A local video track.

Inheritors

Inherited properties

Link copied to clipboard
abstract val capturing: Boolean

true if capturing, false otherwise

Functions

Link copied to clipboard
abstract fun startCapture(profile: QualityProfile)

Starts the capture with a specific QualityProfile.

Inherited functions

Link copied to clipboard
abstract fun addRenderer(renderer: Renderer)

Adds the supplied renderer and starts drawing on it.

Link copied to clipboard
fun LocalMediaTrack.capturingIn(scope: CoroutineScope, started: SharingStarted): StateFlow<Boolean>

Converts this LocalMediaTrack capturing state to a StateFlow.

Link copied to clipboard
abstract fun dispose()

Disposes this LocalMediaTrack and frees any resources held by it.

Link copied to clipboard
fun LocalMediaTrack.getCapturing(): Flow<Boolean>

Converts this LocalMediaTrack capturing state to a Flow.

Link copied to clipboard
abstract fun registerCapturingListener(listener: LocalMediaTrack.CapturingListener)

Registers a CapturingListener that will be notified when capturing state changes.

Link copied to clipboard
abstract fun removeRenderer(renderer: Renderer)

Removes the supplied renderer and stops drawing on it.

Link copied to clipboard
abstract fun startCapture()

Start the capture.

Link copied to clipboard
abstract fun stopCapture()

Stops the capture.

Link copied to clipboard
abstract fun unregisterCapturingListener(listener: LocalMediaTrack.CapturingListener)

Unregisters a previously registered CapturingListener.