Table of Contents

Class SrtServerInstanceParameters

Namespace
VAST.SRT
Assembly
VAST.SRT.dll

Represents the configuration parameters for a single SRT server instance.

public class SrtServerInstanceParameters
Inheritance
SrtServerInstanceParameters
Inherited Members

Constructors

SrtServerInstanceParameters() 

public SrtServerInstanceParameters()

Properties

AllowFileTransfers

Gets or sets whether file transfers are allowed for this server instance and will be processed.

public bool AllowFileTransfers { get; set; }

Property Value

bool

EncryptionKeyLength

Gets or sets the data encryption key length in bytes. Only applicable when a non-null passphrase is specified. Valid values are 16, 24, and 32 bytes (128, 192, and 256 bits). Defaults to 16 bytes (128 bits).

public int EncryptionKeyLength { get; set; }

Property Value

int

EndPoints

Gets the list of network endpoints that the server listens on for incoming connections.

public List<IPEndPoint> EndPoints { get; }

Property Value

List<IPEndPoint>

Remarks

By default, the list includes endpoints for both IPv4 and IPv6 on the default SRT port.

FlowDirection

Gets or sets media flow direction for current server instance. Must be set to Unspecified for full instance. Must be set to Input or Output for simple instance.

public MediaFlowDirection FlowDirection { get; set; }

Property Value

MediaFlowDirection

HandshakeMode

Gets or sets handshake mode for current server instance. Must be set to the default CallerListener value for full instance. Can be set to any value for simple instance.

public SrtHandshakeMode HandshakeMode { get; set; }

Property Value

SrtHandshakeMode

IPv4EndPoint

Gets or sets the local IPv4 address and port to listen to UDP connections on.

[Obsolete("Property is deprecated. Use EndPoints instead.")]
public IPEndPoint IPv4EndPoint { get; set; }

Property Value

IPEndPoint

IPv6EndPoint

Gets or sets the local IPv6 address and port to listen to UDP connections on.

[Obsolete("Property is deprecated. Use EndPoints instead.")]
public IPEndPoint IPv6EndPoint { get; set; }

Property Value

IPEndPoint

IsSimpleInstance

Gets or sets whether this server instance is a simple or full one. Full instance handles arbitrary number of publishing points, accepts both publishers and clients. Publishing path and media flow direction must be provided by a caller in stream metadata. Simple instance handles single pre-defined publishing path and one pre-defined media flow direction. Caller connecting to such instance may skip stream metadata, it'll be ignored anyway.

public bool IsSimpleInstance { get; set; }

Property Value

bool

LatencyStrategy

Gets or sets default latency strategy for receiver sessions of the server.

public SrtLatencyStrategy LatencyStrategy { get; set; }

Property Value

SrtLatencyStrategy

Passphrase

Gets or sets the passphrase for data encryption. If specified, it must be between 10 and 79 characters long. If not specified, no encryption is applied.

public string Passphrase { get; set; }

Property Value

string

PublishingPath

Gets or sets publishing path associated with current server instance. Must not be set for full instance. Must be set for simple instance.

public string PublishingPath { get; set; }

Property Value

string

RemoteEndPoint

Gets or sets remote end point to send rendezvous handshakes to. Must be specified if the HandshakeType is Rendezvous. Ignored otherwise.

public IPEndPoint RemoteEndPoint { get; set; }

Property Value

IPEndPoint

Methods

Clone()

Creates a shallow copy of this SrtServerInstanceParameters instance.

public SrtServerInstanceParameters Clone()

Returns

SrtServerInstanceParameters

A new SrtServerInstanceParameters instance with the same values.

Equals(SrtServerInstanceParameters)

Determines whether the specified SrtServerInstanceParameters is equal to this instance.

public bool Equals(SrtServerInstanceParameters obj)

Parameters

obj SrtServerInstanceParameters

The instance to compare with.

Returns

bool

true if the instances are equal; otherwise, false.