livekit-android-sdk/io.livekit.android.room.track/LocalVideoTrack

LocalVideoTrack

open class LocalVideoTrack @AssistedInject constructor(@Assisted capturer: VideoCapturer, @Assisted source: VideoSource, @Assisted name: String, @Assisted options: LocalVideoTrackOptions, @Assisted rtcTrack: VideoTrack, peerConnectionFactory: PeerConnectionFactory, context: Context, eglBase: EglBase, defaultsManager: DefaultsManager, trackFactory: LocalVideoTrack.Factory, @Assisted dispatchObserver: CaptureDispatchObserver? = null) : VideoTrack

A representation of a local video track (generally input coming from camera or screen).

startCapture should be called before use.

Inheritors

LocalScreencastVideoTrack

Constructors

LocalVideoTrack

@AssistedInject

constructor(@Assisted capturer: VideoCapturer, @Assisted source: VideoSource, @Assisted name: String, @Assisted options: LocalVideoTrackOptions, @Assisted rtcTrack: VideoTrack, peerConnectionFactory: PeerConnectionFactory, context: Context, eglBase: EglBase, defaultsManager: DefaultsManager, trackFactory: LocalVideoTrack.Factory, @Assisted dispatchObserver: CaptureDispatchObserver? = null)

Types

object Companion

@AssistedFactory

interface Factory

Properties

var capturer: VideoCapturer

val dimensions: Track.Dimensions

var enabled: Boolean

val events: EventListenable<TrackEvent>

var kind: Track.Kind

var name: String

@FlowObservable

@get:FlowObservable

var options: LocalVideoTrackOptions

open override var rtcTrack: VideoTrack

var sid: String?

var statsGetter: RTCStatsGetter?

var streamState: Track.StreamState

Functions

open override fun addRenderer(renderer: VideoSink)

Add a VideoSink that will receive frames.

open override fun dispose()

Disposes the track. LiveKit will generally take care of disposing tracks for you.

suspend fun getRTCStats(): RTCStatsReport?

Return the RTCStatsReport for this track, or null if none is available.

fun getRTCStats(callback: RTCStatsCollectorCallback)

Calls the callback with the RTCStatsReport for this track, or null if none is available.

open override fun removeRenderer(renderer: VideoSink)

Remove a previously added VideoSink.

fun restartTrack(options: LocalVideoTrackOptions = defaultsManager.videoTrackCaptureDefaults.copy())

Restart a track with new options.

fun ~~setDeviceId~~(deviceId: String)

If this is a camera track, switches to the new camera determined by deviceId

open fun start()

Starts the track.

open fun startCapture()

Starts the capturer with the capture params contained in options.

open override fun stop()

Stops the track.

open fun stopCapture()

Stops the capturer.

fun switchCamera(deviceId: String? = null, position: CameraPosition? = null)

Switch to a different camera. Only works if this track is backed by a camera capturer.