CameraControl.zoom

« DOM Reference

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

This API is available on Firefox OS for certified applications only.

Summary

The zoom property value is a number that defines the zoom factor that is to be used when taking photographs. When set, its new value must be chosen from the list of options specified by  CameraCapabilities.zoomRatios. If the new value is not one of those possible values, the new value is rounded to the nearest supported value.

Syntax

var zoomFactor = instanceOfCameraControl.zoom

Value

Returns a number representing the current scene mode. The default value is 1.

Example

var options = {
  camera: navigator.mozCameras.getListOfCameras()[0]
};
 
function onSuccess( camera ) {
  var zoomRatios = camera.capabilities.zoomRatios;

  if (zoomRatios !== null && zoomRatios.indexOf(2) > -1) {
    camera.zoom = 2;
  }
};

navigator.mozCameras.getCamera(options, onSuccess)

Specification

Not part of any specification; however, this API should be removed when the WebRTC Capture and Stream API has been implemented.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, SarahWalrus, kscarfone, ajaybhat, Jeremie
Last updated by: ajaybhat,