Interface TrackContext

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

Hierarchy

  • TrackContextFields
  • TypedEventEmitter<Required<TrackContextEvents>>
    • TrackContext

Properties

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

Methods

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

Properties

Optional Readonlyencoding

encoding?: Variant

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

Optional ReadonlyencodingReason

encodingReason?: EncodingReason

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

Readonlyendpoint

endpoint: Endpoint

Endpoint this track comes from.

Optional ReadonlymaxBandwidth

maxBandwidth?: TrackBandwidthLimit

Optional Readonlymetadata

metadata?: unknown

Any info that was passed in WebRTCEndpoint.addTrack.

Optional ReadonlysimulcastConfig

simulcastConfig?: SimulcastConfig

Simulcast configuration. Only present for local tracks.

Readonlystream

stream: null | MediaStream

Stream this track belongs to.

Readonlytrack

track: null | MediaStreamTrack

ReadonlytrackId

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.

ReadonlyvadStatus

vadStatus: VadStatus

Methods

addListener

  • addListener<E extends keyof TrackContextEvents>(
        event: E,
        listener: Required<TrackContextEvents>[E],
    ): this

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E
    • listener: Required<TrackContextEvents>[E]

    Returns this

emit

  • emit<E extends keyof TrackContextEvents>(
        event: E,
        ...args: Parameters<Required<TrackContextEvents>[E]>,
    ): boolean

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E
    • ...args: Parameters<Required<TrackContextEvents>[E]>

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount<E extends keyof TrackContextEvents>(event: E): number

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E

    Returns number

listeners

  • listeners<E extends keyof TrackContextEvents>(
        event: E,
    ): Required<TrackContextEvents>[E][]

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E

    Returns Required<TrackContextEvents>[E][]

off

  • off<E extends keyof TrackContextEvents>(
        event: E,
        listener: Required<TrackContextEvents>[E],
    ): this

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E
    • listener: Required<TrackContextEvents>[E]

    Returns this

on

  • on<E extends keyof TrackContextEvents>(
        event: E,
        listener: Required<TrackContextEvents>[E],
    ): this

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E
    • listener: Required<TrackContextEvents>[E]

    Returns this

once

  • once<E extends keyof TrackContextEvents>(
        event: E,
        listener: Required<TrackContextEvents>[E],
    ): this

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E
    • listener: Required<TrackContextEvents>[E]

    Returns this

prependListener

  • prependListener<E extends keyof TrackContextEvents>(
        event: E,
        listener: Required<TrackContextEvents>[E],
    ): this

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E
    • listener: Required<TrackContextEvents>[E]

    Returns this

prependOnceListener

  • prependOnceListener<E extends keyof TrackContextEvents>(
        event: E,
        listener: Required<TrackContextEvents>[E],
    ): this

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E
    • listener: Required<TrackContextEvents>[E]

    Returns this

rawListeners

  • rawListeners<E extends keyof TrackContextEvents>(
        event: E,
    ): Required<TrackContextEvents>[E][]

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E

    Returns Required<TrackContextEvents>[E][]

removeAllListeners

  • removeAllListeners<E extends keyof TrackContextEvents>(event?: E): this

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • Optionalevent: E

    Returns this

removeListener

  • removeListener<E extends keyof TrackContextEvents>(
        event: E,
        listener: Required<TrackContextEvents>[E],
    ): this

  • Type Parameters

    • E extends keyof TrackContextEvents

    Parameters

    • event: E
    • listener: Required<TrackContextEvents>[E]

    Returns this

setMaxListeners

  • setMaxListeners(maxListeners: number): this

  • Parameters

    • maxListeners: number

    Returns this

Settings

Member Visibility

On This Page

Properties
Methods