fm.liveswitch.TransportCCControlFrame Class Reference

An RTCP transport-wide congestion control (transport-cc) packet. More...

Public Member Functions

int getBaseSequenceNumber ()
 Gets the base sequence number. More...
 
int getFeedbackPacketCount ()
 Gets the feedback packet count. More...
 
fm.liveswitch.TransportCCPacketStatusChunk[] getPacketStatusChunks ()
 Gets the packet status chunks. More...
 
int getPacketStatusCount ()
 Gets the packet status count. More...
 
int[] getReceiveDeltas ()
 Gets the receive deltas. More...
 
double[] getReceiveDeltasInMillis ()
 Gets the receive deltas in milliseconds. More...
 
int[] getReceiveDeltasInTicks ()
 Gets the receive deltas in ticks. More...
 
int getReferenceTime ()
 Gets the reference time. More...
 
int getReferenceTimeInMillis ()
 Gets the reference time in milliseconds. More...
 
int getReferenceTimeInTicks ()
 Gets the reference time in ticks. More...
 
String toString ()
 Returns a string representation of this instance. More...
 
 TransportCCControlFrame (int baseSequenceNumber, int packetStatusCount, int referenceTime, int feedbackPacketCount, fm.liveswitch.TransportCCPacketStatusChunk[] packetStatusChunks, int[] receiveDeltas)
 Initializes a new instance of the fm.liveswitch.TransportCCControlFrame class. More...
 
 TransportCCControlFrame (fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.TransportCCControlFrame class. More...
 
- Public Member Functions inherited from fm.liveswitch.RtpControlFrame
 RtpControlFrame (int feedbackMessageType)
 Initializes a new instance of the fm.liveswitch.RtpControlFrame class. More...
 
 RtpControlFrame (int feedbackMessageType, fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.RtpControlFrame class. More...
 
 RtpControlFrame (int feedbackMessageType, int payloadType, long senderSynchronizationSource, long mediaSynchronizationSource)
 Initializes a new instance of the fm.liveswitch.RtpControlFrame class. More...
 
 RtpControlFrame (int feedbackMessageType, int payloadType, long senderSynchronizationSource, long mediaSynchronizationSource, fm.liveswitch.DataBuffer feedbackControlInformation)
 Initializes a new instance of the fm.liveswitch.RtpControlFrame class. More...
 
- Public Member Functions inherited from fm.liveswitch.FeedbackControlFrame
 FeedbackControlFrame (int feedbackMessageType, int payloadType)
 Initializes a new instance of the fm.liveswitch.FeedbackControlFrame class. More...
 
 FeedbackControlFrame (int feedbackMessageType, int payloadType, fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.FeedbackControlFrame class. More...
 
 FeedbackControlFrame (int feedbackMessageType, int payloadType, long senderSynchronizationSource, long mediaSynchronizationSource)
 Initializes a new instance of the fm.liveswitch.FeedbackControlFrame class. More...
 
 FeedbackControlFrame (int feedbackMessageType, int payloadType, long senderSynchronizationSource, long mediaSynchronizationSource, fm.liveswitch.DataBuffer feedbackControlInformation)
 Initializes a new instance of the fm.liveswitch.FeedbackControlFrame class. More...
 
fm.liveswitch.DataBuffer getFeedbackControlInformation ()
 Gets the Feedback Control Information field. More...
 
int getFeedbackControlInformationOffset ()
 Gets the feedback control information offset. More...
 
int getFeedbackMessageType ()
 Gets the feedback message type. More...
 
long getMediaSourceSynchronizationSource ()
 Gets the SSRC of the media source that this piece of feedback information is related to. More...
 
long getPacketSenderSynchronizationSource ()
 Gets the SSRC of the packet sender - the synchronization source identifier for the originator of this packet. More...
 
void setFeedbackMessageType (int value)
 Sets the feedback message type. More...
 
void setMediaSourceSynchronizationSource (long value)
 Sets the SSRC of the media source that this piece of feedback information is related to. More...
 
void setPacketSenderSynchronizationSource (long value)
 Sets the SSRC of the packet sender - the synchronization source identifier for the originator of this packet. More...
 
- Public Member Functions inherited from fm.liveswitch.MediaControlFrame
int getByte1Last5Bits ()
 Gets the last 5 bits of the first byte. More...
 
fm.liveswitch.DataBuffer getDataBuffer ()
 Gets the buffer. More...
 
fm.liveswitch.DataBuffer getPayload ()
 Gets the payload. More...
 
int getPayloadLengthWithPadding ()
 Gets the length of the payload, in bytes, with padding. More...
 
int getPayloadType ()
 Gets the payload type. More...
 
String getStreamId ()
 Gets the stream ID. More...
 
int getVersion ()
 Gets the version. More...
 
 MediaControlFrame ()
 Initializes a new instance of the fm.liveswitch.MediaControlFrame class. More...
 
 MediaControlFrame (fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.MediaControlFrame class. More...
 
void setByte1Last5Bits (int value)
 Sets the last 5 bits of the first byte. More...
 
void setPayloadType (int value)
 Sets the payload type. More...
 
void setVersion (int value)
 Sets the version. More...
 
- Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object > getDynamicProperties ()
 Gets all dynamic properties on this instance. More...
 
Object getDynamicValue (String key)
 Gets a property value from the local cache. More...
 
void setDynamicValue (String key, Object value)
 Sets a property value in the local cache. More...
 
boolean unsetDynamicValue (String key)
 Removes a property value from the local cache. More...
 

Static Public Member Functions

static int getRegisteredFeedbackMessageType ()
 Gets the type of the transport-wide congestion control message. More...
 
static double receiveDeltaInMillis (int receiveDelta)
 Gets a receive delta in milliseconds. More...
 
static int receiveDeltaInTicks (int receiveDelta)
 Gets a receive delta in ticks. More...
 
- Static Public Member Functions inherited from fm.liveswitch.RtpControlFrame
static int getRegisteredPayloadType ()
 Gets the RTP payload type. More...
 
- Static Public Member Functions inherited from fm.liveswitch.FeedbackControlFrame
static int getFixedPayloadHeaderLength ()
 Gets the fixed payload header length of a Feedback Control packet. More...
 
- Static Public Member Functions inherited from fm.liveswitch.MediaControlFrame
static fm.liveswitch.MediaControlFrame[] addControlFrame (fm.liveswitch.MediaControlFrame[] controlFrames, fm.liveswitch.MediaControlFrame addControlFrame, int index)
 Adds a control frame to an array. More...
 
static fm.liveswitch.MediaControlFrame[] addControlFrames (fm.liveswitch.MediaControlFrame[] controlFrames, fm.liveswitch.MediaControlFrame[] addControlFrames, int index)
 Adds control frames to an array. More...
 
static int getFixedHeaderLength ()
 Gets the length of the fixed header. More...
 
static fm.liveswitch.MediaControlFrame[] parse (fm.liveswitch.DataBuffer dataBuffer)
 Parses a data buffer into an array of control frames. More...
 
static fm.liveswitch.MediaControlFrame[] removeControlFrame (fm.liveswitch.MediaControlFrame[] controlFrames, int index)
 Removes a control frame from an array. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fm.liveswitch.MediaControlFrame
void setDataBuffer (fm.liveswitch.DataBuffer value)
 Sets the buffer. More...
 
void setPayloadLengthWithPadding (int value)
 Sets the length of the payload, in bytes, with padding. More...
 
- Protected Member Functions inherited from fm.liveswitch.Dynamic
 Dynamic ()
 
- Protected Member Functions inherited from fm.liveswitch.Serializable
boolean getIsDirty ()
 Gets a value indicating whether this instance is dirty. More...
 
 Serializable ()
 Initializes a new instance of the fm.liveswitch.Serializable class. More...
 
void setIsDirty (boolean value)
 Sets a value indicating whether this instance is dirty. More...
 

Detailed Description

An RTCP transport-wide congestion control (transport-cc) packet.

Constructor & Destructor Documentation

◆ TransportCCControlFrame() [1/2]

fm.liveswitch.TransportCCControlFrame.TransportCCControlFrame ( int  baseSequenceNumber,
int  packetStatusCount,
int  referenceTime,
int  feedbackPacketCount,
fm.liveswitch.TransportCCPacketStatusChunk[]  packetStatusChunks,
int[]  receiveDeltas 
)

Initializes a new instance of the fm.liveswitch.TransportCCControlFrame class.

◆ TransportCCControlFrame() [2/2]

fm.liveswitch.TransportCCControlFrame.TransportCCControlFrame ( fm.liveswitch.DataBuffer  buffer)

Initializes a new instance of the fm.liveswitch.TransportCCControlFrame class.

Parameters
bufferThe buffer.

Member Function Documentation

◆ getBaseSequenceNumber()

int fm.liveswitch.TransportCCControlFrame.getBaseSequenceNumber ( )

Gets the base sequence number.

◆ getFeedbackPacketCount()

int fm.liveswitch.TransportCCControlFrame.getFeedbackPacketCount ( )

Gets the feedback packet count.

◆ getPacketStatusChunks()

fm.liveswitch.TransportCCPacketStatusChunk [] fm.liveswitch.TransportCCControlFrame.getPacketStatusChunks ( )

Gets the packet status chunks.

◆ getPacketStatusCount()

int fm.liveswitch.TransportCCControlFrame.getPacketStatusCount ( )

Gets the packet status count.

◆ getReceiveDeltas()

int [] fm.liveswitch.TransportCCControlFrame.getReceiveDeltas ( )

Gets the receive deltas.

◆ getReceiveDeltasInMillis()

double [] fm.liveswitch.TransportCCControlFrame.getReceiveDeltasInMillis ( )

Gets the receive deltas in milliseconds.

◆ getReceiveDeltasInTicks()

int [] fm.liveswitch.TransportCCControlFrame.getReceiveDeltasInTicks ( )

Gets the receive deltas in ticks.

◆ getReferenceTime()

int fm.liveswitch.TransportCCControlFrame.getReferenceTime ( )

Gets the reference time.

◆ getReferenceTimeInMillis()

int fm.liveswitch.TransportCCControlFrame.getReferenceTimeInMillis ( )

Gets the reference time in milliseconds.

◆ getReferenceTimeInTicks()

int fm.liveswitch.TransportCCControlFrame.getReferenceTimeInTicks ( )

Gets the reference time in ticks.

◆ getRegisteredFeedbackMessageType()

static int fm.liveswitch.TransportCCControlFrame.getRegisteredFeedbackMessageType ( )
static

Gets the type of the transport-wide congestion control message.

◆ receiveDeltaInMillis()

static double fm.liveswitch.TransportCCControlFrame.receiveDeltaInMillis ( int  receiveDelta)
static

Gets a receive delta in milliseconds.

Parameters
receiveDeltaThe receive delta.
Returns
The receive delta in milliseconds.

◆ receiveDeltaInTicks()

static int fm.liveswitch.TransportCCControlFrame.receiveDeltaInTicks ( int  receiveDelta)
static

Gets a receive delta in ticks.

Parameters
receiveDeltaThe receive delta.
Returns
The receive delta in ticks.

◆ toString()

String fm.liveswitch.TransportCCControlFrame.toString ( )

Returns a string representation of this instance.