npm.io
0.0.23 • Published 13h ago

cordova-backgroundvideo

Licence
Version
0.0.23
Deps
0
Size
85 kB
Vulns
0
Weekly
0

Backgroundvideo

A simple Cordova/Phonegap/Ionic plugin to capture MP4 (h.264) video and then display it onscreen via a transparent overlay without affecting app functionality.

On Android can record videos with minimized app or even when screen is off. It can be used for spy cameras or for video surveillance.

On iOS you need to provide screen insomnia. Video will be correctly finished on app minimized, screen off or incoming call.

Supported Platforms

  • Android
  • iOS
  • Windows

How to use

Install
cordova plugin add cordova-backgroundvideo
Usage
Start recording
var fileName = new Date().getTime() + '';
var videoOptions = {camera: 'back', shouldRecordAudio: true, videoBitrate: 40960, audioBitrate: 10240};
var successFn = function(filePath) {
    console.log('video started:' + filePath);
};
var errorFn = function(error) {
    console.log('video recording error:' + error);
};
cordova.plugins.backgroundvideo.start(successFn, errorFn, fileName, videoOptions);
Start recording (minimalistic)
cordova.plugins.backgroundvideo.start(function(filePath) {
    console.log('video started:' + filePath);
});
VideoOptions : Object
Name Type Default Description
camera string back 'back' or 'front' to specify camera direction
shouldRecordAudio boolean true Record video with audio
videoBitrate int 40960 Video bitrate in bit per second (bps)
audioBitrate int 10240 Audio bitrate in bit per second (bps)
Stop recording
var successFn = function(filePath) {
    console.log('video saved:' + filePath);
};
var errorFn = function(error) {
    console.log('video recording error:' + error);
};
cordova.plugins.backgroundvideo.stop(successFn, errorFn);
Other bits

File

  • Outputs as mp4. You do not need to specify file extension.
  • Video files are saved to approot on sdcard or internal (plugin automatically chooses biggest partition).
Support

Please use the github issue tracker and we will come back to you as soon as we can.

Contribution

There's lots of Android phones all with their own quirks so we'd love it if you could contribute and help us support all of the devices out there.