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.

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

Hierarchy

  • EventTarget
    • MediaStream

Properties

active id onaddtrack onremovetrack

Methods

addEventListener addTrack clone dispatchEvent getAudioTracks getTrackById getTracks getVideoTracks removeEventListener removeTrack

Properties

Readonly active

active: boolean

Readonly id

id: string

onaddtrack

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

Type declaration

onremovetrack

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

Type declaration

Methods

addEventListener

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

  • Type Parameters

    Parameters

    Returns void

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

  • Parameters

    Returns void

addTrack

  • addTrack(track): void

  • Parameters

    Returns void

clone

  • clone(): MediaStream

  • Returns MediaStream

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.

    Parameters

    • event: Event

    Returns boolean

getAudioTracks

getTrackById

  • getTrackById(trackId): MediaStreamTrack

  • Parameters

    • trackId: string

    Returns MediaStreamTrack

getTracks

getVideoTracks

removeEventListener

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

  • Type Parameters

    Parameters

    Returns void

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

  • Parameters

    Returns void

removeTrack

  • removeTrack(track): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc