Class LocalVideoTrack

Hierarchy (view full)

LocalTrack<Video>
- LocalVideoTrack

Constructors

constructor

new LocalVideoTrack(mediaTrack, constraints?, userProvidedTrack?, 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 src/room/track/LocalVideoTrack.ts:76

Properties

attachedElements

attachedElements: HTMLMediaElement[] = []

isMuted

isMuted: boolean = false

`Readonly`kind

kind: Video

`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", SimulcastTrackInfo> = ...

source

source: Source

streamState

streamState: StreamState = Track.StreamState.Active

indicates current state of stream, it'll indicate paused if the track has been paused by congestion controller

Accessors

constraints

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

currentBitrate

get currentBitrate(): number
current receive bits per second

Returns number
Inherited from LocalTrack.currentBitrate
- Defined in src/room/track/Track.ts:101

dimensions

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

id

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

isSimulcast

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

isUpstreamPaused

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

isUserProvided

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

mediaStreamTrack

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

Methods

addSimulcastTrack

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

attach

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

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

detach

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

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

getDeviceId

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

getProcessor

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

getRTCStatsReport

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

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

getSenderStats

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

mute

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

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 src/room/track/LocalVideoTrack.ts:122

replaceTrack

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

restartTrack

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

resumeUpstream

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

setDegradationPreference

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

setDeviceId

setDeviceId(deviceId): Promise<boolean>
Parameters
- deviceId: ConstrainDOMString
Returns Promise<boolean>
- Defined in src/room/track/LocalVideoTrack.ts:244

setProcessor

setProcessor(processor, showProcessedStreamLocally?): Promise<void>
Experimental
Sets a processor on this track. See https://github.com/livekit/track-processors-js for example usage
Parameters
- processor: TrackProcessor<Video, ProcessorOptions<Video>>
- showProcessedStreamLocally: boolean = true
Returns Promise<void>
Overrides LocalTrack.setProcessor
- Defined in src/room/track/LocalVideoTrack.ts:280

setPublishingQuality

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

setSimulcastTrackSender

setSimulcastTrackSender(codec, sender): void
Parameters
- codec:
      | "vp8"
      | "h264"
      | "vp9"
      | "av1"
- sender: RTCRtpSender
Returns void
- Defined in src/room/track/LocalVideoTrack.ts:325

startMonitor

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

stop

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

stopMonitor

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

stopProcessor

stopProcessor(keepElement?): Promise<void>
Experimental
Stops the track processor See https://github.com/livekit/track-processors-js for example usage
Parameters
- keepElement: boolean = true
Returns Promise<void>
Inherited from LocalTrack.stopProcessor
- Defined in src/room/track/LocalTrack.ts:537

unmute

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

waitForDimensions

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

Class LocalVideoTrack

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LocalVideoTrack

Properties

attachedElements

isMuted

Readonlykind

Optionalsid

OptionalsignalClient

simulcastCodecs

source

streamState

Accessors

constraints

Returns MediaTrackConstraints

currentBitrate

Returns number

dimensions

Returns undefined | Dimensions

id

Returns string

isSimulcast

Returns boolean

isUpstreamPaused

Returns boolean

isUserProvided

Returns boolean

mediaStreamTrack

Returns MediaStreamTrack

Methods

addSimulcastTrack

Parameters

Returns undefined | SimulcastTrackInfo

attach

Returns HTMLMediaElement

Parameters

Returns HTMLMediaElement

detach

Returns HTMLMediaElement[]

Parameters

Returns HTMLMediaElement

getDeviceId

Parameters

Returns Promise<undefined | string>

getProcessor

Returns undefined | TrackProcessor<Video, any>

getRTCStatsReport

Returns Promise<undefined | RTCStatsReport>

getSenderStats

Returns Promise<VideoSenderStats[]>

mute

Returns Promise<LocalVideoTrack>

pauseUpstream

Returns Promise<void>

replaceTrack

Parameters

Returns Promise<LocalVideoTrack>

Parameters

Returns Promise<LocalVideoTrack>

restartTrack

Parameters

Returns Promise<void>

resumeUpstream

Returns Promise<void>

setDegradationPreference

Parameters

Returns Promise<void>

setDeviceId

Parameters

Returns Promise<boolean>

setProcessor

Parameters

`Readonly`kind

`Optional`sid

`Optional`signalClient