cordova-background-video
A simple Cordova/Phonegap plugin to capture video and then display it onscreen via a transparent overlay without affecting app functionality.
How to use
Install
cordova plugin add https://github.com/jamesla/backgroundvideo.git
Usage
cordova.plugins.backgroundvideo.start(fileStorage, filename, camera, quality, successfn, errorfn);
Getting started
start recording
cordova.plugins.backgroundvideo.start('cacheDirectory', 'myvideo', 'front', 'medium', null, null);
stop recording
cordova.plugins.backgroundvideo.stop(successFn, errorFn);
Other bits
Quality can be medium, low, high
Camera 'front' or 'back' to specify camera direction.
File
- Outputs as mp4. You do not need to specify file extension.
- Video files are saved to approot/tmp folder (cordova.plugins.backgroundvideo.stop() will return the file path).
File System Layouts
Although technically an implementation detail, it can be very useful to know how
the cordova.file.* properties map to physical paths on a real device.
iOS File System Layout
| Device Path | cordova.file.* |
iosExtraFileSystems |
r/w? | persistent? | OS clears | sync | private |
|---|---|---|---|---|---|---|---|
/var/mobile/Applications/<UUID>/ |
applicationStorageDirectory | - | r | N/A | N/A | N/A | Yes |
   appname.app/
|
applicationDirectory | bundle | r | N/A | N/A | N/A | Yes |
      www/
|
- | - | r | N/A | N/A | N/A | Yes |
   Documents/
|
documentsDirectory | documents | r/w | Yes | No | Yes | Yes |
      NoCloud/
|
- | documents-nosync | r/w | Yes | No | No | Yes |
   Library
|
- | library | r/w | Yes | No | Yes? | Yes |
      NoCloud/
|
dataDirectory | library-nosync | r/w | Yes | No | No | Yes |
      Cloud/
|
syncedDataDirectory | - | r/w | Yes | No | Yes | Yes |
      Caches/
|
cacheDirectory | cache | r/w | Yes* | Yes*** | No | Yes |
   tmp/
|
tempDirectory | - | r/w | No** | Yes*** | No | Yes |
Android File System Layout
| Device Path | cordova.file.* |
AndroidExtraFileSystems |
r/w? | persistent? | OS clears | private |
|---|---|---|---|---|---|---|
file:///android_asset/ |
applicationDirectory | assets | r | N/A | N/A | Yes |
/data/data/<app-id>/ |
applicationStorageDirectory | - | r/w | N/A | N/A | Yes |
   cache
|
cacheDirectory | cache | r/w | Yes | Yes* | Yes |
   files
|
dataDirectory | files | r/w | Yes | No | Yes |
      Documents
|
documents | r/w | Yes | No | Yes | |
<sdcard>/ |
externalRootDirectory | sdcard | r/w | Yes | No | No |
   Android/data/<app-id>/
|
externalApplicationStorageDirectory | - | r/w | Yes | No | No |
      cache
|
externalCacheDirectry | cache-external | r/w | Yes | No** | No |
      files
|
externalDataDirectory | files-external | r/w | Yes | No | No |
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.
