ndi.js
v1.1.0
Published
Wrapper library for NDI
Downloads
2
Readme
NDI.js
Disclaimer: This library is a Work In Progress.
This library intends to be a Node.js wrapper for NDI v5 (and following) library.
Features
- Find API
- [x] Listing Sources
- Send API
- [x] Creating Send Instance
- [x] Sending Video Streams
- [x] Sending Audio Streams
- [x] Sending Audio/Video Streams
- Recv API
- [x] Setting Tally
Roadmap
- Send API
- [ ] Sending Metadata
- [ ] Receiving Tally
- Recv API
- [ ] Receiving Video Streams
- [ ] Receiving Audio Streams
- [ ] Receiving Metadata
Installation
Install ndi.js
with npm
npm install ndi.js
Usage
TODO: Document usage and examples
Development
Run Locally
- Clone the project.
- Go to the project directory
cd my-project
- Install dependencies
npm install
- Run the sample CLI
./bin
./ndi.js random
Running Tests
To run tests, run the following command
npm test
Contributing
Contributions are always welcome!
See contributing.md
for ways to get started.
Please adhere to this project's code of conduct
.