Class RemoteAudioTrack

Hierarchy (View Summary, Expand)

RemoteTrack<Audio>
- RemoteAudioTrack

Index

Constructors

Properties

attachedElements isMuted kind sid? source streamState

Accessors

currentBitrate isLocal mediaStreamTrack

Methods

attach detach getPlayoutDelay getReceiverStats getRTCStatsReport getVolume registerTimeSyncUpdate setPlayoutDelay setSinkId setVolume start startMonitor stop stopMonitor

Constructors

constructor

new RemoteAudioTrack(
    mediaTrack: MediaStreamTrack,
    sid: string,
    receiver: RTCRtpReceiver,
    audioContext?: AudioContext,
    audioOutput?: AudioOutputOptions,
    loggerOptions?: LoggerOptions,
): RemoteAudioTrack
Parameters
- mediaTrack: MediaStreamTrack
- sid: string
- receiver: RTCRtpReceiver
- OptionalaudioContext: AudioContext
- OptionalaudioOutput: AudioOutputOptions
- OptionalloggerOptions: LoggerOptions
Returns RemoteAudioTrack
Overrides RemoteTrack.constructor
- Defined in src/room/track/RemoteAudioTrack.ts:25

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

currentBitrate

get currentBitrate(): number
current receive bits per second

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

isLocal

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

mediaStreamTrack

get mediaStreamTrack(): MediaStreamTrack
Returns MediaStreamTrack
Inherited from RemoteTrack.mediaStreamTrack
- Defined in src/room/track/Track.ts:105

Methods

attach

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

Returns HTMLMediaElement
Overrides RemoteTrack.attach
- Defined in src/room/track/RemoteAudioTrack.ts:96
attach(element: HTMLMediaElement): HTMLMediaElement
attaches track to an existing HTMLAudioElement or HTMLVideoElement
Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement
Overrides RemoteTrack.attach
- Defined in src/room/track/RemoteAudioTrack.ts:97

detach

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

Returns HTMLMediaElement[]
Overrides RemoteTrack.detach
- Defined in src/room/track/RemoteAudioTrack.ts:128
detach(element: HTMLMediaElement): HTMLMediaElement
Detach from a single element
Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement
Overrides RemoteTrack.detach
- Defined in src/room/track/RemoteAudioTrack.ts:134

getPlayoutDelay

getPlayoutDelay(): number
Returns the current playout delay (in seconds) of this track.

Returns number
Inherited from RemoteTrack.getPlayoutDelay
- Defined in src/room/track/RemoteTrack.ts:103

getReceiverStats

getReceiverStats(): Promise<undefined | AudioReceiverStats>
Returns Promise<undefined | AudioReceiverStats>
- Defined in src/room/track/RemoteAudioTrack.ts:236

getRTCStatsReport

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

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

getVolume

getVolume(): number
gets the volume of attached audio elements (loudest)

Returns number
- Defined in src/room/track/RemoteAudioTrack.ts:62

registerTimeSyncUpdate

registerTimeSyncUpdate(): void
Returns void
Inherited from RemoteTrack.registerTimeSyncUpdate
- Defined in src/room/track/RemoteTrack.ts:128

setPlayoutDelay

setPlayoutDelay(delayInSeconds: number): void
Allows to set a playout delay (in seconds) for this track. A higher value allows for more buffering of the track in the browser and will result in a delay of media being played back of delayInSeconds
Parameters
- delayInSeconds: number
Returns void
Inherited from RemoteTrack.setPlayoutDelay
- Defined in src/room/track/RemoteTrack.ts:88

setSinkId

setSinkId(deviceId: string): Promise<void>
calls setSinkId on all attached elements, if supported
Parameters
- deviceId: string
  audio output device
Returns Promise<void>
- Defined in src/room/track/RemoteAudioTrack.ts:83

setVolume

setVolume(volume: number): void
sets the volume for all attached audio elements
Parameters
- volume: number
Returns void
- Defined in src/room/track/RemoteAudioTrack.ts:44

start

start(): void
Returns void
Inherited from RemoteTrack.start
- Defined in src/room/track/RemoteTrack.ts:57

startMonitor

startMonitor(): void
Returns void
Inherited from RemoteTrack.startMonitor
- Defined in src/room/track/RemoteTrack.ts:117

stop

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

stopMonitor

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