Provides access to the device's audio, image, and video capture capabilities.
capture object is assigned to the
navigator.device object, and
therefore has global scope.
// The global capture object var capture = navigator.device.capture;
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)
[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.
- BlackBerry WebWorks (OS 5.0 and higher)
- 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:
(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.RECORD_AUDIO" /> <uses-permission android:name="android.permission.RECORD_VIDEO" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
(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="184.108.40.206" /> <feature id="blackberry.io.file" required="true" version="220.127.116.11" />
<feature name="Capture"> <param name="ios-package" value="CDVCapture" /> </feature>
Windows Phone (in
<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 in the Overview section.