https://github.com/goatandsheep/overleia

Simplified picture-in-picture library for Node JS
https://github.com/goatandsheep/overleia

asl ffmpeg interpreter overlay picture-in-picture pip video

Last synced: 7 months ago
JSON representation

Simplified picture-in-picture library for Node JS

• Host: GitHub
• URL: https://github.com/goatandsheep/overleia
• Owner: goatandsheep
• License: mit
• Created: 2021-01-12T20:29:44.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-10T04:15:59.000Z (over 1 year ago)
• Last Synced: 2025-03-13T01:08:34.011Z (8 months ago)
• Topics: asl, ffmpeg, interpreter, overlay, picture-in-picture, pip, video
• Language: JavaScript
• Homepage:
• Size: 45.9 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Overleia

> Simplified picture-in-picture library for Node JS

[![npm version](https://badgen.net/npm/v/overleia)](https://www.npmjs.com/package/overleia)

[![codecov](https://badgen.net/codecov/c/github/goatandsheep/overleia)](https://codecov.io/gh/goatandsheep/overleia)

[![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)

[![npm downloads](https://img.shields.io/npm/dt/overleia.svg?style=flat-square)](https://www.npmjs.com/package/overleia)

## 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](#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>](#ViewInput) |  |



## OverleiaInput : object

**Kind**: global typedef  

**Properties**

| Name | Type | Default | Description |

| --- | --- | --- | --- |

| inputs | Array.<String> |  | file paths |

| template | [TemplateInput](#TemplateInput) |  |  |

| [filetype] | String | "mp4" |  |

| verbose | Boolean |  |  |