Chartbreaker
    Preparing search index...

    Interface MediaStream

    The MediaStream interface of the Media Capture and Streams API represents a stream of media content.

    MDN Reference

    interface MediaStream {
        active: boolean;
        id: string;
        onaddtrack: null | ((this: MediaStream, ev: MediaStreamTrackEvent) => any);
        onremovetrack:
            | null
            | ((this: MediaStream, ev: MediaStreamTrackEvent) => any);
        addEventListener<K extends keyof MediaStreamEventMap>(
            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): null | MediaStreamTrack;
        getTracks(): MediaStreamTrack[];
        getVideoTracks(): MediaStreamTrack[];
        removeEventListener<K extends keyof MediaStreamEventMap>(
            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

    • EventTarget
      • MediaStream
    Index

    Properties

    active: boolean

    The active read-only property of the true if the stream is currently active; otherwise, it returns false.

    MDN Reference

    id: string

    The id read-only property of the MediaStream interface is a string containing 36 characters denoting a unique identifier (GUID) for the object.

    MDN Reference

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

    Methods

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The getTrackById() method of the MediaStream interface returns a MediaStreamTrack object representing the track with the specified ID string.

      MDN Reference

      Parameters

      • trackId: string

      Returns null | MediaStreamTrack

    • The removeTrack() method of the MediaStream interface removes a js-nolint removeTrack(track) - track - : A MediaStreamTrack that will be removed from the stream.

      MDN Reference

      Parameters

      Returns void