Table of Contents

Class SRTSourceSettings

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

Configuration settings for an SRT connection.

public class SRTSourceSettings : IMediaPlayerBaseSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Inheritance

Implements

Inherited Members

Properties

Authentication

Authenticate a connection. Defaults to true.

public bool Authentication { get; set; }

Property Value

bool

AutoReconnect

Automatically reconnect when connection fails. Defaults to true.

public bool AutoReconnect { 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 SRT stream fails.

public FallbackSwitchSettings FallbackSwitch { get; set; }

Property Value

FallbackSwitchSettings

KeepListening

If false, the element will return GST_FLOW_EOS when the remote client disconnects. If true, the element will keep waiting for the client to reconnect. Defaults to false.

public bool KeepListening { get; set; }

Property Value

bool

Latency

Gets or sets the maximum accepted transmission latency. Defaults to 125 milliseconds.

public TimeSpan Latency { get; set; }

Property Value

TimeSpan

LocalAddress

The address to bind when mode is listener or rendezvous. Defaults to null.

public string LocalAddress { get; set; }

Property Value

string

LocalPort

The local port to bind when mode is listener or rendezvous. Defaults to 7001.

public uint LocalPort { get; set; }

Property Value

uint

Mode

The SRT connection mode. Defaults to GstSRTConnectionMode.GST_SRT_CONNECTION_MODE_CALLER.

public SRTConnectionMode Mode { get; set; }

Property Value

SRTConnectionMode

Passphrase

The password for the encrypted transmission.

public string Passphrase { get; set; }

Property Value

string

PbKeyLen

The crypto key length. Defaults to GstSRTKeyLength.GST_SRT_KEY_LENGTH_NO_KEY.

public SRTKeyLength PbKeyLen { get; set; }

Property Value

SRTKeyLength

PollTimeout

The polling timeout used when SRT poll is started. Defaults to 1000 milliseconds.

public TimeSpan PollTimeout { get; set; }

Property Value

TimeSpan

StreamId

The stream ID for the SRT access control.

public string StreamId { get; set; }

Property Value

string

Uri

The URI used by SRT connection. Defaults to "srt://127.0.0.1:7001".

public string Uri { get; set; }

Property Value

string

WaitForConnection

Block the stream until a client connects. Defaults to true.

public bool WaitForConnection { get; set; }

Property Value

bool

Methods

CreateAsync(string, bool)

Create as an asynchronous operation.

public static Task<SRTSourceSettings> CreateAsync(string uri, bool ignoreMediaInfoReader = false)

Parameters

uri string

The URI.

ignoreMediaInfoReader bool

if set to true [ignore media information reader].

Returns

Task<SRTSourceSettings>

A Task<SRTSourceSettings> representing the asynchronous operation.

Exceptions

Exception

Unable to read file info.

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetInfo()

Gets the file information.

public MediaFileInfo GetInfo()

Returns

MediaFileInfo

MediaFileInfo.

Remarks

If VideoCustomFrameRate is set you'll have this value as a frame rate.

ReadInfoAsync()

Read information as an asynchronous operation.

public Task<MediaFileInfo> ReadInfoAsync()

Returns

Task<MediaFileInfo>

A Task<MediaFileInfo> representing the asynchronous operation.