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

LocalScreencastVideoTrack

class LocalScreencastVideoTrack @AssistedInject constructor(@Assisted capturer: VideoCapturer, @Assisted source: VideoSource, @Assisted name: String, @Assisted options: LocalVideoTrackOptions, @Assisted rtcTrack: VideoTrack, @Assisted mediaProjectionCallback: LocalScreencastVideoTrack.MediaProjectionCallback, peerConnectionFactory: PeerConnectionFactory, context: Context, eglBase: EglBase, defaultsManager: DefaultsManager, videoTrackFactory: LocalVideoTrack.Factory) : LocalVideoTrack

A video track that captures the screen for publishing.

Note: A foreground service is generally required for use. Use startForegroundService or start your own foreground service before starting the video track.

Constructors

@AssistedInject

constructor(@Assisted capturer: VideoCapturer, @Assisted source: VideoSource, @Assisted name: String, @Assisted options: LocalVideoTrackOptions, @Assisted rtcTrack: VideoTrack, @Assisted mediaProjectionCallback: LocalScreencastVideoTrack.MediaProjectionCallback, peerConnectionFactory: PeerConnectionFactory, context: Context, eglBase: EglBase, defaultsManager: DefaultsManager, videoTrackFactory: LocalVideoTrack.Factory)

Types

Companion

object Companion

Factory

@AssistedFactory

interface Factory

MediaProjectionCallback

class MediaProjectionCallback : MediaProjection.Callback

Needed to deal with circular dependency.

Properties

capturer

var capturer: VideoCapturer

dimensions

val dimensions: Track.Dimensions

enabled

var enabled: Boolean

events

val events: EventListenable<TrackEvent>

kind

var kind: Track.Kind

name

var name: String

options

@FlowObservable

@get:FlowObservable

var options: LocalVideoTrackOptions

rtcTrack

open override var rtcTrack: VideoTrack

sid

var sid: String?

statsGetter

var statsGetter: RTCStatsGetter?

streamState

var streamState: Track.StreamState

Functions

addRenderer

open override fun addRenderer(renderer: VideoSink)

Add a VideoSink that will receive frames.

dispose

open override fun dispose()

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

getRTCStats

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.

removeRenderer

open override fun removeRenderer(renderer: VideoSink)

Remove a previously added VideoSink.

restartTrack

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

Restart a track with new options.

setDeviceId

fun ~~setDeviceId~~(deviceId: String)

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

start

open fun start()

Starts the track.

startCapture

open override fun startCapture()

Starts the capturer with the capture params contained in options.

startForegroundService

suspend fun startForegroundService(notificationId: Int?, notification: Notification?)

A foreground service is generally required prior to startCapture for screen capture. This method starts up a helper foreground service that only serves to display a notification while capturing. This foreground service will automatically stop upon the end of screen capture.

stop

open override fun stop()

Stops the track.

stopCapture

open fun stopCapture()

Stops the capturer.

switchCamera

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

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

LocalScreencastVideoTrack

See also

Constructors

Types

Properties

Functions