Chartbreaker
    Preparing search index...

    Interface MediaStreamTrack

    The MediaStreamTrack interface of the Media Capture and Streams API represents 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 extends keyof MediaStreamTrackEventMap>(
            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 extends keyof MediaStreamTrackEventMap>(
            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
    Index

    Properties

    contentHint enabled id kind label muted onended onmute onunmute readyState

    Methods

    addEventListener applyConstraints clone dispatchEvent getCapabilities getConstraints getSettings removeEventListener stop

    Properties

    contentHint: string

    The contentHint property of the MediaStreamTrack interface is a string that hints at the type of content the track contains.

    MDN Reference

    enabled: boolean

    The enabled property of the true if the track is allowed to render the source stream or false if it is not.

    MDN Reference

    id: string

    The id read-only property of the MediaStreamTrack interface returns a string containing a unique identifier (GUID) for the track, which is generated by the user agent.

    MDN Reference

    kind: string

    The kind read-only property of the MediaStreamTrack interface returns a string set to 'audio' if the track is an audio track and to 'video' if it is a video track.

    MDN Reference

    label: string

    The label read-only property of the MediaStreamTrack interface returns a string containing a user agent-assigned label that identifies the track source, as in 'internal microphone'.

    MDN Reference

    muted: boolean

    The muted read-only property of the indicating whether or not the track is currently unable to provide media output.

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

    readyState: MediaStreamTrackState

    The readyState read-only property of the MediaStreamTrack interface returns an enumerated value giving the status of the track.

    MDN Reference

    Methods

    • The applyConstraints() method of the MediaStreamTrack interface applies a set of constraints to the track; these constraints let the website or app establish ideal values and acceptable ranges of values for the constrainable properties of the track, such as frame rate, dimensions, echo cancellation, and so forth.

      MDN Reference

      Parameters

      Returns Promise<void>

    • 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 getCapabilities() method of the MediaStreamTrack interface returns an object detailing the accepted values or value range for each constrainable property of the associated MediaStreamTrack, based upon the platform and user agent.

      MDN Reference

      Returns MediaTrackCapabilities

    • The getConstraints() method of the MediaStreamTrack interface returns a recently established for the track using a prior call to constraints indicate values and ranges of values that the website or application has specified are required or acceptable for the included constrainable properties.

      MDN Reference

      Returns MediaTrackConstraints

    • The stop() method of the MediaStreamTrack interface stops the track.

      MDN Reference

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods