fm.liveswitch.SRControlFrame Class Reference

A sender report control frame. More...

Public Member Functions

long getNtpTimestamp ()
 Gets the time when this report was sent (NTP-style). More...
 
long getOctetCount ()
 Gets the sender's octet count. More...
 
long getPacketCount ()
 Gets the sender's packet count. More...
 
long getRtpTimestamp ()
 Gets the time when this report was sent (RTP-style). More...
 
void setNtpTimestamp (long value)
 Sets the time when this report was sent (NTP-style). More...
 
void setOctetCount (long value)
 Sets the sender's octet count. More...
 
void setPacketCount (long value)
 Sets the sender's packet count. More...
 
void setRtpTimestamp (long value)
 Sets the time when this report was sent (RTP-style). More...
 
 SRControlFrame ()
 Initializes a new instance of the fm.liveswitch.SRControlFrame class. More...
 
 SRControlFrame (fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.SRControlFrame class. More...
 
 SRControlFrame (fm.liveswitch.ReportBlock reportBlock)
 Initializes a new instance of the fm.liveswitch.SRControlFrame class. More...
 
 SRControlFrame (fm.liveswitch.ReportBlock[] reportBlocks)
 Initializes a new instance of the fm.liveswitch.SRControlFrame class. More...
 
 SRControlFrame (long synchronizationSource, long ntpTimestamp, long rtpTimestamp, long packetCount, long octetCount)
 Initializes a new instance of the fm.liveswitch.SRControlFrame class. More...
 
 SRControlFrame (long synchronizationSource, long ntpTimestamp, long rtpTimestamp, long packetCount, long octetCount, fm.liveswitch.ReportBlock reportBlock)
 Initializes a new instance of the fm.liveswitch.SRControlFrame class. More...
 
 SRControlFrame (long synchronizationSource, long ntpTimestamp, long rtpTimestamp, long packetCount, long octetCount, fm.liveswitch.ReportBlock[] reportBlocks)
 Initializes a new instance of the fm.liveswitch.SRControlFrame class. More...
 
- Public Member Functions inherited from fm.liveswitch.ReportControlFrame
int getReceptionReportCount ()
 Gets the feedback message type. More...
 
fm.liveswitch.ReportBlock getReportBlock ()
 Gets the report block. More...
 
fm.liveswitch.ReportBlock getReportBlock (long synchronizationSource)
 Gets the report block. More...
 
fm.liveswitch.ReportBlock[] getReportBlocks ()
 Gets the report blocks. More...
 
long getSynchronizationSource ()
 Gets the synchronization source. More...
 
 ReportControlFrame (int payloadType, fm.liveswitch.ReportBlock reportBlock)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
 ReportControlFrame (int payloadType, fm.liveswitch.ReportBlock reportBlock, int reportBlockOffset)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
 ReportControlFrame (int payloadType, int reportBlockOffset, fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
 ReportControlFrame (int payloadType, fm.liveswitch.ReportBlock[] reportBlocks)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
 ReportControlFrame (int payloadType, fm.liveswitch.ReportBlock[] reportBlocks, int reportBlockOffset)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
 ReportControlFrame (int payloadType, long synchronizationSource, fm.liveswitch.ReportBlock reportBlock)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
 ReportControlFrame (int payloadType, long synchronizationSource, fm.liveswitch.ReportBlock reportBlock, int reportBlockOffset)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
 ReportControlFrame (int payloadType, long synchronizationSource, fm.liveswitch.ReportBlock[] reportBlocks)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
 ReportControlFrame (int payloadType, long synchronizationSource, fm.liveswitch.ReportBlock[] reportBlocks, int reportBlockOffset)
 Initializes a new instance of the fm.liveswitch.ReportControlFrame class. More...
 
void setReportBlock (fm.liveswitch.ReportBlock value)
 Sets the report block. More...
 
void setReportBlocks (fm.liveswitch.ReportBlock[] value)
 Sets the report blocks. More...
 
void setSynchronizationSource (long value)
 Sets the synchronization source. 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 getFixedSenderInfoPayloadLength ()
 Gets the fixed payload header length of a Sender Report. More...
 
static int getRegisteredPayloadType ()
 Gets the sender report payload type. More...
 
static int getReportBlockOffset ()
 Gets the report block offset. More...
 
- Static Public Member Functions inherited from fm.liveswitch.ReportControlFrame
static int getFixedPayloadHeaderLength ()
 Gets the report control frame fixed payload header length. 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

A sender report control frame.

Constructor & Destructor Documentation

◆ SRControlFrame() [1/7]

fm.liveswitch.SRControlFrame.SRControlFrame ( )

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

◆ SRControlFrame() [2/7]

fm.liveswitch.SRControlFrame.SRControlFrame ( fm.liveswitch.DataBuffer  buffer)

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

Parameters
bufferThe data buffer.

◆ SRControlFrame() [3/7]

fm.liveswitch.SRControlFrame.SRControlFrame ( fm.liveswitch.ReportBlock  reportBlock)

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

Parameters
reportBlockThe report block.

◆ SRControlFrame() [4/7]

fm.liveswitch.SRControlFrame.SRControlFrame ( fm.liveswitch.ReportBlock[]  reportBlocks)

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

Parameters
reportBlocksThe report blocks.

◆ SRControlFrame() [5/7]

fm.liveswitch.SRControlFrame.SRControlFrame ( long  synchronizationSource,
long  ntpTimestamp,
long  rtpTimestamp,
long  packetCount,
long  octetCount 
)

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

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.

◆ SRControlFrame() [6/7]

fm.liveswitch.SRControlFrame.SRControlFrame ( long  synchronizationSource,
long  ntpTimestamp,
long  rtpTimestamp,
long  packetCount,
long  octetCount,
fm.liveswitch.ReportBlock  reportBlock 
)

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

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.
reportBlockThe report block.

◆ SRControlFrame() [7/7]

fm.liveswitch.SRControlFrame.SRControlFrame ( long  synchronizationSource,
long  ntpTimestamp,
long  rtpTimestamp,
long  packetCount,
long  octetCount,
fm.liveswitch.ReportBlock[]  reportBlocks 
)

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

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.
reportBlocksThe report blocks.

Member Function Documentation

◆ getFixedSenderInfoPayloadLength()

static int fm.liveswitch.SRControlFrame.getFixedSenderInfoPayloadLength ( )
static

Gets the fixed payload header length of a Sender Report.

◆ getNtpTimestamp()

long fm.liveswitch.SRControlFrame.getNtpTimestamp ( )

Gets the time when this report was sent (NTP-style).

◆ getOctetCount()

long fm.liveswitch.SRControlFrame.getOctetCount ( )

Gets the sender's octet count.

◆ getPacketCount()

long fm.liveswitch.SRControlFrame.getPacketCount ( )

Gets the sender's packet count.

◆ getRegisteredPayloadType()

static int fm.liveswitch.SRControlFrame.getRegisteredPayloadType ( )
static

Gets the sender report payload type.

◆ getReportBlockOffset()

static int fm.liveswitch.SRControlFrame.getReportBlockOffset ( )
static

Gets the report block offset.

◆ getRtpTimestamp()

long fm.liveswitch.SRControlFrame.getRtpTimestamp ( )

Gets the time when this report was sent (RTP-style).

◆ setNtpTimestamp()

void fm.liveswitch.SRControlFrame.setNtpTimestamp ( long  value)

Sets the time when this report was sent (NTP-style).

◆ setOctetCount()

void fm.liveswitch.SRControlFrame.setOctetCount ( long  value)

Sets the sender's octet count.

◆ setPacketCount()

void fm.liveswitch.SRControlFrame.setPacketCount ( long  value)

Sets the sender's packet count.

◆ setRtpTimestamp()

void fm.liveswitch.SRControlFrame.setRtpTimestamp ( long  value)

Sets the time when this report was sent (RTP-style).