Class RtspServerParameters

Namespace

VAST.RTSP

Assembly

VAST.RTSP.dll

Represents configuration parameters for the RTSP server.

public class RtspServerParameters

Inheritance

object

RtspServerParameters

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RtspServerParameters()

public RtspServerParameters()

Properties

AllowAggregatePackets

Gets or sets whether to allow aggregate packets in H.264 and H.265 packetizers. Should be used for compatibility with picky RTSP clients. Default value is true, i.e. aggregate packets are allowed.

public bool AllowAggregatePackets { get; set; }

Property Value

bool

AllowBasicAuthentication

Gets or sets whether to allow basic authentication. Makes sense only when InternalPublisherAuthentication or InternalClientAuthentication are specified. Default value is false, i.e. basic authentication disabled.

public bool AllowBasicAuthentication { get; set; }

Property Value

bool

AllowTeardown

Gets or sets whether to allow sending TEARDOWN to remote peer when closing session. Can be set to false to speed up shutdown of RTSP server. Default value is true, i.e. TEARDOWN is allowed.

public bool AllowTeardown { get; set; }

Property Value

bool

AllowedRtpTransports

Gets or sets allowed RTP transports. Default value is Any, i.e. allow TCP, UDP and RTSP over HTTP transports.

public RtpTransportType AllowedRtpTransports { get; set; }

Property Value

RtpTransportType

CertificateThumbprint

Gets or sets certificate thumbprint of certificate to be used in RTSPS server

public string CertificateThumbprint { get; set; }

Property Value

string

CheckRtcpTimeout

Gets or sets whether to check for RTCP packet reception timeout. Disabled by default because many IPTV cameras don't send RTCP at all.

public bool CheckRtcpTimeout { get; set; }

Property Value

bool

DisconnectOnError

Gets or sets whether server should drop client connection immediately in case of unrecoverable error. By default server never closes connection forcibly and is waiting for a client to do so. If set to true then there is a high chance that client will not receive the last server response with error description.

public bool DisconnectOnError { get; set; }

Property Value

bool

InternalClientAuthentication

Gets or sets optional list of username/password pairs to authenticate clients

public SortedList<string, string> InternalClientAuthentication { get; set; }

Property Value

SortedList<string, string>

InternalPublisherAuthentication

Gets or sets optional list of username/password pairs to authenticate publishers

public SortedList<string, string> InternalPublisherAuthentication { get; set; }

Property Value

SortedList<string, string>

KeepOriginalTimestamps

Gets or sets whether to keep original timestamps provided to RTSP sinks intact. Even though the RTP timestamps will be directly inherited from input timestamps, the actual values will be converted from input timescale to RTP stream timescale and wrap around will be applied. Default value is false, i.e. original timestamps are re-based to internal values.

public bool KeepOriginalTimestamps { get; set; }

Property Value

bool

OutputRtspWrapTs

Gets or sets whether to wrap RTSP output into a single TS payload. Default value is false, i.e. no extra TS wrapping.

public bool OutputRtspWrapTs { get; set; }

Property Value

bool

RtspEndPoint

Gets or sets local address and port to listen to RTSP protocol on

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

Property Value

IPEndPoint

RtspEndPoints

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

public List<IPEndPoint> RtspEndPoints { get; }

Property Value

List<IPEndPoint>

Remarks

By default, the list is empty and must be initialized by user.

RtspsEndPoint

Gets or sets local address and port to listen to RTSPS protocol on

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

Property Value

IPEndPoint

RtspsEndPoints

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

public List<IPEndPoint> RtspsEndPoints { get; }

Property Value

List<IPEndPoint>

Remarks

By default, the list is empty and must be initialized by user.

SendOptionsToClient

Gets or sets whether to send OPTIONS request to a connected client to determine supported client options. Default value is true, i.e. send request. Should be set to false if clients disconnect from the server unexpectedly.

public bool SendOptionsToClient { get; set; }

Property Value

bool

Methods

Clone()

Creates a deep copy of the current RtspServerParameters instance.

public RtspServerParameters Clone()

Returns

RtspServerParameters

A new RtspServerParameters instance with the same values.

Equals(RtspServerParameters)

Determines whether the specified RtspServerParameters instance is equal to the current instance.

public bool Equals(RtspServerParameters obj)

Parameters

obj RtspServerParameters

The RtspServerParameters instance to compare with.

Returns

bool

true if all parameter values match; otherwise, false.