Class Track

Hierarchy

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

Index

Properties

Accessors

Methods

Properties

attachedElements

attachedElements: HTMLMediaElement[] = []

isMuted

isMuted: boolean = false

kind

kind: Kind

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

Accessors

currentBitrate

get currentBitrate(): number

- Defined in room/track/Track.ts:60
current receive bits per second

Returns number

mediaStreamTrack

get mediaStreamTrack(): MediaStreamTrack

- Defined in room/track/Track.ts:64
Returns MediaStreamTrack

Methods

attach

attach(): HTMLMediaElement
attach(element: HTMLMediaElement): HTMLMediaElement

- Defined in room/track/Track.ts:71
creates a new HTMLAudioElement or HTMLVideoElement, attaches to it, and returns it

Returns HTMLMediaElement
- Defined in room/track/Track.ts:76
attaches track to an existing HTMLAudioElement or HTMLVideoElement

Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement

detach

detach(): HTMLMediaElement[]
detach(element: HTMLMediaElement): HTMLMediaElement

- Defined in room/track/Track.ts:127
Detaches from all attached elements

Returns HTMLMediaElement[]
- Defined in room/track/Track.ts:133
Detach from a single element

Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement

stop

stop(): void

- Defined in room/track/Track.ts:160
Returns void

Generated using TypeDoc