Class LocalAudioTrack

Hierarchy (View Summary, Expand)

LocalTrack<Audio>
- LocalAudioTrack

Constructors

constructor

new LocalAudioTrack(
    mediaTrack: MediaStreamTrack,
    constraints?: MediaTrackConstraints,
    userProvidedTrack?: boolean,
    audioContext?: AudioContext,
    loggerOptions?: LoggerOptions,
): LocalAudioTrack
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
- OptionalaudioContext: AudioContext
- OptionalloggerOptions: LoggerOptions
Returns LocalAudioTrack
Overrides LocalTrack<Track.Kind.Audio>.constructor
- Defined in src/room/track/LocalAudioTrack.ts:36

Properties

attachedElements

attachedElements: HTMLMediaElement[] = []

isMuted

isMuted: boolean = false

`Readonly`kind

kind: Audio

`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
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

enhancedNoiseCancellation

get enhancedNoiseCancellation(): boolean
boolean indicating whether enhanced noise cancellation is currently being used on this track

Returns boolean
- Defined in src/room/track/LocalAudioTrack.ts:26

id

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

isLocal

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

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

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

checkForSilence

checkForSilence(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/room/track/LocalAudioTrack.ts:243

detach

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

Returns HTMLMediaElement[]
Inherited from LocalTrack.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 LocalTrack.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
Inherited from LocalTrack.getDeviceId
- Defined in src/room/track/LocalTrack.ts:254

getProcessor

getProcessor(): undefined | TrackProcessor<Audio, any>
Returns undefined | TrackProcessor<Audio, any>
Inherited from LocalTrack.getProcessor
- 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
Inherited from LocalTrack.getRTCStatsReport
- Defined in src/room/track/LocalTrack.ts:492

getSenderStats

getSenderStats(): Promise<undefined | AudioSenderStats>
Returns Promise<undefined | AudioSenderStats>
- Defined in src/room/track/LocalAudioTrack.ts:218

mute

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

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>
Inherited from LocalTrack.pauseUpstream
- Defined in src/room/track/LocalTrack.ts:438

replaceTrack

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

restartTrack

restartTrack(options?: AudioCaptureOptions): Promise<void>
Parameters
- Optionaloptions: AudioCaptureOptions
Returns Promise<void>
Overrides LocalTrack.restartTrack
- Defined in src/room/track/LocalAudioTrack.ts:98

resumeUpstream

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

setDeviceId

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

setProcessor

setProcessor(
processor: TrackProcessor<Audio, AudioProcessorOptions>,
): Promise<void>
Experimental
Sets a processor on this track. See https://github.com/livekit/track-processors-js for example usage
Parameters
- processor: TrackProcessor<Audio, AudioProcessorOptions>
Returns Promise<void>
Overrides LocalTrack.setProcessor
- Defined in src/room/track/LocalAudioTrack.ts:171

startMonitor

startMonitor(): void
Returns void
Overrides LocalTrack.startMonitor
- Defined in src/room/track/LocalAudioTrack.ts:116

stop

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

stopMonitor

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

unmute

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

waitForDimensions

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

Class LocalAudioTrack

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LocalAudioTrack

Properties

attachedElements

isMuted

Readonlykind

Optionalsid

source

streamState

Accessors

constraints

Returns MediaTrackConstraints

currentBitrate

Returns number

dimensions

Returns undefined | Dimensions

enhancedNoiseCancellation

Returns boolean

id

Returns string

isLocal

Returns boolean

isUpstreamPaused

Returns boolean

isUserProvided

Returns boolean

mediaStreamTrack

Returns MediaStreamTrack

Methods

attach

Returns HTMLMediaElement

Parameters

Returns HTMLMediaElement

checkForSilence

Returns Promise<boolean>

detach

Returns HTMLMediaElement[]

Parameters

Returns HTMLMediaElement

getDeviceId

Parameters

Returns Promise<undefined | string>

getProcessor

Returns undefined | TrackProcessor<Audio, any>

getRTCStatsReport

Returns Promise<undefined | RTCStatsReport>

getSenderStats

Returns Promise<undefined | AudioSenderStats>

mute

Returns Promise<LocalAudioTrack>

pauseUpstream

Returns Promise<void>

replaceTrack

Parameters

Returns Promise<LocalAudioTrack>

Parameters

Returns Promise<LocalAudioTrack>

restartTrack

Parameters

Returns Promise<void>

resumeUpstream

Returns Promise<void>

setDeviceId

Parameters

Returns Promise<boolean>

setProcessor

Parameters

Returns Promise<void>

startMonitor

Returns void

stop

`Readonly`kind

`Optional`sid