Class LocalTrack<TrackKind>`Abstract`

Type Parameters

TrackKind extends Kind = Kind

Hierarchy (View Summary)

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

isLocal

get isLocal(): boolean
Returns boolean
Overrides Track.isLocal
- Defined in src/room/track/LocalTrack.ts:123

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:123
attach(element: HTMLMediaElement): 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:128

detach

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

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

getDeviceId

getDeviceId(normalize?: boolean): 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:254

getProcessor

getProcessor(): undefined | TrackProcessor<TrackKind, any>
Returns undefined | TrackProcessor<TrackKind, any>
- Defined in src/room/track/LocalTrack.ts:559

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:492

mute

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

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:438

replaceTrack

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

`Abstract`restartTrack

restartTrack(constraints?: unknown): Promise<void>
Parameters
- Optionalconstraints: unknown
Returns Promise<void>
- Defined in src/room/track/LocalTrack.ts:249

resumeUpstream

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

setDeviceId

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

setProcessor

setProcessor(
processor: TrackProcessor<TrackKind, ProcessorOptions<TrackKind>>,
showProcessedStreamLocally?: boolean,
): 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:510

`Abstract`startMonitor

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

stop

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

stopMonitor

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

stopProcessor

stopProcessor(keepElement?: boolean): 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:570

unmute

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

waitForDimensions

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

Class LocalTrack<TrackKind>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

attachedElements

isMuted

Readonlykind

Optionalsid

source

streamState

Accessors

constraints

Returns MediaTrackConstraints

currentBitrate

Returns number

dimensions

Returns undefined | Dimensions

id

Returns string

isLocal

Returns boolean

isUpstreamPaused

Returns boolean

isUserProvided

Returns boolean

mediaStreamTrack

Returns MediaStreamTrack

Methods

attach

Returns HTMLMediaElement

Parameters

Returns HTMLMediaElement

detach

Returns HTMLMediaElement[]

Parameters

Returns HTMLMediaElement

getDeviceId

Parameters

Returns Promise<undefined | string>

getProcessor

Returns undefined | TrackProcessor<TrackKind, any>

getRTCStatsReport

Returns Promise<undefined | RTCStatsReport>

mute

Returns Promise<LocalTrack<TrackKind>>

pauseUpstream

Returns Promise<void>

replaceTrack

Parameters

Returns Promise<LocalTrack<TrackKind>>

Parameters

Returns Promise<LocalTrack<TrackKind>>

AbstractrestartTrack

Parameters

Returns Promise<void>

resumeUpstream

Returns Promise<void>

setDeviceId

Parameters

Returns Promise<boolean>

setProcessor

Parameters

Returns Promise<void>

AbstractstartMonitor

Parameters

Returns void

stop

Returns void

stopMonitor

Returns void

stopProcessor

Parameters

Returns Promise<void>

unmute

Returns Promise<LocalTrack<TrackKind>>

waitForDimensions

Class LocalTrack<TrackKind>`Abstract`

`Readonly`kind

`Optional`sid

`Abstract`restartTrack

`Abstract`startMonitor