PhotoCapabilities

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The PhotoCapabilities interface of the the MediaStream Image Capture API provides available configuration options for an attached photographic device. A PhotoCapabilities object is retrieved by calling ImageCapture.getPhotoCapabilities().

Properties

PhotoCapabilities.redEyeReductionRead only
Returns one of "never", "always", or "controllable". The "controllable" value means the device's read-eye reduction is controllable by the user.
PhotoCapabilities.imageHeightRead only
Returns a MediaSettingsRange object indicating the image height range supported by the user agent.
PhotoCapabilities.imageWidthRead only
Returns a MediaSettingsRange object indicating the image width range supported by the user agent.
PhotoCapabilities.fillLightModeRead only
Returns an array of available fill light options. Options may include auto, off, or flash.

Example

The following example, extracted from Chrome's Image Capture / Photo Resolution Sample, uses the results from getPhotoCapabilities() to modify the size of an input range. This example also shows how the ImageCapture object is created using a MediaStreamTrack retrieved from a device's MediaStream

const input = document.querySelector('input[type="range"]');

var imageCapture;

navigator.mediaDevices.getUserMedia({video: true})
.then(mediaStream => {
  document.querySelector('video').srcObject = mediaStream;

  const track = mediaStream.getVideoTracks()[0];
  imageCapture = new ImageCapture(track);

  return imageCapture.getPhotoCapabilities();
})
.then(photoCapabilities => {
  const settings = imageCapture.track.getSettings();

  input.min = photoCapabilities.imageWidth.min;
  input.max = photoCapabilities.imageWidth.max;
  input.step = photoCapabilities.imageWidth.step;

  return imageCapture.getPhotoSettings();
})
.then(photoSettings => {
  input.value = photoSettings.imageWidth;
})
.catch(error => console.log('Argh!', error.name || error));

Specifications

Specification Status Comment
MediaStream Image Capture
The definition of 'PotoCapabilities' in that specification.
Working Draft Initial definition.

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 59 ? ? ? ?
Feature Android Webview Chrome for Android Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile
Basic support 59 59 ? ? ? ? ?

Document Tags and Contributors

 Contributors to this page: jpmedley
 Last updated by: jpmedley,