Interface TrackContext<EndpointMetadata, TrackMetadata>

interface TrackContext<EndpointMetadata, TrackMetadata> {
    encoding?: TrackEncoding;
    encodingReason?: EncodingReason;
    endpoint: Endpoint<EndpointMetadata, TrackMetadata>;
    maxBandwidth?: TrackBandwidthLimit;
    metadata?: TrackMetadata;
    metadataParsingError?: any;
    rawMetadata: any;
    simulcastConfig?: SimulcastConfig;
    stream: null | MediaStream;
    track: null | MediaStreamTrack;
    trackId: string;
    vadStatus: VadStatus;
    addListener<E>(event, listener): this;
    emit<E>(event, ...args): boolean;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    listenerCount<E>(event): number;
    listeners<E>(event): Required<TrackContextEvents<EndpointMetadata, TrackMetadata>>[E][];
    off<E>(event, listener): this;
    on<E>(event, listener): this;
    once<E>(event, listener): this;
    prependListener<E>(event, listener): this;
    prependOnceListener<E>(event, listener): this;
    rawListeners<E>(event): Required<TrackContextEvents<EndpointMetadata, TrackMetadata>>[E][];
    removeAllListeners<E>(event?): this;
    removeListener<E>(event, listener): this;
    setMaxListeners(maxListeners): this;
}

Type Parameters

  • EndpointMetadata
  • TrackMetadata

Hierarchy

Properties

encoding? encodingReason? endpoint maxBandwidth? metadata? metadataParsingError? rawMetadata simulcastConfig? stream track trackId vadStatus

Methods

addListener emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners

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<EndpointMetadata, TrackMetadata>

Endpoint this track comes from.

Optional Readonly maxBandwidth

maxBandwidth?: TrackBandwidthLimit

Optional Readonly metadata

metadata?: TrackMetadata

Any info that was passed in WebRTCEndpoint.addTrack.

Optional Readonly metadataParsingError

metadataParsingError?: any

Readonly rawMetadata

rawMetadata: any

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

emit

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

listeners

off

on

once

prependListener

prependOnceListener

rawListeners

removeAllListeners

  • removeAllListeners<E>(event?): this

  • Type Parameters

    Parameters

    • Optional event: E

    Returns this

removeListener

setMaxListeners

  • setMaxListeners(maxListeners): this

  • Parameters

    • maxListeners: number

    Returns this

Settings

Member Visibility

Theme

On This Page

encodingencodingReasonendpointmaxBandwidthmetadatametadataParsingErrorrawMetadatasimulcastConfigstreamtracktrackIdvadStatusaddListeneremiteventNamesgetMaxListenerslistenerCountlistenersoffononceprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersetMaxListeners