🎥

Media Capture

cordova-plugin-media-capture

iOS Android

This official Apache Cordova plugin captures photos, audio clips and video using the device's built-in capture apps. Each call returns an array of MediaFile objects describing the files that were recorded, which you can then upload, play or store.

Installation

terminal

cordova plugin add cordova-plugin-media-capture

API

The plugin lives on navigator.device.capture. Call these after deviceready:

Method	Description
`captureImage(success, error, options)`	Open the camera to take one or more photos.
`captureAudio(success, error, options)`	Open the sound recorder to capture audio clips.
`captureVideo(success, error, options)`	Open the camera to record one or more videos.

Options & result

The options object accepts limit (max files to capture) and, for audio/video, duration (max seconds). On success you receive an array of MediaFile objects:

Property	Description
`name`	The file name without the path.
`fullPath`	The full path to the file on the device.
`type`	The MIME type, e.g. `image/jpeg`.
`size`	The file size in bytes.

Usage example

Let the user record up to two short videos:

www/js/app.js

function recordVideo() {
  navigator.device.capture.captureVideo(
    function (files) {
      files.forEach(function (f) {
        console.log(f.name + " — " + f.size + " bytes");
      });
    },
    function (err) {
      console.error("Capture error: " + err.code);
    },
    { limit: 2, duration: 30 }
  );
}

Tips

Capture requires camera and microphone permissions, which are requested at runtime.
The fullPath is a device path — pair it with the File plugin to read or upload the result.
Capture only works on a physical device, not in simulators or emulators.

📚 Source: the technical reference on this page (the methods, options and the MediaFile object) is based on the official Apache Cordova media-capture documentation. Descriptions and examples have been rewritten in DedrisFramework's own words. Apache Cordova documentation is published by the Apache Software Foundation under the Apache License 2.0.

← Back to plugins Start a project