An RTCP BYE packet. More...

Instance Methods
(instancetype)	- init
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(instancetype)	- initWithBuffer:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(instancetype)	- initWithSynchronizationSource:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(instancetype)	- initWithSynchronizationSource:reasonForLeaving:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(instancetype)	- initWithSynchronizationSources:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(instancetype)	- initWithSynchronizationSources:contributingSources:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(instancetype)	- initWithSynchronizationSources:contributingSources:reasonForLeaving:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(instancetype)	- initWithSynchronizationSources:reasonForLeaving:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(bool)	- reason
	Gets a value indicating whether this instance has a reason for leaving. More...

(NSString *)	- reasonForLeaving
	Gets the reason for leaving as a string. More...

(int)	- reasonForLeavingLength
	Gets the length of the reason for leaving. More...

(int)	- reasonForLeavingOffset
	Gets the offset of the reasonForLeaving in the payload. More...

(FMLiveSwitchDataBuffer *)	- reasonForLeavingPayload
	Gets the reason for leaving. More...

(void)	- setSources:
	Sets the synchronization and contributing sources. More...

(int)	- sourceCount
	Gets the number of sources. More...

(NSMutableArray *)	- sources
	Gets the synchronization and contributing sources. More...

(int)	- sourcesLength
	Gets the length of the sources in bytes. More...

(int)	- sourcesPayloadOffset
	Gets the offset of the sources array in the payload. More...

Instance Methods inherited from FMLiveSwitchMediaControlFrame
(int)	- byte1Last5Bits
	Gets the last 5 bits of the first byte. More...

(FMLiveSwitchDataBuffer *)	- dataBuffer
	Gets the buffer. More...

(FMLiveSwitchDataBuffer *)	- payload
	Gets the payload. More...

(int)	- payloadLengthWithPadding
	Gets the length of the payload, in bytes, with padding. More...

(int)	- payloadType
	Gets the payload type. More...

(void)	- setByte1Last5Bits:
	Sets the last 5 bits of the first byte. More...

(void)	- setDataBuffer:
	Sets the buffer. More...

(void)	- setPayloadLengthWithPadding:
	Sets the length of the payload, in bytes, with padding. More...

(void)	- setPayloadType:
	Sets the payload type. More...

(void)	- setVersion:
	Sets the version. More...

(NSString *)	- streamId
	Gets the stream ID. More...

(int)	- version
	Gets the version. More...

Instance Methods inherited from FMLiveSwitchDynamic
(NSMutableDictionary< NSString , id > )	- dynamicProperties
	Gets all dynamic properties on this instance. More...

(id)	- getDynamicValueWithKey:
	Gets a property value from the local cache. More...

(void)	- setDynamicValueWithKey:value:
	Sets a property value in the local cache. More...

(bool)	- unsetDynamicValueWithKey:
	Removes a property value from the local cache. More...

Class Methods
(FMLiveSwitchByeControlFrame *)	+ byeControlFrame
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(FMLiveSwitchByeControlFrame *)	+ byeControlFrameWithBuffer:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(FMLiveSwitchByeControlFrame *)	+ byeControlFrameWithSynchronizationSource:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(FMLiveSwitchByeControlFrame *)	+ byeControlFrameWithSynchronizationSource:reasonForLeaving:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(FMLiveSwitchByeControlFrame *)	+ byeControlFrameWithSynchronizationSources:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(FMLiveSwitchByeControlFrame *)	+ byeControlFrameWithSynchronizationSources:contributingSources:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(FMLiveSwitchByeControlFrame *)	+ byeControlFrameWithSynchronizationSources:contributingSources:reasonForLeaving:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(FMLiveSwitchByeControlFrame *)	+ byeControlFrameWithSynchronizationSources:reasonForLeaving:
	Initializes a new instance of the FMLiveSwitchByeControlFrame class. More...

(int)	+ fixedPayloadHeaderLength
	Gets the length of the fixed payload header. More...

(int)	+ fixedReasonForLeavingPayloadHeaderLength
	Gets the length of the fixed reason for leaving header. More...

(int)	+ registeredPayloadType
	Gets the goodbye payload type. More...

