Chartbreaker
    Preparing search index...

    Interface MediaDevices

    The MediaDevices interface of the Media Capture and Streams API provides access to connected media input devices like cameras and microphones, as well as screen sharing. In essence, it lets you obtain access to any hardware source of media data. Available only in secure contexts.

    MDN Reference

    interface MediaDevices {
        ondevicechange: ((this: MediaDevices, ev: Event) => any) | null;
        addEventListener<K extends "devicechange">(
            type: K,
            listener: (this: MediaDevices, ev: MediaDevicesEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        enumerateDevices(): Promise<MediaDeviceInfo[]>;
        getDisplayMedia(options?: DisplayMediaStreamOptions): Promise<MediaStream>;
        getSupportedConstraints(): MediaTrackSupportedConstraints;
        getUserMedia(constraints?: MediaStreamConstraints): Promise<MediaStream>;
        removeEventListener<K extends "devicechange">(
            type: K,
            listener: (this: MediaDevices, ev: MediaDevicesEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    ondevicechange: ((this: MediaDevices, ev: Event) => any) | null

    Methods

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      Returns boolean

    • The enumerateDevices() method of the MediaDevices interface requests a list of the currently available media input and output devices, such as microphones, cameras, headsets, and so forth. The returned Promise is resolved with an array of MediaDeviceInfo objects describing the devices.

      MDN Reference

      Returns Promise<MediaDeviceInfo[]>

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Type Parameters

      • K extends "devicechange"

      Parameters

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      Returns void