fm.liveswitch.TmmbnControlFrame Class Reference

An RTCP temporary maximum media-stream bitrate notification (TMMBN) packet. More...

Public Member Functions

fm.liveswitch.TmmbnEntry[] getEntries ()
 Gets the entries. More...
 
fm.liveswitch.TmmbnEntry getEntry ()
 Gets the entry. More...
 
void setEntries (fm.liveswitch.TmmbnEntry[] value)
 Sets the entries. More...
 
void setEntry (fm.liveswitch.TmmbnEntry value)
 Sets the entry. More...
 
 TmmbnControlFrame (fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.TmmbnControlFrame class. More...
 
 TmmbnControlFrame (fm.liveswitch.TmmbnEntry[] entries)
 Initializes a new instance of the fm.liveswitch.TmmbnControlFrame class. More...
 
 TmmbnControlFrame (fm.liveswitch.TmmbnEntry entry)
 Initializes a new instance of the fm.liveswitch.TmmbnControlFrame class. More...
 
 TmmbnControlFrame (long maximumBitrate, long synchronizationSource)
 Initializes a new instance of the fm.liveswitch.TmmbnControlFrame 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 registered feedback message. More...
 
static fm.liveswitch.TmmbnControlFrame normalized (int normalizedMaximumBitrate, long synchronizationSource)
 Creates a fm.liveswitch.TmmbnControlFrame using normalized parameters. More...
 
static fm.liveswitch.TmmbnControlFrame normalized (int normalizedMaximumBitrate, long synchronizationSource, long packetSenderSynchronizationSource)
 Creates a fm.liveswitch.TmmbnControlFrame using normalized parameters. 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 temporary maximum media-stream bitrate notification (TMMBN) packet.

Constructor & Destructor Documentation

◆ TmmbnControlFrame() [1/4]

fm.liveswitch.TmmbnControlFrame.TmmbnControlFrame ( fm.liveswitch.DataBuffer  buffer)

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

Parameters
bufferThe buffer.

◆ TmmbnControlFrame() [2/4]

fm.liveswitch.TmmbnControlFrame.TmmbnControlFrame ( fm.liveswitch.TmmbnEntry[]  entries)

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

Parameters
entriesThe entries.

◆ TmmbnControlFrame() [3/4]

fm.liveswitch.TmmbnControlFrame.TmmbnControlFrame ( fm.liveswitch.TmmbnEntry  entry)

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

Parameters
entryThe entry.

◆ TmmbnControlFrame() [4/4]

fm.liveswitch.TmmbnControlFrame.TmmbnControlFrame ( long  maximumBitrate,
long  synchronizationSource 
)

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

Parameters
maximumBitrateThe maximum bitrate.
synchronizationSourceThe synchronization source.

Member Function Documentation

◆ getEntries()

fm.liveswitch.TmmbnEntry [] fm.liveswitch.TmmbnControlFrame.getEntries ( )

Gets the entries.

◆ getEntry()

fm.liveswitch.TmmbnEntry fm.liveswitch.TmmbnControlFrame.getEntry ( )

Gets the entry.

◆ getRegisteredFeedbackMessageType()

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

Gets the type of the registered feedback message.

◆ normalized() [1/2]

static fm.liveswitch.TmmbnControlFrame fm.liveswitch.TmmbnControlFrame.normalized ( int  normalizedMaximumBitrate,
long  synchronizationSource 
)
static

Creates a fm.liveswitch.TmmbnControlFrame using normalized parameters.

Parameters
normalizedMaximumBitrateThe normalized maximum bitrate.
synchronizationSourceThe synchronization source.

◆ normalized() [2/2]

static fm.liveswitch.TmmbnControlFrame fm.liveswitch.TmmbnControlFrame.normalized ( int  normalizedMaximumBitrate,
long  synchronizationSource,
long  packetSenderSynchronizationSource 
)
static

Creates a fm.liveswitch.TmmbnControlFrame using normalized parameters.

Parameters
normalizedMaximumBitrateThe normalized maximum bitrate.
synchronizationSourceThe synchronization source.
packetSenderSynchronizationSourceThe packet sender synchronization source.

◆ setEntries()

void fm.liveswitch.TmmbnControlFrame.setEntries ( fm.liveswitch.TmmbnEntry[]  value)

Sets the entries.

◆ setEntry()

void fm.liveswitch.TmmbnControlFrame.setEntry ( fm.liveswitch.TmmbnEntry  value)

Sets the entry.