sdk-media/com.pexip.sdk.media/LocalMediaTrack

LocalMediaTrack

interface LocalMediaTrack

A local media track.

Inheritors

LocalAudioTrack

LocalVideoTrack

Types

CapturingListener

fun interface CapturingListener

A listener that notifies of capturing state changes.

Properties

abstract val capturing: Boolean

true if capturing, false otherwise

Functions

abstract fun dispose()

Disposes this LocalMediaTrack and frees any resources held by it.

registerCapturingListener

abstract fun registerCapturingListener(listener: LocalMediaTrack.CapturingListener)

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

abstract fun startCapture()

Start the capture.

abstract fun stopCapture()

Stops the capture.

unregisterCapturingListener

abstract fun unregisterCapturingListener(listener: LocalMediaTrack.CapturingListener)

Unregisters a previously registered CapturingListener.

Inherited functions

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

Converts this LocalMediaTrack capturing state to a StateFlow.

fun LocalMediaTrack.getCapturing(): Flow<Boolean>

Converts this LocalMediaTrack capturing state to a Flow.