Interface MediaStreamTrack

A single media track within a stream; typically, these are audio or video tracks, but other track types may exist as well.

MDN Reference

interface MediaStreamTrack {
    contentHint: string;
    enabled: boolean;
    id: string;
    kind: string;
    label: string;
    muted: boolean;
    onended: null | ((this: MediaStreamTrack, ev: Event) => any);
    onmute: null | ((this: MediaStreamTrack, ev: Event) => any);
    onunmute: null | ((this: MediaStreamTrack, ev: Event) => any);
    readyState: MediaStreamTrackState;
    addEventListener<K>(type: K, listener: ((this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void;
    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
    applyConstraints(constraints?: MediaTrackConstraints): Promise<void>;
    clone(): MediaStreamTrack;
    dispatchEvent(event: Event): boolean;
    getCapabilities(): MediaTrackCapabilities;
    getConstraints(): MediaTrackConstraints;
    getSettings(): MediaTrackSettings;
    removeEventListener<K>(type: K, listener: ((this: MediaStreamTrack, ev: MediaStreamTrackEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
    stop(): void;
}

Hierarchy

  • EventTarget
    • MediaStreamTrack

Properties

contentHint enabled id kind label muted onended onmute onunmute readyState

Methods

addEventListener applyConstraints clone dispatchEvent getCapabilities getConstraints getSettings removeEventListener stop

Properties

contentHint

contentHint: string

MDN Reference

enabled

enabled: boolean

MDN Reference

Readonlyid

id: string

MDN Reference

Readonlykind

kind: string

MDN Reference

Readonlylabel

label: string

MDN Reference

Readonlymuted

muted: boolean

MDN Reference

onended

onended: null | ((this: MediaStreamTrack, ev: Event) => any)

MDN Reference

onmute

onmute: null | ((this: MediaStreamTrack, ev: Event) => any)

MDN Reference

onunmute

onunmute: null | ((this: MediaStreamTrack, ev: Event) => any)

MDN Reference

ReadonlyreadyState

readyState: MediaStreamTrackState

MDN Reference

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Type Parameters

    Parameters

    Returns void

  • addEventListener(type, listener, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Parameters

    Returns void

applyConstraints

  • applyConstraints(constraints?): Promise<void>

  • MDN Reference

    Parameters

    Returns Promise<void>

clone

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

getCapabilities

getConstraints

getSettings

removeEventListener

stop

  • stop(): void

  • MDN Reference

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods