Interface TrackContext

Hierarchy

TrackContextFields
TypedEventEmitter<Required<TrackContextEvents>>
- TrackContext

Properties

`Optional` `Readonly` encoding

encoding?: TrackEncoding

Encoding that is currently received. Only present for remote tracks.

`Optional` `Readonly` encodingReason

encodingReason?: EncodingReason

The reason of currently selected encoding. Only present for remote tracks.

`Readonly` endpoint

endpoint: Endpoint

Endpoint this track comes from.

`Optional` `Readonly` maxBandwidth

maxBandwidth?: TrackBandwidthLimit

`Readonly` metadata

metadata: any

Any info that was passed in addTrack.

`Optional` `Readonly` simulcastConfig

simulcastConfig?: SimulcastConfig

Simulcast configuration. Only present for local tracks.

`Readonly` stream

stream: null | MediaStream

Stream this track belongs to.

`Readonly` track

track: null | MediaStreamTrack

`Readonly` trackId

trackId: string

Track id. It is generated by RTC engine and takes form endpoint_id:<random_uuidv4>. It is WebRTC agnostic i.e. it does not contain mid or stream id.

`Readonly` vadStatus

vadStatus: VadStatus

Methods

addListener

addListener<E>(event: E, listener: Required<TrackContextEvents>[E]): TrackContext
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
- listener: Required<TrackContextEvents>[E]
Returns TrackContext
Inherited from TypedEmitter.addListener
- Defined in node_modules/typed-emitter/index.d.ts:22

emit

emit<E>(event: E, ...args: Parameters<Required<TrackContextEvents>[E]>): boolean
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
- Rest ...args: Parameters<Required<TrackContextEvents>[E]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/typed-emitter/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/typed-emitter/index.d.ts:34

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:39

listenerCount

listenerCount<E>(event: E): number
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:37

listeners

listeners<E>(event: E): Required<TrackContextEvents>[E][]
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
Returns Required<TrackContextEvents>[E][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/typed-emitter/index.d.ts:36

off

off<E>(event: E, listener: Required<TrackContextEvents>[E]): TrackContext
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
- listener: Required<TrackContextEvents>[E]
Returns TrackContext
Inherited from TypedEmitter.off
- Defined in node_modules/typed-emitter/index.d.ts:28

on

on<E>(event: E, listener: Required<TrackContextEvents>[E]): TrackContext
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
- listener: Required<TrackContextEvents>[E]
Returns TrackContext
Inherited from TypedEmitter.on
- Defined in node_modules/typed-emitter/index.d.ts:23

once

once<E>(event: E, listener: Required<TrackContextEvents>[E]): TrackContext
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
- listener: Required<TrackContextEvents>[E]
Returns TrackContext
Inherited from TypedEmitter.once
- Defined in node_modules/typed-emitter/index.d.ts:24

prependListener

prependListener<E>(event: E, listener: Required<TrackContextEvents>[E]): TrackContext
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
- listener: Required<TrackContextEvents>[E]
Returns TrackContext
Inherited from TypedEmitter.prependListener
- Defined in node_modules/typed-emitter/index.d.ts:25

prependOnceListener

prependOnceListener<E>(event: E, listener: Required<TrackContextEvents>[E]): TrackContext
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
- listener: Required<TrackContextEvents>[E]
Returns TrackContext
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:26

rawListeners

rawListeners<E>(event: E): Required<TrackContextEvents>[E][]
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
Returns Required<TrackContextEvents>[E][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:35

removeAllListeners

removeAllListeners<E>(event?: E): TrackContext
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- Optional event: E
Returns TrackContext
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:29

removeListener

removeListener<E>(event: E, listener: Required<TrackContextEvents>[E]): TrackContext
Type Parameters
- E extends keyof TrackContextEvents
Parameters
- event: E
- listener: Required<TrackContextEvents>[E]
Returns TrackContext
Inherited from TypedEmitter.removeListener
- Defined in node_modules/typed-emitter/index.d.ts:30

setMaxListeners

setMaxListeners(maxListeners: number): TrackContext
Parameters
- maxListeners: number
Returns TrackContext
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40

Interface TrackContext

Hierarchy

Index

Properties

Methods

Properties

Optional Readonly encoding

Optional Readonly encodingReason

Readonly endpoint

Optional Readonly maxBandwidth

Readonly metadata

Optional Readonly simulcastConfig

Readonly stream

Readonly track

Readonly trackId

Readonly vadStatus

Methods

addListener

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

listener: Required<TrackContextEvents>[E]

Returns TrackContext

emit

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

Rest ...args: Parameters<Required<TrackContextEvents>[E]>

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

Returns number

listeners

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

Returns Required<TrackContextEvents>[E][]

off

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

listener: Required<TrackContextEvents>[E]

Returns TrackContext

on

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

listener: Required<TrackContextEvents>[E]

Returns TrackContext

once

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

listener: Required<TrackContextEvents>[E]

Returns TrackContext

prependListener

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

listener: Required<TrackContextEvents>[E]

Returns TrackContext

prependOnceListener

Type Parameters

E extends keyof TrackContextEvents

Parameters

event: E

`Optional` `Readonly` encoding

`Optional` `Readonly` encodingReason

`Readonly` endpoint

`Optional` `Readonly` maxBandwidth

`Readonly` metadata

`Optional` `Readonly` simulcastConfig

`Readonly` stream

`Readonly` track

`Readonly` trackId

`Readonly` vadStatus

`Rest` ...args: Parameters<Required<TrackContextEvents>[E]>

`Optional` event: E