Class RttReceiver

This class handles Real Time Protocol (RTP) packets containing Real Time Text (RTT, RFC 4103) and notifies the user of this class when complete messages are available. A complete message may be one character or several characters.

This class handles RTT redundancy as specified in Section 4.2 of RFC 4103 and is capable of recovering the original message even if there are dropped RTP packets.

This class supports receiving characters from a mixer-aware remote endpoint as described in RFC 9071 RTP-Mixer Formatting of Multiparty Real-Time Text.

See Using the RTT Receiver Class

Inheritance

object

RttReceiver

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 RttReceiver

Constructors

RttReceiver(RttParameters)

Constructor. This constructor is for testing only. Use the constructor that takes a RtpChannel parameter for actual application.

Declaration

public RttReceiver(RttParameters rttParams)

Parameters

Type	Name	Description
RttParameters	rttParams	RTT session parameters from the SDP media description block.

RttReceiver(RttParameters, RtpChannel, string)

Constructor.

Declaration

public RttReceiver(RttParameters rttParams, RtpChannel rtpChannel, string source)

Parameters

Type	Name	Description
RttParameters	rttParams	RTT session parameters from the SDP media description block.
RtpChannel	rtpChannel	RtpChannel for RTT that this object will receive RTP packets from
string	source	Identifies the remote source that will be sending characters

Properties

Ssrc

The SSRC or CSRC of the source of the most recent characters. Taken from the RTP packet.

Declaration

public uint Ssrc { get; }

Property Value

Type	Description
uint

Methods

ProcessRtpPacket(RtpPacket)

Processes an RTP packet containing RTT media. This method fires the RttCharactersReceived event when characters are detected.

Note: Applications will not normally call this method. Its scope is public for the purpose of unit testing.

Declaration

public void ProcessRtpPacket(RtpPacket rtpPacket)

Parameters

Type	Name	Description
RtpPacket	rtpPacket	Input RTP packet to process.

Events

RttCharactersReceived

Event that is fired when at least one character is received

Declaration

public event RttCharactersReceivedDelegate? RttCharactersReceived

Event Type

Type	Description
RttCharactersReceivedDelegate