Capture

Provides access to the device's audio, image, and video capture capabilities.

WARNING: Collection and use of images, video, or audio from the device's camera or microphone raises important privacy issues. Your app's privacy policy should discuss how the app uses such sensors and whether the data recorded is shared with any other parties. In addition, if the app's use of the camera or microphone is not apparent in the user interface, you should provide a just-in-time notice before the app accesses the camera or microphone, if the device operating system doesn't do so already. That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for OK and No Thanks). Note that some app marketplaces may require the app to provide just-in-time notice and obtain permission from the user prior to accessing the camera or microphone. For more information, please see the Privacy Guide.

Objects

Methods

Scope

The capture object is assigned to the navigator.device object, and therefore has global scope.

// The global capture object
var capture = navigator.device.capture;

Properties

  • supportedAudioModes: The audio recording formats supported by the device. (ConfigurationData[])

  • supportedImageModes: The recording image sizes and formats supported by the device. (ConfigurationData[])

  • supportedVideoModes: The recording video resolutions and formats supported by the device. (ConfigurationData[])

Methods

  • [capture.captureAudio](captureAudio.html): Launch the device's audio recording application to record audio clips.

  • [capture.captureImage](captureImage.html): Launch the device's camera application to take photos.

  • [capture.captureVideo](captureVideo.html): Launch the device's video recorder application to record videos.

Supported Platforms

  • Amazon Fire OS
  • Android
  • BlackBerry WebWorks 5.0+
  • iOS
  • Windows Phone 7 and 8
  • Windows 8

Accessing the Feature

As of version 3.0, Cordova implements device-level APIs as plugins. Use the CLI's plugin command, described in The Command-Line Interface, to add or remove this feature for a project:

    $ cordova plugin add org.apache.cordova.media-capture
    $ cordova plugin ls
    [ 'org.apache.cordova.file',
      'org.apache.cordova.media-capture']
    $ cordova plugin rm org.apache.cordova.media-capture

These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:

  • Amazon Fire OS

      (in app/res/xml/config.xml)
  <feature name="File">
      <param name="android-package" value="org.apache.cordova.file.FileUtils" />
  </feature>
  <feature name="Capture">
      <param name="android-package" value="org.apache.cordova.mediacapture.Capture" />
  </feature>

  (in app/AndroidManifest.xml)   
  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
  <uses-permission android:name="android.permission.RECORD_AUDIO" />
  <uses-permission android:name="android.permission.RECORD_VIDEO" />

  • Android

      (in app/res/xml/config.xml)
  <feature name="File">
      <param name="android-package" value="org.apache.cordova.file.FileUtils" />
  </feature>
  <feature name="Capture">
      <param name="android-package" value="org.apache.cordova.mediacapture.Capture" />
  </feature>

  (in app/AndroidManifest.xml)
  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
  <uses-permission android:name="android.permission.RECORD_AUDIO" />
  <uses-permission android:name="android.permission.RECORD_VIDEO" />

  • BlackBerry WebWorks

      (in www/plugins.xml)
  <feature name="Capture">
      <param name="blackberry-package" value="org.apache.cordova.capture.MediaCapture" />
  </feature>

  (in www/config.xml)
  <feature id="blackberry.system"  required="true" version="1.0.0.0" />
  <feature id="blackberry.io.file" required="true" version="1.0.0.0" />

  • iOS (in the named application directory's config.xml)

      <feature name="Capture">
      <param name="ios-package" value="CDVCapture" />
  </feature>

  • Windows Phone (in Properties/WPAppManifest.xml)

      <Capabilities>
      <Capability Name="ID_CAP_MEDIALIB" />
      <Capability Name="ID_CAP_MICROPHONE" />
      <Capability Name="ID_HW_FRONTCAMERA" />
      <Capability Name="ID_CAP_ISV_CAMERA" />
      <Capability Name="ID_CAP_CAMERA" />
  </Capabilities>

Some platforms may support this feature without requiring any special configuration. See Platform Support for an overview.