ImageCapture: getPhotoSettings() method

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

The getPhotoSettings() method of the ImageCapture interface returns a Promise that resolves with an object containing the current photo configuration settings.

Syntax

js
getPhotoSettings()

Parameters

None.

Return value

A Promise that resolves with an object containing the following properties:

fillLightMode

The flash setting of the capture device, one of "auto", "off", or "flash".

imageHeight

The desired image height as an integer. The browser selects the closest width value to this setting if it only supports discrete heights.

imageWidth

The desired image width as an integer. The browser selects the closest width value to this setting if it only supports discrete widths.

redEyeReduction

A boolean indicating whether the red-eye reduction should be used if it is available.

Exceptions

InvalidStateError DOMException

Thrown if readyState property of the MediaStreamTrack passing in the constructor is not live.

OperationError DOMException

Thrown if the operation can't complete for any reason.

Examples

The following example, extracted from Chrome's Image Capture / Photo Resolution Sample, uses the results from getPhotoSettings() 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.

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

let 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.error("Argh!", error.name || error));

Specifications

Specification
MediaStream Image Capture
# dom-imagecapture-getphotosettings

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
getPhotoSettings
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.
User must explicitly enable this feature.