Fishjam Web SDK - v0.18.0
    Preparing search index...

    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

    Index

    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

    encoding?: Variant

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

    encodingReason?: EncodingReason

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

    endpoint: Endpoint

    Endpoint this track comes from.

    maxBandwidth?: TrackBandwidthLimit
    metadata?: unknown

    Any info that was passed in WebRTCEndpoint.addTrack.

    simulcastConfig?: SimulcastConfig

    Simulcast configuration. Only present for local tracks.

    stream: null | MediaStream

    Stream this track belongs to.

    track: null | MediaStreamTrack
    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.

    vadStatus: VadStatus

    Methods

    • Returns (string | symbol)[]

    • Returns number

    • Type Parameters

      Parameters

      • event: E

      Returns number

    • Type Parameters

      Parameters

      • Optionalevent: E

      Returns this

    • Parameters

      • maxListeners: number

      Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods