Grandi

Grandi provides TypeScript-first native Node.js bindings for the NDI™ 6 SDK. It supports discovery, receiving, sending, FrameSync, and routing.

• Documentation
• API reference
• Examples
• Release notes
• Changelog

Installation

Grandi requires Node.js 20.19.5 or later. See the installation guide for platform requirements.

npm install grandi

Usage

import grandi from "grandi";

const finder = await grandi.find();

try {
	await finder.wait(1_000);
	console.log(finder.sources());
} finally {
	finder.destroy();
}

See the documentation for these workflows:

• Discover sources
• Receive media
• Send media
• Frame synchronization
• Route sources
• Electron and bundlers

For a complete Electron application, see the Electron NDI viewer.

Development

npm run build
npm test
npm run lint
npm run format

Run the local NDI benchmark with npm run bench. Native source builds use npm run build:addon.

License

Grandi uses the Apache 2.0 license. See LICENSE and NOTICE for license and attribution details.

The NDI SDK files use the NDI SDK License. NDI™ is a trademark of NewTek, Inc.