Class Methods inherited from FMLiveSwitchMediaControlFrame
(NSMutableArray *)	+ addControlFrames:addControlFrames:index:
	Adds control frames to an array. More...

(NSMutableArray *)	+ addControlFrameWithControlFrames:addControlFrame:index:
	Adds a control frame to an array. More...

(int)	+ fixedHeaderLength
	Gets the length of the fixed header. More...

(FMLiveSwitchMediaControlFrame *)	+ mediaControlFrame
	Initializes a new instance of the FMLiveSwitchMediaControlFrame class. More...

(FMLiveSwitchMediaControlFrame *)	+ mediaControlFrameWithBuffer:
	Initializes a new instance of the FMLiveSwitchMediaControlFrame class. More...

(NSMutableArray *)	+ parseWithDataBuffer:
	Parses a data buffer into an array of control frames. More...

(NSMutableArray *)	+ removeControlFrameWithControlFrames:index:
	Removes a control frame from an array. More...

Class Methods inherited from FMLiveSwitchDynamic
(FMLiveSwitchDynamic *)	+ dynamic

Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *)	+ serializable
	Initializes a new instance of the FMLiveSwitchSerializable class. More...

Detailed Description

An RTCP BYE packet.

Method Documentation

◆ byeControlFrame

+ (FMLiveSwitchByeControlFrame*) byeControlFrame

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

◆ byeControlFrameWithBuffer:

+ (FMLiveSwitchByeControlFrame*) byeControlFrameWithBuffer: (FMLiveSwitchDataBuffer *) buffer

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

buffer The packet.

◆ byeControlFrameWithSynchronizationSource:

+ (FMLiveSwitchByeControlFrame*) byeControlFrameWithSynchronizationSource: (long long) synchronizationSource

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSource The synchronization source.

◆ byeControlFrameWithSynchronizationSource:reasonForLeaving:

+ (FMLiveSwitchByeControlFrame*) byeControlFrameWithSynchronizationSource:	(long long)	synchronizationSource
reasonForLeaving:	(NSString *)	reasonForLeaving

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSource	The synchronization source.
reasonForLeaving	The reason for leaving.

◆ byeControlFrameWithSynchronizationSources:

+ (FMLiveSwitchByeControlFrame*) byeControlFrameWithSynchronizationSources: (NSMutableArray *) synchronizationSources

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSources The synchronization sources.

◆ byeControlFrameWithSynchronizationSources:contributingSources:

+ (FMLiveSwitchByeControlFrame*) byeControlFrameWithSynchronizationSources:	(NSMutableArray *)	synchronizationSources
contributingSources:	(NSMutableArray *)	contributingSources

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSources	The synchronization sources.
contributingSources	The contributing sources.

◆ byeControlFrameWithSynchronizationSources:contributingSources:reasonForLeaving:

+ (FMLiveSwitchByeControlFrame*) byeControlFrameWithSynchronizationSources:	(NSMutableArray *)	synchronizationSources
contributingSources:	(NSMutableArray *)	contributingSources
reasonForLeaving:	(NSString *)	reasonForLeaving

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSources	The synchronization sources.
contributingSources	The contributing sources.
reasonForLeaving	The reason for leaving.

◆ byeControlFrameWithSynchronizationSources:reasonForLeaving:

+ (FMLiveSwitchByeControlFrame*) byeControlFrameWithSynchronizationSources:	(NSMutableArray *)	synchronizationSources
reasonForLeaving:	(NSString *)	reasonForLeaving

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSources	The synchronization sources.
reasonForLeaving	The reason for leaving.

◆ fixedPayloadHeaderLength

+ (int) fixedPayloadHeaderLength

Gets the length of the fixed payload header.

◆ fixedReasonForLeavingPayloadHeaderLength

+ (int) fixedReasonForLeavingPayloadHeaderLength

Gets the length of the fixed reason for leaving header.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Implements FMLiveSwitchMediaControlFrame.

◆ initWithBuffer:

- (instancetype) initWithBuffer: (FMLiveSwitchDataBuffer *) buffer

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

buffer The packet.

Implements FMLiveSwitchMediaControlFrame.

