• Skip to main content
  • Select language
  • Skip to search
MDN Web Docs
  • Technologies
    • HTML
    • CSS
    • JavaScript
    • Graphics
    • HTTP
    • APIs / DOM
    • WebExtensions
    • MathML
  • References & Guides
    • Learn web development
    • Tutorials
    • References
    • Developer Guides
    • Accessibility
    • Game development
    • ...more docs
B2G OS
  1. MDN
  2. Archive of obsolete content
  3. B2G OS
  4. B2G OS APIs
  5. CameraControl
  6. CameraControl.flashMode

CameraControl.flashMode

In This Article
  1. Summary
  2. Syntax
  3. Value
  4. Example
  5. Specification
  6. See also

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

  • CameraCapabilities
  • CameraControl

Document Tags and Contributors

Tags: 
  • API
  • B2G
  • camera
  • Firefox OS
  • Flash
  • Graphics
  • JavaScript
  • Non-standard
  • Property
  • Reference
  • Référence
  • WebAPI
 Contributors to this page: chrisdavidmills, teoli, MHasan, jsx, ajaybhat, Sheppy, Jeremie
 Last updated by: chrisdavidmills, Feb 27, 2017, 2:07:24 AM
See also
  1. Camera API
  2. Archive
  3. Related pages for Camera API
    1. CameraCapabilities
    2. CameraControl
    3. CameraManager