Interface MediaStream

    A stream of media content. A stream consists of several tracks such as video or audio tracks. Each track is specified as an instance of MediaStreamTrack.

    MDN Reference

    interface MediaStream {
        active: boolean;
        id: string;
        onaddtrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any);
        onremovetrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any);
        addEventListener<K>(type: K, listener: ((this: MediaStream, ev: MediaStreamEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void;
        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
        addTrack(track: MediaStreamTrack): void;
        clone(): MediaStream;
        dispatchEvent(event: Event): boolean;
        getAudioTracks(): MediaStreamTrack[];
        getTrackById(trackId: string): MediaStreamTrack;
        getTracks(): MediaStreamTrack[];
        getVideoTracks(): MediaStreamTrack[];
        removeEventListener<K>(type: K, listener: ((this: MediaStream, ev: MediaStreamEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
        removeTrack(track: MediaStreamTrack): void;
    }
    Hierarchy

    Properties

    active id onaddtrack onremovetrack

    Methods

    addEventListener addTrack clone dispatchEvent getAudioTracks getTrackById getTracks getVideoTracks removeEventListener removeTrack

    Properties

    Readonlyactive

    active: boolean

    MDN Reference

    Readonlyid

    id: string

    MDN Reference

    onaddtrack

    onaddtrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any)

    MDN Reference

    onremovetrack

    onremovetrack: ((this: MediaStream, ev: MediaStreamTrackEvent) => any)

    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

    addTrack

    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

      Returns boolean

    getAudioTracks

    getTrackById

    getTracks

    getVideoTracks

    removeEventListener

    removeTrack

    Settings

    Member Visibility

    On This Page

    Properties
    Methods