Class LocalVideoTrack

Hierarchy (View Summary)

LocalTrack<Video>
- LocalVideoTrack

Constructors

constructor

new LocalVideoTrack(
    mediaTrack: MediaStreamTrack,
    constraints?: MediaTrackConstraints,
    userProvidedTrack?: boolean,
    loggerOptions?: LoggerOptions,
): LocalVideoTrack
Parameters
- mediaTrack: MediaStreamTrack
- Optionalconstraints: MediaTrackConstraints
  MediaTrackConstraints that are being used when restarting or reacquiring tracks
- userProvidedTrack: boolean = true
  Signals to the SDK whether or not the mediaTrack should be managed (i.e. released and reacquired) internally by the SDK
- OptionalloggerOptions: LoggerOptions
Returns LocalVideoTrack
Overrides LocalTrack<Track.Kind.Video>.constructor
- Defined in room/track/LocalVideoTrack.ts:92

Properties

attachedElements

attachedElements: HTMLMediaElement[] = []

isMuted

isMuted: boolean = false

`Readonly`kind

kind: Video

`Optional`lastEncodedDimensions

lastEncodedDimensions?: Dimensions

`Optional`publishOptions

publishOptions?: TrackPublishOptions

`Optional`sid

sid?: string

sid is set after track is published to server, or if it's a remote track

`Optional`signalClient

signalClient?: SignalClient

simulcastCodecs

simulcastCodecs: Map<
    "vp8"
    | "h264"
    | "vp9"
    | "av1"
    | "h265",
    SimulcastTrackInfo,
> = ...

source

source: Source

Accessors

constraints

get constraints(): MediaTrackConstraints
Returns MediaTrackConstraints
Inherited from LocalTrack.constraints
- Defined in room/track/LocalTrack.ts:46

currentBitrate

get currentBitrate(): number
current receive bits per second

Returns number
Inherited from Track.currentBitrate
- Defined in room/track/Track.ts:117

dimensions

get dimensions(): Dimensions | undefined
Returns Dimensions | undefined
Inherited from LocalTrack.dimensions
- Defined in room/track/LocalTrack.ts:117

hasPreConnectBuffer

get hasPreConnectBuffer(): boolean
Returns boolean
Inherited from LocalTrack.hasPreConnectBuffer
- Defined in room/track/LocalTrack.ts:50

id

get id(): string
Returns string
Inherited from LocalTrack.id
- Defined in room/track/LocalTrack.ts:113

isLocal

get isLocal(): boolean
Returns boolean
Inherited from LocalTrack.isLocal
- Defined in room/track/LocalTrack.ts:150

isSimulcast

get isSimulcast(): boolean
Returns boolean
- Defined in room/track/LocalVideoTrack.ts:102

isStopped

get isStopped(): boolean
Returns boolean
Inherited from LocalTrack.isStopped
- Defined in room/track/LocalTrack.ts:142

isUpstreamPaused

get isUpstreamPaused(): boolean
Returns boolean
Inherited from LocalTrack.isUpstreamPaused
- Defined in room/track/LocalTrack.ts:134

isUserProvided

get isUserProvided(): boolean
Returns boolean
Inherited from LocalAudioTrack.isUserProvided
- Defined in room/track/LocalTrack.ts:138

mediaStreamTrack

get mediaStreamTrack(): MediaStreamTrack
Returns MediaStreamTrack
Inherited from LocalTrack.mediaStreamTrack
- Defined in room/track/LocalTrack.ts:146

streamState

get streamState(): StreamState
indicates current state of stream, it'll indicate paused if the track has been paused by congestion controller

Returns StreamState
Inherited from Track.streamState
- Defined in room/track/Track.ts:58

Methods

addSimulcastTrack

addSimulcastTrack(
codec: "vp8" | "h264" | "vp9" | "av1" | "h265",
encodings?: RTCRtpEncodingParameters[],
): SimulcastTrackInfo | undefined
Parameters
- codec: "vp8" | "h264" | "vp9" | "av1" | "h265"
- Optionalencodings: RTCRtpEncodingParameters[]
Returns SimulcastTrackInfo | undefined
- Defined in room/track/LocalVideoTrack.ts:460

attach

attach(): HTMLMediaElement
creates a new HTMLAudioElement or HTMLVideoElement, attaches to it, and returns it

Returns HTMLMediaElement
Inherited from LocalTrack.attach
- Defined in room/track/Track.ts:139
attach(element: HTMLMediaElement): HTMLMediaElement
attaches track to an existing HTMLAudioElement or HTMLVideoElement
Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement
Inherited from LocalTrack.attach
- Defined in room/track/Track.ts:144

detach

detach(): HTMLMediaElement[]
Detaches from all attached elements

Returns HTMLMediaElement[]
Inherited from LocalTrack.detach
- Defined in room/track/Track.ts:221
detach(element: HTMLMediaElement): HTMLMediaElement
Detach from a single element
Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement
Inherited from LocalTrack.detach
- Defined in room/track/Track.ts:227

getDeviceId

getDeviceId(normalize?: boolean): Promise<string | undefined>
Parameters
- normalize: boolean = true
Returns Promise<string | undefined>
DeviceID of the device that is currently being used for this track
Inherited from LocalTrack.getDeviceId
- Defined in room/track/LocalTrack.ts:308

getPreConnectBufferMimeType

getPreConnectBufferMimeType(): string | undefined
Returns string | undefined
Inherited from LocalTrack.getPreConnectBufferMimeType
- Defined in room/track/LocalTrack.ts:766

getProcessor

getProcessor(): TrackProcessor<Video, any> | undefined
Returns the processor currently set on this track, or undefined if there is none. A track that was stopped by an unpublish or a disconnect has none. See TrackProcessor.

Returns TrackProcessor<Video, any> | undefined
Inherited from LocalTrack.getProcessor
- Defined in room/track/LocalTrack.ts:675

getRTCStatsReport

getRTCStatsReport(): Promise<RTCStatsReport | undefined>
Gets the RTCStatsReport for the LocalTrack's underlying RTCRtpSender See https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport

Returns Promise<RTCStatsReport | undefined>
Promise | undefined
Inherited from LocalTrack.getRTCStatsReport
- Defined in room/track/LocalTrack.ts:588

getSenderStats

getSenderStats(): Promise<VideoSenderStats[]>
Returns Promise<VideoSenderStats[]>
- Defined in room/track/LocalVideoTrack.ts:198

mute

mute(): Promise<LocalVideoTrack>
Returns Promise<LocalVideoTrack>
Overrides LocalTrack.mute
- Defined in room/track/LocalVideoTrack.ts:152

pauseUpstream

pauseUpstream(): Promise<void>
pauses publishing to the server without disabling the local MediaStreamTrack this is used to display a user's own video locally while pausing publishing to the server. this API is unsupported on Safari < 12 due to a bug

Returns Promise<void>
Overrides LocalTrack.pauseUpstream
- Defined in room/track/LocalVideoTrack.ts:138

prioritizePerformance

prioritizePerformance(): Promise<void>
Experimental
Designed for lower powered devices, reduces video publishing quality and disables simulcast.

Returns Promise<void>
- Defined in room/track/LocalVideoTrack.ts:591

refreshSubscribedCodecs

refreshSubscribedCodecs(): Promise<
void
| ("vp8" | "h264" | "vp9" | "av1" | "h265")[],
>
Returns Promise<void | ("vp8" | "h264" | "vp9" | "av1" | "h265")[]>

Interal
- Defined in room/track/LocalVideoTrack.ts:497

replaceTrack

replaceTrack(
track: MediaStreamTrack,
options?: ReplaceTrackOptions,
): Promise<LocalVideoTrack>
Parameters
- track: MediaStreamTrack
- Optionaloptions: ReplaceTrackOptions
Returns Promise<LocalVideoTrack>
Inherited from LocalTrack.replaceTrack
- Defined in room/track/LocalTrack.ts:331
replaceTrack(
track: MediaStreamTrack,
userProvidedTrack?: boolean,
): Promise<LocalVideoTrack>
Parameters
- track: MediaStreamTrack
- OptionaluserProvidedTrack: boolean
Returns Promise<LocalVideoTrack>
Inherited from LocalTrack.replaceTrack
- Defined in room/track/LocalTrack.ts:332

restartTrack

restartTrack(options?: VideoCaptureOptions): Promise<void>
Parameters
- Optionaloptions: VideoCaptureOptions
Returns Promise<void>
Overrides LocalTrack.restartTrack
- Defined in room/track/LocalVideoTrack.ts:270

resumeUpstream

resumeUpstream(): Promise<void>
Returns Promise<void>
Overrides LocalTrack.resumeUpstream
- Defined in room/track/LocalVideoTrack.ts:145

setDegradationPreference

setDegradationPreference(preference: RTCDegradationPreference): Promise<void>
Parameters
- preference: RTCDegradationPreference
Returns Promise<void>
- Defined in room/track/LocalVideoTrack.ts:424

setDeviceId

setDeviceId(deviceId: ConstrainDOMString): Promise<boolean>
Parameters
- deviceId: ConstrainDOMString
Returns Promise<boolean>
Inherited from LocalTrack.setDeviceId
- Defined in room/track/LocalTrack.ts:280

setProcessor

setProcessor(
processor: TrackProcessor<Video>,
showProcessedStreamLocally?: boolean,
): Promise<void>
Sets a processor on this track, and wires its processed track into the simulcast codecs.

The processor is destroyed when the track is stopped, which unpublishing and disconnecting both do by default, so it has to be set again after reconnecting. See TrackProcessor for the full lifecycle.
Parameters
- processor: TrackProcessor<Video>
- showProcessedStreamLocally: boolean = true
Returns Promise<void>
Overrides LocalTrack.setProcessor
- Defined in room/track/LocalVideoTrack.ts:411

setPublishingQuality

setPublishingQuality(maxQuality: VideoQuality): void
Parameters
- maxQuality: VideoQuality
Returns void
- Defined in room/track/LocalVideoTrack.ts:256

setSimulcastTrackSender

setSimulcastTrackSender(
codec: "vp8" | "h264" | "vp9" | "av1" | "h265",
sender: RTCRtpSender,
): Promise<void>
Parameters
- codec: "vp8" | "h264" | "vp9" | "av1" | "h265"
- sender: RTCRtpSender
Returns Promise<void>
- Defined in room/track/LocalVideoTrack.ts:478

startMonitor

startMonitor(signalClient: SignalClient): void
Parameters
- signalClient: SignalClient
Returns void
Overrides LocalTrack.startMonitor
- Defined in room/track/LocalVideoTrack.ts:110

stop

stop(): void
Returns void
Overrides LocalTrack.stop
- Defined in room/track/LocalVideoTrack.ts:130

stopMonitor

stopMonitor(): void
Returns void
Inherited from LocalTrack.stopMonitor
- Defined in room/track/Track.ts:283

stopProcessor

stopProcessor(keepElement?: boolean): Promise<void>
Stops the track processor See https://github.com/livekit/track-processors-js for example usage

Only needed to remove a processor from a track that stays published. Unpublishing or disconnecting already destroys it. See TrackProcessor.
Parameters
- keepElement: boolean = true
Returns Promise<void>
Inherited from LocalTrack.stopProcessor
- Defined in room/track/LocalTrack.ts:686

unmute

unmute(): Promise<LocalVideoTrack>
Returns Promise<LocalVideoTrack>
Overrides LocalTrack.unmute
- Defined in room/track/LocalVideoTrack.ts:172

waitForDimensions

waitForDimensions(timeout?: number): Promise<Dimensions>
Parameters
- timeout: number = DEFAULT_DIMENSIONS_TIMEOUT
Returns Promise<Dimensions>
Inherited from LocalTrack.waitForDimensions
- Defined in room/track/LocalTrack.ts:248

Class LocalVideoTrack

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LocalVideoTrack

Properties

attachedElements

isMuted

Readonlykind

OptionallastEncodedDimensions

OptionalpublishOptions

Optionalsid

OptionalsignalClient

simulcastCodecs

source

Accessors

constraints

Returns MediaTrackConstraints

currentBitrate

Returns number

dimensions

Returns Dimensions | undefined

hasPreConnectBuffer

Returns boolean

id

Returns string

isLocal

Returns boolean

isSimulcast

Returns boolean

isStopped

Returns boolean

isUpstreamPaused

Returns boolean

isUserProvided

Returns boolean

mediaStreamTrack

Returns MediaStreamTrack

streamState

Returns StreamState

Methods

addSimulcastTrack

Parameters

Returns SimulcastTrackInfo | undefined

attach

Returns HTMLMediaElement

Parameters

Returns HTMLMediaElement

detach

Returns HTMLMediaElement[]

Parameters

Returns HTMLMediaElement

getDeviceId

Parameters

Returns Promise<string | undefined>

getPreConnectBufferMimeType

Returns string | undefined

getProcessor

Returns TrackProcessor<Video, any> | undefined

getRTCStatsReport

Returns Promise<RTCStatsReport | undefined>

getSenderStats

Returns Promise<VideoSenderStats[]>

mute

Returns Promise<LocalVideoTrack>

pauseUpstream

Returns Promise<void>

prioritizePerformance

Returns Promise<void>

refreshSubscribedCodecs

Returns Promise<void | ("vp8" | "h264" | "vp9" | "av1" | "h265")[]>

Interal

replaceTrack

Parameters

`Readonly`kind

`Optional`lastEncodedDimensions

`Optional`publishOptions

`Optional`sid

`Optional`signalClient