ows-background-video/README.md

A plugin for recording video and overlaying it over an app

# Backgroundvideo

##### 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
if you want to install original version:
```
cordova plugin add https://github.com/jamesla/backgroundvideo.git 
```
new version for android:
```
cordova plugin add https://github.com/andaica/custom-background-video.git (deprecated)
```
```
cordova plugin add ows-background-video
```
### Usage
```
cordova.plugins.backgroundvideo.start(filename, cameradirection, successfn, errorfn);
```

# Getting started
###### start recording
```
cordova.plugins.backgroundvideo.start('myvideo', 'front', successFn, errorFn);
```
###### stop recording (support in original version)
```
cordova.plugins.backgroundvideo.stop(successFn, errorFn); 
```
### Other bits
**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).

### 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.