fm.liveswitch.ReportControlFrame Class Referenceabstract

An RTCP Sender or Receiver Report control frame. More...

Public Member Functions

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 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

An RTCP Sender or Receiver Report control frame.

Constructor & Destructor Documentation

◆ ReportControlFrame() [1/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
fm.liveswitch.ReportBlock  reportBlock 
)

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

Parameters
payloadTypeType of the payload.
reportBlockThe report block.

◆ ReportControlFrame() [2/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
fm.liveswitch.ReportBlock  reportBlock,
int  reportBlockOffset 
)

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

Parameters
payloadTypeType of the payload.
reportBlockThe report block.
reportBlockOffsetThe report block offset.

◆ ReportControlFrame() [3/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
int  reportBlockOffset,
fm.liveswitch.DataBuffer  buffer 
)

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

Parameters
payloadTypeThe payload type.
reportBlockOffsetThe offset of the report block.
bufferThe backing data buffer.

◆ ReportControlFrame() [4/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
fm.liveswitch.ReportBlock[]  reportBlocks 
)

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

Parameters
payloadTypeType of the payload.
reportBlocksThe report blocks.

◆ ReportControlFrame() [5/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
fm.liveswitch.ReportBlock[]  reportBlocks,
int  reportBlockOffset 
)

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

Parameters
payloadTypeType of the payload.
reportBlocksThe report blocks.
reportBlockOffsetThe report block offset.

◆ ReportControlFrame() [6/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
long  synchronizationSource,
fm.liveswitch.ReportBlock  reportBlock 
)

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

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlockThe report block.

◆ ReportControlFrame() [7/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
long  synchronizationSource,
fm.liveswitch.ReportBlock  reportBlock,
int  reportBlockOffset 
)

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

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlockThe report block.
reportBlockOffsetThe report block offset.

◆ ReportControlFrame() [8/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
long  synchronizationSource,
fm.liveswitch.ReportBlock[]  reportBlocks 
)

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

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlocksThe report blocks.

◆ ReportControlFrame() [9/9]

fm.liveswitch.ReportControlFrame.ReportControlFrame ( int  payloadType,
long  synchronizationSource,
fm.liveswitch.ReportBlock[]  reportBlocks,
int  reportBlockOffset 
)

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

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlocksThe report blocks.
reportBlockOffsetThe report block offset.

Member Function Documentation

◆ getFixedPayloadHeaderLength()

static int fm.liveswitch.ReportControlFrame.getFixedPayloadHeaderLength ( )
static

Gets the report control frame fixed payload header length.

◆ getReceptionReportCount()

int fm.liveswitch.ReportControlFrame.getReceptionReportCount ( )

Gets the feedback message type.

◆ getReportBlock() [1/2]

fm.liveswitch.ReportBlock fm.liveswitch.ReportControlFrame.getReportBlock ( )

Gets the report block.

◆ getReportBlock() [2/2]

fm.liveswitch.ReportBlock fm.liveswitch.ReportControlFrame.getReportBlock ( long  synchronizationSource)

Gets the report block.

Parameters
synchronizationSourceThe synchronization source.

◆ getReportBlocks()

fm.liveswitch.ReportBlock [] fm.liveswitch.ReportControlFrame.getReportBlocks ( )

Gets the report blocks.

◆ getSynchronizationSource()

long fm.liveswitch.ReportControlFrame.getSynchronizationSource ( )

Gets the synchronization source.

◆ setReportBlock()

void fm.liveswitch.ReportControlFrame.setReportBlock ( fm.liveswitch.ReportBlock  value)

Sets the report block.

◆ setReportBlocks()

void fm.liveswitch.ReportControlFrame.setReportBlocks ( fm.liveswitch.ReportBlock[]  value)

Sets the report blocks.

◆ setSynchronizationSource()

void fm.liveswitch.ReportControlFrame.setSynchronizationSource ( long  value)

Sets the synchronization source.