MediaDevices: enumerateDevices() method

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

Access to particular devices is gated by the Permissions API. The list of returned devices will omit any devices for which the corresponding permission has not been granted, including: microphone, camera, speaker-selection (for output devices), and so on.

Syntax

js

enumerateDevices()

Parameters

None.

Return value

A Promise that receives an array of MediaDeviceInfo objects when the promise is fulfilled. Each object in the array describes one of the available media input and output devices. The order is significant — the default capture devices will be listed first.

Only device types for which permission has been granted are "available". Also note that if a speaker-selection Permissions Policy is used to block use of audio outputs, they won't be available in the list.

If enumeration fails, the promise is rejected.

Security requirements

Access to the API is subject to the following constraints:

Examples

Here's an example of using enumerateDevices(). It outputs a list of the device IDs, with their labels if available.

js

if (!navigator.mediaDevices?.enumerateDevices) {
  console.log("enumerateDevices() not supported.");
} else {
  // List cameras and microphones.
  navigator.mediaDevices
    .enumerateDevices()
    .then((devices) => {
      devices.forEach((device) => {
        console.log(`${device.kind}: ${device.label} id = ${device.deviceId}`);
      });
    })
    .catch((err) => {
      console.error(`${err.name}: ${err.message}`);
    });
}

This might produce:

videoinput: id = csO9c0YpAf274OuCPUA53CNE0YHlIr2yXCi+SqfBZZ8=
audioinput: id = RKxXByjnabbADGQNNZqLVLdmXlS0YkETYCIbg+XxnvM=
audioinput: id = r2/xw1xUPIyZunfV1lGrKOma5wTOvCkWfZ368XCndm0=

or if one or more MediaStreams are active or persistent permissions are granted: 

videoinput: FaceTime HD Camera (Built-in) id=csO9c0YpAf274OuCPUA53CNE0YHlIr2yXCi+SqfBZZ8=
audioinput: default (Built-in Microphone) id=RKxXByjnabbADGQNNZqLVLdmXlS0YkETYCIbg+XxnvM=
audioinput: Built-in Microphone id=r2/xw1xUPIyZunfV1lGrKOma5wTOvCkWfZ368XCndm0=

Specifications

Specification
Media Capture and Streams
# dom-mediadevices-enumeratedevices

Browser compatibility

BCD tables only load in the browser

See also