Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pandres95/ndi.js
NDI® SDK for Node.js
https://github.com/pandres95/ndi.js
audio hacktoberfest ndi newtek newtek-ndi streaming video
Last synced: about 1 month ago
JSON representation
NDI® SDK for Node.js
- Host: GitHub
- URL: https://github.com/pandres95/ndi.js
- Owner: pandres95
- Created: 2021-11-17T16:49:07.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T15:27:57.000Z (12 months ago)
- Last Synced: 2024-11-07T23:46:14.611Z (about 2 months ago)
- Topics: audio, hacktoberfest, ndi, newtek, newtek-ndi, streaming, video
- Language: C
- Homepage:
- Size: 6.56 MB
- Stars: 47
- Watchers: 8
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
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
```bash
npm install ndi.js
```
## Usage
> TODO: Document usage and examples
## Development
### Run Locally
1. Clone the project.
2. Go to the project directory
```bash
cd my-project
```
3. Install dependencies
```bash
npm install
```
4. Run the sample CLI
```bash
./bin
./ndi.js random
```
### Running Tests
To run tests, run the following command
```bash
npm test
```
## Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
Please adhere to this project's `code of conduct`.
## Authors
- [@pandres95](https://www.github.com/pandres95)