CameraControl.flashMode

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

Summary

The flashMode property value is a string that defines how the flash, if any, is to be used. When set, its new value must be chosen from the list of options specified by  CameraCapabilities.flashModes.

Syntax

var flash = instanceOfCameraControl.flashMode

Value

Return a string representing the current flash mode. The default value is auto if the device has a flash, none otherwise.

Example

var options = {
  camera: navigator.mozCameras.getListOfCameras()[0]
};
function onSuccess( camera ) {
  var capabilities = camera.capabilities;
  if (capablities.flashModes.indexOf('off') > -1) {
    camera.flashMode = 'off';
  }
};
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: chrisdavidmills, teoli, MHasan, jsx, ajaybhat, Sheppy, Jeremie
 Last updated by: chrisdavidmills,