FMLiveSwitchMediaControlFrame Class Reference

A media control frame. More...

Instance Methods
(int)	- byte1Last5Bits
	Gets the last 5 bits of the first byte. More...
(FMLiveSwitchDataBuffer *)	- dataBuffer
	Gets the buffer. More...
(instancetype)	- init
	Initializes a new instance of the FMLiveSwitchMediaControlFrame class. More...
(instancetype)	- initWithBuffer:
	Initializes a new instance of the FMLiveSwitchMediaControlFrame class. 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
(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

A media control frame.

Method Documentation

addControlFrames:addControlFrames:index:

+ (NSMutableArray*) addControlFrames:		(NSMutableArray *)	controlFrames
addControlFrames:		(NSMutableArray *)	addControlFrames
index:		(int)	index

Adds control frames to an array.

Parameters

controlFrames	The control frames.
addControlFrames	The control frames to add.
index	The insert index.

Returns

A new control frame array.

addControlFrameWithControlFrames:addControlFrame:index:

+ (NSMutableArray*) addControlFrameWithControlFrames:		(NSMutableArray *)	controlFrames
addControlFrame:		(FMLiveSwitchMediaControlFrame *)	addControlFrame
index:		(int)	index

Adds a control frame to an array.

Parameters

controlFrames	The control frames.
addControlFrame	The control frame to add.
index	The insert index.

Returns

A new control frame array.

byte1Last5Bits

- (int) byte1Last5Bits

Gets the last 5 bits of the first byte.

dataBuffer

- (FMLiveSwitchDataBuffer*) dataBuffer

Gets the buffer.

fixedHeaderLength

+ (int) fixedHeaderLength

Gets the length of the fixed header.

init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchMediaControlFrame class.

Implements FMLiveSwitchDynamic.

Implemented in FMLiveSwitchStatControlFrame, FMLiveSwitchSRControlFrame, FMLiveSwitchSliControlFrame, FMLiveSwitchSdesControlFrame, FMLiveSwitchRRControlFrame, FMLiveSwitchRpsiControlFrame, FMLiveSwitchPliControlFrame, FMLiveSwitchGenericNackControlFrame, FMLiveSwitchByeControlFrame, and FMLiveSwitchAppControlFrame.

initWithBuffer:

- (instancetype) initWithBuffer:

(FMLiveSwitchDataBuffer *)

buffer

Initializes a new instance of the FMLiveSwitchMediaControlFrame class.

Parameters

buffer

The buffer.

Implemented in FMLiveSwitchTransportCCControlFrame, FMLiveSwitchTmmbrControlFrame, FMLiveSwitchTmmbnControlFrame, FMLiveSwitchSRControlFrame, FMLiveSwitchSliControlFrame, FMLiveSwitchSdesControlFrame, FMLiveSwitchRRControlFrame, FMLiveSwitchRembControlFrame, FMLiveSwitchPliControlFrame, FMLiveSwitchLrrControlFrame, FMLiveSwitchGenericNackControlFrame, FMLiveSwitchFirControlFrame, FMLiveSwitchByeControlFrame, FMLiveSwitchAppControlFrame, and FMLiveSwitchAfbControlFrame.

mediaControlFrame

+ (FMLiveSwitchMediaControlFrame*) mediaControlFrame

Initializes a new instance of the FMLiveSwitchMediaControlFrame class.

mediaControlFrameWithBuffer:

+ (FMLiveSwitchMediaControlFrame*) mediaControlFrameWithBuffer:

(FMLiveSwitchDataBuffer *)

buffer

Initializes a new instance of the FMLiveSwitchMediaControlFrame class.

Parameters

buffer

The buffer.

parseWithDataBuffer:

+ (NSMutableArray*) parseWithDataBuffer:

(FMLiveSwitchDataBuffer *)

dataBuffer

Parses a data buffer into an array of control frames.

Parameters

dataBuffer

The data buffer.

payload

- (FMLiveSwitchDataBuffer*) payload

Gets the payload.

payloadLengthWithPadding

- (int) payloadLengthWithPadding

Gets the length of the payload, in bytes, with padding.

payloadType

- (int) payloadType

Gets the payload type.

removeControlFrameWithControlFrames:index:

+ (NSMutableArray*) removeControlFrameWithControlFrames:		(NSMutableArray *)	controlFrames
index:		(int)	index

Removes a control frame from an array.

Parameters

controlFrames	The control frames.
index	The delete index.

Returns

A new control frame array.

setByte1Last5Bits:

- (void) setByte1Last5Bits:

(int)

value

Sets the last 5 bits of the first byte.

setDataBuffer:

- (void) setDataBuffer:

(FMLiveSwitchDataBuffer *)

value

Sets the buffer.

setPayloadLengthWithPadding:

- (void) setPayloadLengthWithPadding:

(int)

value

Sets the length of the payload, in bytes, with padding.

setPayloadType:

- (void) setPayloadType:

(int)

value

Sets the payload type.

setVersion:

- (void) setVersion:

(int)

value

Sets the version.

streamId

- (NSString*) streamId

Gets the stream ID.

version

- (int) version

Gets the version.