Package Exports
- overleia
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (overleia) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Overleia
Simplified picture-in-picture library for Node JS
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 |