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.redEyeReduction
Read only- Returns one of
"never"
,"always"
, or"controllable"
. The"controllable"
value means the device's read-eye reduction is controllable by the user. PhotoCapabilities.imageHeight
Read only- Returns a
MediaSettingsRange
object indicating the image height range supported by the user agent. PhotoCapabilities.imageWidth
Read only- Returns a
MediaSettingsRange
object indicating the image width range supported by the user agent. PhotoCapabilities.fillLightMode
Read only- Returns an array of available fill light options. Options may include
auto
,off
, orflash
.
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 | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | 59 | ? | ? | ? | 46 | ? |
fillLightMode | 59 | ? | ? | ? | 46 | ? |
imageHeight | 59 | ? | ? | ? | 46 | ? |
imageWidth | 59 | ? | ? | ? | 46 | ? |
redEyeReduction | 59 | ? | ? | ? | 46 | ? |
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | Opera Android | iOS Safari | Samsung Internet |
---|---|---|---|---|---|---|---|
Basic support | 59 | 59 | ? | ? | 46 | ? | ? |
fillLightMode | 59 | 59 | ? | ? | 46 | ? | ? |
imageHeight | 59 | 59 | ? | ? | 46 | ? | ? |
imageWidth | 59 | 59 | ? | ? | 46 | ? | ? |
redEyeReduction | 59 | 59 | ? | ? | 46 | ? | ? |