grandi / receive

Variable: receive

const receive: (params) => Promise<Receiver> = addon.receive

Defined in: index.ts:288

Creates an NDI receiver for receiving video and audio from an NDI source.

Parameters

params

ReceiveOptions

Options for creating the receiver.

Returns

Promise<Receiver>

A promise that resolves to a Receiver instance for receiving data.

Throws

Promise rejects on unsupported platform/CPU or if receiver creation fails.

Example

import { find, initialize, receive } from "grandi";
initialize();
const finder = await find({ showLocalSources: true });
await finder.wait(1000);
const source = finder.sources()[0];
finder.destroy();
const receiver = await receive({ source });
const frame = await receiver.video(1000);
receiver.destroy();