InputDeviceInfo: getCapabilities() method

{{APIRef("Media Capture and Streams")}}{{securecontext_header}}

The getCapabilities() method of the {{domxref("InputDeviceInfo")}} interface returns a MediaTrackCapabilities object describing the primary audio or video track of the device's {{domxref("MediaStream")}}.

Syntax

getCapabilities()

Parameters

None.

Return value

A MediaTrackCapabilities object which specifies the value or range of values which are supported for each of the user agent's supported constrainable properties. It is required to return identical information as returned by calling getCapabilities() on the first {{domxref("MediaStreamTrack")}} of the same kind as this device (video or audio) in the MediaStream returned by getUserMedia({ deviceId: deviceInfo.deviceId }).

See {{domxref("MediaStreamTrack.getCapabilities()")}} for a list of commonly supported properties and their types.

[!NOTE] If the user has not granted permission to access the input device an empty object will be returned.

Examples

In the following example we ask for permission to access audio and video devices with {{domxref("mediaDevices.getUserMedia()")}}, as to use getCapabilities() we need permission to access the devices.

If device is an InputDeviceInfo object, then getCapabilities() will return an object with members representing its capabilities. A video stream will not include auto properties such as noiseSuppression, for example.

// Get permission to access audio or video devices
navigator.mediaDevices
  .getUserMedia({ audio: true, video: true })
  // Enumerate media devices
  .then(() => navigator.mediaDevices.enumerateDevices())
  .then((devices) => {
    devices.forEach((device) => {
      if (typeof device.getCapabilities === "function") {
        console.log("Capabilities:", device.getCapabilities()); // A MediaTrackCapabilities object.
      } else {
        console.log("Device does not support getCapabilities:", device);
      }
    });
  })
  .catch((mediaError) => {
    console.error("Error accessing media devices:", mediaError);
  });

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("MediaStreamTrack.getCapabilities()")}}, which also return a MediaTrackCapabilities object.