Class Track<TrackKind>`Abstract`

Type Parameters

TrackKind extends Kind = Kind

Hierarchy (View Summary)

TypedEventEmitter<TrackEventCallbacks, this>
- Track
  - LocalTrack
  - RemoteTrack

Index

Properties

attachedElements isMuted kind sid? source streamState

Accessors

currentBitrate isLocal mediaStreamTrack

Methods

attach detach startMonitor stop stopMonitor

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

`Abstract`isLocal

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

mediaStreamTrack

get mediaStreamTrack(): MediaStreamTrack
Returns 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
- 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
- Defined in src/room/track/Track.ts:128

detach

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

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

`Abstract`startMonitor

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

stop

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

stopMonitor

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