NdiInputSettings interface

Settings to control NDI capture see: NorskInput.ndi()

Signature:

export interface NdiInputSettings extends SourceNodeSettings<NdiInputNode>, StreamStatisticsMixin

Extends: SourceNodeSettings<NdiInputNode>, StreamStatisticsMixin

Properties

Property Type Description

Property	Type	Description
ndiReceiveName	string	The receive name to publish to the source
ndiSource	{ url: string; } \| { name: string; }	the NDI source name or url to capture from, which can be found through `ndiDiscovery`
onInitialised?	() ⇒ void	(Optional) Called when the receiver is initialised; you could use this to avoid starting other nodes until frame reception is guaranteed
sourceFrameRate?	{ variable: undefined; } \| { fixed: FrameRate; }	(Optional) Override the source frame rate - should only be used if you have reason to beleive that the frame rate announced by the source is incorrect. Selecting a frame rate that differs from the source will lead to undefined behaviour
sourceName	string	sourceName of this capture

ndiReceiveName

string

The receive name to publish to the source

ndiSource

{ url: string; } | { name: string; }

the NDI source name or url to capture from, which can be found through ndiDiscovery

onInitialised?

() ⇒ void

(Optional) Called when the receiver is initialised; you could use this to avoid starting other nodes until frame reception is guaranteed

sourceFrameRate?

{ variable: undefined; } | { fixed: FrameRate; }

(Optional) Override the source frame rate - should only be used if you have reason to beleive that the frame rate announced by the source is incorrect. Selecting a frame rate that differs from the source will lead to undefined behaviour

sourceName

string

sourceName of this capture