MediaDevices: enumerateDevices() method
The MediaDevices
method enumerateDevices()
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.
The returned list will omit any devices that are blocked by the document Permission Policy: microphone
, camera
, speaker-selection
(for output devices), and so on. Access to particular non-default devices is also gated by the Permissions API, and the list will omit devices for which the user has not granted explicit permission.
Syntax
Parameters
Return value
A Promise
that is fulfilled with an array of MediaDeviceInfo
objects. 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.
Other than default devices, only devices for which permission has been granted are "available".
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.
if (!navigator.mediaDevices?.enumerateDevices) {
console.log("enumerateDevices() not supported.");
} else {
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 MediaStream
s 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
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
enumerateDevices |
47 |
12 |
116enumerateDevices() enumerates both input and output devices. Previously only input devices were returned.39enumerateDevices() only returns input devices.
|
No |
34 |
11 |
47 |
47 |
116enumerateDevices() enumerates both input and output devices. Previously only input devices were returned.39enumerateDevices() only returns input devices.
|
34 |
11 |
5.0 |
See also