fm.liveswitch.ByeControlFrame Class Reference

An RTCP BYE packet. More...

Public Member Functions

 ByeControlFrame ()
 Initializes a new instance of the fm.liveswitch.ByeControlFrame class. More...
 
 ByeControlFrame (fm.liveswitch.DataBuffer buffer)
 Initializes a new instance of the fm.liveswitch.ByeControlFrame class. More...
 
 ByeControlFrame (long synchronizationSource)
 Initializes a new instance of the fm.liveswitch.ByeControlFrame class. More...
 
 ByeControlFrame (long synchronizationSource, String reasonForLeaving)
 Initializes a new instance of the fm.liveswitch.ByeControlFrame class. More...
 
 ByeControlFrame (long[] synchronizationSources)
 Initializes a new instance of the fm.liveswitch.ByeControlFrame class. More...
 
 ByeControlFrame (long[] synchronizationSources, long[] contributingSources)
 Initializes a new instance of the fm.liveswitch.ByeControlFrame class. More...
 
 ByeControlFrame (long[] synchronizationSources, long[] contributingSources, String reasonForLeaving)
 Initializes a new instance of the fm.liveswitch.ByeControlFrame class. More...
 
 ByeControlFrame (long[] synchronizationSources, String reasonForLeaving)
 Initializes a new instance of the fm.liveswitch.ByeControlFrame class. More...
 
boolean getReason ()
 Gets a value indicating whether this instance has a reason for leaving. More...
 
String getReasonForLeaving ()
 Gets the reason for leaving as a string. More...
 
int getReasonForLeavingLength ()
 Gets the length of the reason for leaving. More...
 
int getReasonForLeavingOffset ()
 Gets the offset of the fm.liveswitch.ByeControlFrame#getReasonForLeaving in the payload. More...
 
fm.liveswitch.DataBuffer getReasonForLeavingPayload ()
 Gets the reason for leaving. More...
 
int getSourceCount ()
 Gets the number of fm.liveswitch.ByeControlFrame#getSources. More...
 
long[] getSources ()
 Gets the synchronization and contributing sources. More...
 
int getSourcesLength ()
 Gets the length of the fm.liveswitch.ByeControlFrame#getSources in bytes. More...
 
int getSourcesPayloadOffset ()
 Gets the offset of the fm.liveswitch.ByeControlFrame#getSources array in the payload. More...
 
void setSources (long[] value)
 Sets the synchronization and contributing sources. 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 getFixedReasonForLeavingPayloadHeaderLength ()
 Gets the length of the fixed reason for leaving header. More...
 
static int getRegisteredPayloadType ()
 Gets the goodbye 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 BYE packet.

Constructor & Destructor Documentation

◆ ByeControlFrame() [1/8]

fm.liveswitch.ByeControlFrame.ByeControlFrame ( )

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

◆ ByeControlFrame() [2/8]

fm.liveswitch.ByeControlFrame.ByeControlFrame ( fm.liveswitch.DataBuffer  buffer)

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

Parameters
bufferThe packet.

◆ ByeControlFrame() [3/8]

fm.liveswitch.ByeControlFrame.ByeControlFrame ( long  synchronizationSource)

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

Parameters
synchronizationSourceThe synchronization source.

◆ ByeControlFrame() [4/8]

fm.liveswitch.ByeControlFrame.ByeControlFrame ( long  synchronizationSource,
String  reasonForLeaving 
)

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

Parameters
synchronizationSourceThe synchronization source.
reasonForLeavingThe reason for leaving.

◆ ByeControlFrame() [5/8]

fm.liveswitch.ByeControlFrame.ByeControlFrame ( long[]  synchronizationSources)

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

Parameters
synchronizationSourcesThe synchronization sources.

◆ ByeControlFrame() [6/8]

fm.liveswitch.ByeControlFrame.ByeControlFrame ( long[]  synchronizationSources,
long[]  contributingSources 
)

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

Parameters
synchronizationSourcesThe synchronization sources.
contributingSourcesThe contributing sources.

◆ ByeControlFrame() [7/8]

fm.liveswitch.ByeControlFrame.ByeControlFrame ( long[]  synchronizationSources,
long[]  contributingSources,
String  reasonForLeaving 
)

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

Parameters
synchronizationSourcesThe synchronization sources.
contributingSourcesThe contributing sources.
reasonForLeavingThe reason for leaving.

◆ ByeControlFrame() [8/8]

fm.liveswitch.ByeControlFrame.ByeControlFrame ( long[]  synchronizationSources,
String  reasonForLeaving 
)

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

Parameters
synchronizationSourcesThe synchronization sources.
reasonForLeavingThe reason for leaving.

Member Function Documentation

◆ getFixedPayloadHeaderLength()

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

Gets the length of the fixed payload header.

◆ getFixedReasonForLeavingPayloadHeaderLength()

static int fm.liveswitch.ByeControlFrame.getFixedReasonForLeavingPayloadHeaderLength ( )
static

Gets the length of the fixed reason for leaving header.

◆ getReason()

boolean fm.liveswitch.ByeControlFrame.getReason ( )

Gets a value indicating whether this instance has a reason for leaving.

◆ getReasonForLeaving()

String fm.liveswitch.ByeControlFrame.getReasonForLeaving ( )

Gets the reason for leaving as a string.

◆ getReasonForLeavingLength()

int fm.liveswitch.ByeControlFrame.getReasonForLeavingLength ( )

Gets the length of the reason for leaving.

◆ getReasonForLeavingOffset()

int fm.liveswitch.ByeControlFrame.getReasonForLeavingOffset ( )

Gets the offset of the fm.liveswitch.ByeControlFrame#getReasonForLeaving in the payload.

◆ getReasonForLeavingPayload()

fm.liveswitch.DataBuffer fm.liveswitch.ByeControlFrame.getReasonForLeavingPayload ( )

Gets the reason for leaving.

◆ getRegisteredPayloadType()

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

Gets the goodbye payload type.

◆ getSourceCount()

int fm.liveswitch.ByeControlFrame.getSourceCount ( )

◆ getSources()

long [] fm.liveswitch.ByeControlFrame.getSources ( )

Gets the synchronization and contributing sources.

◆ getSourcesLength()

int fm.liveswitch.ByeControlFrame.getSourcesLength ( )

Gets the length of the fm.liveswitch.ByeControlFrame#getSources in bytes.

◆ getSourcesPayloadOffset()

int fm.liveswitch.ByeControlFrame.getSourcesPayloadOffset ( )

Gets the offset of the fm.liveswitch.ByeControlFrame#getSources array in the payload.

◆ setSources()

void fm.liveswitch.ByeControlFrame.setSources ( long[]  value)

Sets the synchronization and contributing sources.