Table of Contents

Class NdiGlobal

Namespace
VAST.NDI
Assembly
VAST.NDI.dll

Provides global NDI configuration, device enumeration, and shared source management.

public static class NdiGlobal
Inheritance
NdiGlobal
Inherited Members

Properties

AllowAudioSources

Gets or sets a value indicating whether audio sources are allowed during enumeration.

public static bool AllowAudioSources { get; set; }

Property Value

bool

AllowVideoSources

Gets or sets a value indicating whether video sources are allowed during enumeration.

public static bool AllowVideoSources { get; set; }

Property Value

bool

DefaultCapturePixelFormat

Gets or sets the default pixel format used for NDI capture.

public static PixelFormat DefaultCapturePixelFormat { get; set; }

Property Value

PixelFormat

DynamicLibrary32BitPath

Gets or sets the file path to the 32-bit NDI dynamic library.

public static string DynamicLibrary32BitPath { get; set; }

Property Value

string

DynamicLibrary64BitPath

Gets or sets the file path to the 64-bit NDI dynamic library.

public static string DynamicLibrary64BitPath { get; set; }

Property Value

string

SourceEnumerationExpiration

Gets or sets the source enumeration cache expiration time in 100-nanosecond units.

public static long SourceEnumerationExpiration { get; set; }

Property Value

long

SourceEnumerationExtraIps

Gets or sets the extra IP addresses to use during source enumeration.

public static string SourceEnumerationExtraIps { get; set; }

Property Value

string

SourceEnumerationGroups

Gets or sets the NDI groups to use during source enumeration.

public static string SourceEnumerationGroups { get; set; }

Property Value

string

SourceEnumerationTimeout

Gets or sets the source enumeration timeout in 100-nanosecond units.

public static long SourceEnumerationTimeout { get; set; }

Property Value

long

StreamDetectionTimeout

Gets or sets the stream detection timeout in 100-nanosecond units.

public static long StreamDetectionTimeout { get; set; }

Property Value

long

Methods

EnumerateAudioSources(AudioDeviceEnumeratorParameters)

Enumerates available NDI audio capture sources asynchronously.

public static Task<List<AudioCaptureDeviceDescriptor>> EnumerateAudioSources(AudioDeviceEnumeratorParameters parameters)

Parameters

parameters AudioDeviceEnumeratorParameters

The audio device enumerator parameters to use.

Returns

Task<List<AudioCaptureDeviceDescriptor>>

A Task<TResult> containing the list of discovered AudioCaptureDeviceDescriptor instances.

EnumerateVideoSources()

Enumerates available NDI video capture sources asynchronously.

public static Task<List<VideoCaptureDeviceDescriptor>> EnumerateVideoSources()

Returns

Task<List<VideoCaptureDeviceDescriptor>>

A Task<TResult> containing the list of discovered VideoCaptureDeviceDescriptor instances.

GetAudioDeviceDescriptor(string, AudioDeviceEnumeratorParameters)

Gets the audio device descriptor for the specified device identifier.

public static AudioCaptureDeviceDescriptor GetAudioDeviceDescriptor(string deviceId, AudioDeviceEnumeratorParameters parameters)

Parameters

deviceId string

The device identifier to look up.

parameters AudioDeviceEnumeratorParameters

The audio device enumerator parameters, or null.

Returns

AudioCaptureDeviceDescriptor

The AudioCaptureDeviceDescriptor for the specified device, or null if not found.

GetVideoDeviceDescriptor(string)

Gets the video device descriptor for the specified device identifier.

public static VideoCaptureDeviceDescriptor GetVideoDeviceDescriptor(string deviceId)

Parameters

deviceId string

The device identifier to look up.

Returns

VideoCaptureDeviceDescriptor

The VideoCaptureDeviceDescriptor for the specified device, or null if not found.

RegisterKnownDevice(string, string, bool, bool)

Registers a known NDI device with the specified URL address and stream detection results.

public static void RegisterKnownDevice(string sourceName, string urlAddress, bool audioDetected, bool videoDetected)

Parameters

sourceName string

The NDI source name.

urlAddress string

The URL address of the device, or null.

audioDetected bool

Whether audio was detected on this device.

videoDetected bool

Whether video was detected on this device.

Unload()

Unloads the NDI library and performs manual cleanup.

public static void Unload()