Class RttParameters

Holds the RTT protocol parameters for a RTT session

Inheritance

object

RttParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SipLib.RealTimeText

Assembly: SipLib.dll

Syntax

public class RttParameters

Constructors

RttParameters()

Constructor

Declaration

public RttParameters()

Fields

Cps

Specifies the maximum number of characters per second that may be sent. A value of 0 indicates that the data rate is not limited.

Declaration

public int Cps

Field Value

Type	Description
int

RedundancyLevel

Specifies the number of redundancy levels. A value of 0 specifies that redundancy is not being used.

Declaration

public int RedundancyLevel

Field Value

Type	Description
int

RedundancyPayloadType

Specifies the redundant packet payload type in the RTP packets. A value of 0 indicates that redundancy is not being used.

Declaration

public int RedundancyPayloadType

Field Value

Type	Description
int

RttMixerAware

If true then the UA of the RTT RTP channel is RTT mixer aware as specified in RFC 9071.

Declaration

public bool RttMixerAware

Field Value

Type	Description
bool

T140PayloadType

Specifies the t140 payload type in the RTP packets.

Declaration

public int T140PayloadType

Field Value

Type	Description
int

Methods

FromMediaDescription(MediaDescription)

Parses an SDP media description object and creates an RttParameters object.

Declaration

public static RttParameters? FromMediaDescription(MediaDescription mediaDescription)

Parameters

Type	Name	Description
MediaDescription	mediaDescription	Input SDP media description. The media type must be "text" for RTT.

Returns

Type	Description
RttParameters	Returns a new RttParameters object. Returns null if a parsing error occurred.

ToMediaDescription(int)

Creates an SDP media description object from this RttParameters object.

Declaration

public MediaDescription ToMediaDescription(int Port)

Parameters

Type	Name	Description
int	Port	UDP port number to use.

Returns

Type	Description
MediaDescription	Returns a new SDP MediaDescription object.