Table of Contents

Class NDISourceSettings

Namespace
VisioForge.Core.Types.X.Sources
Assembly
VisioForge.Core.dll

NDI source settings.

public class NDISourceSettings : IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Inheritance

Implements

Inherited Members

Properties

Bandwidth

Gets or sets the bandwidth setting.

public int Bandwidth { get; set; }

Property Value

int

ColorFormat

Gets or sets the color format for receiving video.

public NDIRecvColorFormat ColorFormat { get; set; }

Property Value

NDIRecvColorFormat

ConnectTimeout

Gets or sets the connection timeout for initial connection attempts.

public TimeSpan ConnectTimeout { get; set; }

Property Value

TimeSpan

DoTimestamp

Gets or sets whether to apply timestamps to buffers.

public bool DoTimestamp { get; set; }

Property Value

bool

FallbackSwitch

Gets or sets the fallback switch settings for automatic failover. When configured, the source will automatically switch to a fallback (static text, image, or media) when the main NDI stream fails.

public FallbackSwitchSettings FallbackSwitch { get; set; }

Property Value

FallbackSwitchSettings

MaxQueueLength

Gets or sets the maximum receive queue length.

public uint MaxQueueLength { get; set; }

Property Value

uint

ReceiverName

Gets or sets the name of the receiver.

public string ReceiverName { get; set; }

Property Value

string

SourceName

Gets or sets the name of the source.

public string SourceName { get; set; }

Property Value

string

Timeout

Gets or sets the receive timeout for detecting disconnected sources.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

TimestampMode

Gets or sets the timestamp mode for synchronization.

public NDITimestampMode TimestampMode { get; set; }

Property Value

NDITimestampMode

URL

Gets or sets the URL.

public string URL { get; set; }

Property Value

string

Methods

CreateAsync(ContextX, NDISourceInfo)

Create as an asynchronous operation.

public static Task<NDISourceSettings> CreateAsync(ContextX context, NDISourceInfo info)

Parameters

context ContextX

The context.

info NDISourceInfo

The information.

Returns

Task<NDISourceSettings>

A Task<NDISourceSettings> representing the asynchronous operation.

CreateAsync(ContextX, string, string)

Create as an asynchronous operation.

public static Task<NDISourceSettings> CreateAsync(ContextX context, string sourceName, string url)

Parameters

context ContextX

The context.

sourceName string

Name of the source.

url string

The URL.

Returns

Task<NDISourceSettings>

A Task<NDISourceSettings> representing the asynchronous operation.

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetInfo()

Gets the information.

public MediaFileInfo GetInfo()

Returns

MediaFileInfo

MediaFileInfo.

IsValid()

Check that the source is available.

public bool IsValid()

Returns

bool

true if both VisioForge.Core.Types.X.Sources.NDISourceSettings.SourceName and VisioForge.Core.Types.X.Sources.NDISourceSettings.URL are not null or empty; otherwise, false.