Capture

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

Important privacy note: 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 prior to your app accessing 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 your 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

• Capture
• CaptureAudioOptions
• CaptureImageOptions
• CaptureVideoOptions
• CaptureCB
• CaptureErrorCB
• ConfigurationData
• MediaFile
• MediaFileData

Methods

• capture.captureAudio
• capture.captureImage
• capture.captureVideo
• MediaFile.getFormatData

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: Launch the device audio recording application for recording audio clip(s).
• capture.captureImage: Launch the device camera application for taking image(s).
• capture.captureVideo: Launch the device video recorder application for recording video(s).

Supported Platforms

• Android
• BlackBerry WebWorks (OS 5.0 and higher)
• iOS
• Windows Phone 7 and 8
• Windows 8

Permissions

Android

app/res/xml/plugins.xml

<plugin name="Capture" value="org.apache.cordova.Capture"/>

app/AndroidManifest.xml

<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />   

Bada

manifest.xml

<Privilege>
    <Name>RECORDING</Name>
</Privilege>

BlackBerry WebWorks

www/plugins.xml

<plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" />

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

config.xml

<plugin name="Capture" value="CDVCapture" />

webOS

No permissions are required.

Windows Phone

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>