fm.liveswitch.AppControlFrame Class Reference

An RTCP APP packet. More...

Public Member Functions

 AppControlFrame ()
 Initializes a new instance of the fm.liveswitch.AppControlFrame class. More...
 
 AppControlFrame (fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.AppControlFrame class. More...
 
 AppControlFrame (int subType, long synchronizationSource, String name, fm.liveswitch.DataBuffer data)
 Initializes a new instance of the fm.liveswitch.AppControlFrame class. More...
 
fm.liveswitch.DataBuffer getData ()
 Gets optional application-dependent data. More...
 
int getDataLength ()
 Gets the length of the fm.liveswitch.AppControlFrame#getData. More...
 
int getDataPayloadOffset ()
 Gets the offset of the fm.liveswitch.AppControlFrame#getData in the payload. More...
 
String getName ()
 Gets the name. More...
 
int getSubType ()
 Gets the subtype to allow a set of APP packets to be defined under one unique name, or for any application-dependent data. More...
 
long getSynchronizationSource ()
 Gets the synchronization source. More...
 
void setName (String value)
 Sets the name. More...
 
void setSubType (int value)
 Sets the subtype to allow a set of APP packets to be defined under one unique name, or for any application-dependent data. 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 length of the fixed payload header. More...
 
static int getRegisteredPayloadType ()
 Gets the application-specific payload type. 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 APP packet.

Constructor & Destructor Documentation

◆ AppControlFrame() [1/3]

fm.liveswitch.AppControlFrame.AppControlFrame ( )

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

◆ AppControlFrame() [2/3]

fm.liveswitch.AppControlFrame.AppControlFrame ( fm.liveswitch.DataBuffer  buffer)

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

Parameters
bufferThe buffer.

◆ AppControlFrame() [3/3]

fm.liveswitch.AppControlFrame.AppControlFrame ( int  subType,
long  synchronizationSource,
String  name,
fm.liveswitch.DataBuffer  data 
)

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

Parameters
subTypeType of the sub.
synchronizationSourceThe SSRC.
nameThe name.
dataThe data.

Member Function Documentation

◆ getData()

fm.liveswitch.DataBuffer fm.liveswitch.AppControlFrame.getData ( )

Gets optional application-dependent data.

◆ getDataLength()

int fm.liveswitch.AppControlFrame.getDataLength ( )

Gets the length of the fm.liveswitch.AppControlFrame#getData.

◆ getDataPayloadOffset()

int fm.liveswitch.AppControlFrame.getDataPayloadOffset ( )

Gets the offset of the fm.liveswitch.AppControlFrame#getData in the payload.

◆ getFixedPayloadHeaderLength()

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

Gets the length of the fixed payload header.

◆ getName()

String fm.liveswitch.AppControlFrame.getName ( )

Gets the name.

◆ getRegisteredPayloadType()

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

Gets the application-specific payload type.

◆ getSubType()

int fm.liveswitch.AppControlFrame.getSubType ( )

Gets the subtype to allow a set of APP packets to be defined under one unique name, or for any application-dependent data.

◆ getSynchronizationSource()

long fm.liveswitch.AppControlFrame.getSynchronizationSource ( )

Gets the synchronization source.

◆ setName()

void fm.liveswitch.AppControlFrame.setName ( String  value)

Sets the name.

◆ setSubType()

void fm.liveswitch.AppControlFrame.setSubType ( int  value)

Sets the subtype to allow a set of APP packets to be defined under one unique name, or for any application-dependent data.

◆ setSynchronizationSource()

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

Sets the synchronization source.