Skip to content

pandres95/ndi.js

Repository files navigation

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
    • Listing Sources
  • Send API
    • Creating Send Instance
    • Sending Video Streams
    • Sending Audio Streams
    • Sending Audio/Video Streams
  • Recv API
    • 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

  1. Clone the project.
  2. Go to the project directory
  cd my-project
  1. Install dependencies
  npm install
  1. 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.

Authors