Simplified picture-in-picture library for Node JS


Keywords
asl, pip, picture, in, deaf, interpreter, video, ffmpeg, overlay, picture-in-picture
License
MIT
Install
npm install overleia@3.0.0-rc3

Documentation

Overleia

Simplified picture-in-picture library for Node JS

npm version codecov XO code style npm downloads

Breaking changes

Dependencies

From 1.x to 2.x we've changed our ffmpeg library from being ecmascript compiled to being wasm compiled. The benefit being better library support and that this is a fully-featured build and that it has better browser support. The caveat is that it requires experimental node flags that you can see from the npm command next:

node --experimental-wasm-threads --experimental-wasm-bulk-memory test/basic.js

Functions

PipLib(params, directory)

Typedefs

ViewInput : object
TemplateInput : object
OverleiaInput : object

PipLib(params, directory)

Kind: global function

Param Type Description
params OverleiaInput
directory String maximum 1 slash

ViewInput : object

Kind: global typedef
Properties

Name Type Default Description
x Number
y Number
height Number
[width] Number optional to maintain ratio
[delay] Number 0

TemplateInput : object

Kind: global typedef
Properties

Name Type Description
height Number
[width] Number optional to maintain ratio
views Array.<ViewInput>

OverleiaInput : object

Kind: global typedef
Properties

Name Type Default Description
inputs Array.<String> file paths
template TemplateInput
[filetype] String "mp4"
verbose Boolean