◆ initWithSynchronizationSource:

- (instancetype) initWithSynchronizationSource: (long long) synchronizationSource

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSource The synchronization source.

◆ initWithSynchronizationSource:reasonForLeaving:

- (instancetype) initWithSynchronizationSource:	(long long)	synchronizationSource
reasonForLeaving:	(NSString *)	reasonForLeaving

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSource	The synchronization source.
reasonForLeaving	The reason for leaving.

◆ initWithSynchronizationSources:

- (instancetype) initWithSynchronizationSources: (NSMutableArray *) synchronizationSources

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSources The synchronization sources.

◆ initWithSynchronizationSources:contributingSources:

- (instancetype) initWithSynchronizationSources:	(NSMutableArray *)	synchronizationSources
contributingSources:	(NSMutableArray *)	contributingSources

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSources	The synchronization sources.
contributingSources	The contributing sources.

◆ initWithSynchronizationSources:contributingSources:reasonForLeaving:

- (instancetype) initWithSynchronizationSources:	(NSMutableArray *)	synchronizationSources
contributingSources:	(NSMutableArray *)	contributingSources
reasonForLeaving:	(NSString *)	reasonForLeaving

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSources	The synchronization sources.
contributingSources	The contributing sources.
reasonForLeaving	The reason for leaving.

◆ initWithSynchronizationSources:reasonForLeaving:

- (instancetype) initWithSynchronizationSources:	(NSMutableArray *)	synchronizationSources
reasonForLeaving:	(NSString *)	reasonForLeaving

Initializes a new instance of the FMLiveSwitchByeControlFrame class.

Parameters

synchronizationSources	The synchronization sources.
reasonForLeaving	The reason for leaving.

◆ reason

- (bool) reason

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

◆ reasonForLeaving

- (NSString*) reasonForLeaving

Gets the reason for leaving as a string.

◆ reasonForLeavingLength

- (int) reasonForLeavingLength

Gets the length of the reason for leaving.

◆ reasonForLeavingOffset

- (int) reasonForLeavingOffset

Gets the offset of the reasonForLeaving in the payload.

◆ reasonForLeavingPayload

- (FMLiveSwitchDataBuffer*) reasonForLeavingPayload

Gets the reason for leaving.

◆ registeredPayloadType

+ (int) registeredPayloadType

Gets the goodbye payload type.

◆ setSources:

- (void) setSources: (NSMutableArray *) value

Sets the synchronization and contributing sources.

◆ sourceCount

- (int) sourceCount

Gets the number of sources.

◆ sources

- (NSMutableArray*) sources

Gets the synchronization and contributing sources.

◆ sourcesLength

- (int) sourcesLength

Gets the length of the sources in bytes.

◆ sourcesPayloadOffset

- (int) sourcesPayloadOffset

Gets the offset of the sources array in the payload.

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ byeControlFrame

◆ byeControlFrameWithBuffer:

◆ byeControlFrameWithSynchronizationSource:

◆ byeControlFrameWithSynchronizationSource:reasonForLeaving:

◆ byeControlFrameWithSynchronizationSources:

◆ byeControlFrameWithSynchronizationSources:contributingSources:

◆ byeControlFrameWithSynchronizationSources:contributingSources:reasonForLeaving:

◆ byeControlFrameWithSynchronizationSources:reasonForLeaving:

◆ fixedPayloadHeaderLength

◆ fixedReasonForLeavingPayloadHeaderLength

◆ init

◆ initWithBuffer:

◆ initWithSynchronizationSource:

◆ initWithSynchronizationSource:reasonForLeaving:

◆ initWithSynchronizationSources:

◆ initWithSynchronizationSources:contributingSources:

◆ initWithSynchronizationSources:contributingSources:reasonForLeaving:

◆ initWithSynchronizationSources:reasonForLeaving:

◆ reason

◆ reasonForLeaving

◆ reasonForLeavingLength

◆ reasonForLeavingOffset

◆ reasonForLeavingPayload

◆ registeredPayloadType

◆ setSources:

◆ sourceCount

◆ sources

◆ sourcesLength

◆ sourcesPayloadOffset