Class RemoteTrack<TrackKind>`Abstract`

Type Parameters

TrackKind extends Kind = Kind

Hierarchy (view full)

Track<TrackKind>
- RemoteTrack
  - RemoteAudioTrack
  - RemoteVideoTrack

Index

Constructors

Properties

attachedElements isMuted kind sid? source streamState

Accessors

currentBitrate mediaStreamTrack

Methods

attach detach getPlayoutDelay getRTCStatsReport registerTimeSyncUpdate setPlayoutDelay start startMonitor stop stopMonitor

Constructors

constructor

new RemoteTrack<TrackKind>(mediaTrack, sid, kind, receiver, loggerOptions?): RemoteTrack<TrackKind>
Type Parameters
- TrackKind extends Kind = Kind
Parameters
- mediaTrack: MediaStreamTrack
- sid: string
- kind: TrackKind
- receiver: RTCRtpReceiver
- OptionalloggerOptions: LoggerOptions
Returns RemoteTrack<TrackKind>
Overrides Track<TrackKind>.constructor
- Defined in src/room/track/RemoteTrack.ts:13

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

currentBitrate

get currentBitrate(): number
current receive bits per second

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

mediaStreamTrack

get mediaStreamTrack(): MediaStreamTrack
Returns MediaStreamTrack
Inherited from Track.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
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

getPlayoutDelay

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

Returns number
- Defined in src/room/track/RemoteTrack.ts:99

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

registerTimeSyncUpdate

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

setPlayoutDelay

setPlayoutDelay(delayInSeconds): 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
- Defined in src/room/track/RemoteTrack.ts:84

start

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

startMonitor

startMonitor(): void
Returns void
Overrides Track.startMonitor
- Defined in src/room/track/RemoteTrack.ts:113

stop

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

stopMonitor

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