Class LocalTrack<TrackKind>`Abstract`

Type Parameters

TrackKind extends Kind = Kind

Hierarchy (view full)

Track<TrackKind>
- LocalTrack
  - LocalAudioTrack
  - LocalVideoTrack

Properties

attachedElements

attachedElements: HTMLMediaElement[] = []

isMuted

isMuted: boolean = false

`Readonly`kind

kind: TrackKind

`Optional`sid

sid?: string

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

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
- Defined in src/room/track/LocalTrack.ts:34

currentBitrate

get currentBitrate(): number
current receive bits per second

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

dimensions

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

id

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

isUpstreamPaused

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

isUserProvided

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

mediaStreamTrack

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

Methods

attach

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

Returns HTMLMediaElement
Inherited from Track.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 Track.attach
- Defined in src/room/track/Track.ts:126

detach

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

Returns HTMLMediaElement[]
Inherited from Track.detach
- Defined in src/room/track/Track.ts:203
detach(element): HTMLMediaElement
Detach from a single element
Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement
Inherited from Track.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
- Defined in src/room/track/LocalTrack.ts:227

getProcessor

getProcessor(): undefined | TrackProcessor<TrackKind, any>
Returns undefined | TrackProcessor<TrackKind, any>
- 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
- Defined in src/room/track/LocalTrack.ts:459

mute

mute(): Promise<LocalTrack<TrackKind>>
Returns Promise<LocalTrack<TrackKind>>
- Defined in src/room/track/LocalTrack.ts:240

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>
- Defined in src/room/track/LocalTrack.ts:409

replaceTrack

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

resumeUpstream

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

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<TrackKind, ProcessorOptions<TrackKind>>
- showProcessedStreamLocally: boolean = true
Returns Promise<void>
- Defined in src/room/track/LocalTrack.ts:477

`Abstract`startMonitor

startMonitor(signalClient?): void
Parameters
- OptionalsignalClient: SignalClient
Returns void
Inherited from Track.startMonitor
- Defined in src/room/track/Track.ts:256

stop

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

stopMonitor

stopMonitor(): void
Returns void
Inherited from Track.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>
- Defined in src/room/track/LocalTrack.ts:537

unmute

unmute(): Promise<LocalTrack<TrackKind>>
Returns Promise<LocalTrack<TrackKind>>
- Defined in src/room/track/LocalTrack.ts:245

waitForDimensions

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