CameraControl.effect

« 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 effect property is a string defining the effect to be used by the camera. When set, its value must be one of the values available in CameraCapabilities.effects.

Syntax

var currentEffect = instanceOfCameraControl.effect

Value

Return a string representing the current effect used by the camera. If no effect is used, the string none is returned.

Example

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

  if (capablities.effects.indexOf('sepia') > -1) {
    camera.effect = 'sepia';
  }
};

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,