FMLiveSwitchReportControlFrame Class Reference

An RTCP Sender or Receiver Report control frame. More...

Instance Methods

(FMLiveSwitchReportBlock *) - getReportBlockWithSynchronizationSource:
 Gets the report block. More...
 
(instancetype) - initWithPayloadType:reportBlock:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(instancetype) - initWithPayloadType:reportBlock:reportBlockOffset:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(instancetype) - initWithPayloadType:reportBlockOffset:buffer:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(instancetype) - initWithPayloadType:reportBlocks:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(instancetype) - initWithPayloadType:reportBlocks:reportBlockOffset:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(instancetype) - initWithPayloadType:synchronizationSource:reportBlock:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(instancetype) - initWithPayloadType:synchronizationSource:reportBlock:reportBlockOffset:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(instancetype) - initWithPayloadType:synchronizationSource:reportBlocks:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(instancetype) - initWithPayloadType:synchronizationSource:reportBlocks:reportBlockOffset:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(int) - receptionReportCount
 Gets the feedback message type. More...
 
(FMLiveSwitchReportBlock *) - reportBlock
 Gets the report block. More...
 
(NSMutableArray *) - reportBlocks
 Gets the report blocks. More...
 
(void) - setReportBlock:
 Sets the report block. More...
 
(void) - setReportBlocks:
 Sets the report blocks. More...
 
(void) - setSynchronizationSource:
 Sets the synchronization source. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 
- Instance Methods inherited from FMLiveSwitchMediaControlFrame
(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

(int) + fixedPayloadHeaderLength
 Gets the report control frame fixed payload header length. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:reportBlock:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:reportBlock:reportBlockOffset:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:reportBlockOffset:buffer:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:reportBlocks:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:reportBlocks:reportBlockOffset:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:synchronizationSource:reportBlock:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:synchronizationSource:reportBlock:reportBlockOffset:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:synchronizationSource:reportBlocks:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. More...
 
(FMLiveSwitchReportControlFrame *) + reportControlFrameWithPayloadType:synchronizationSource:reportBlocks:reportBlockOffset:
 Initializes a new instance of the FMLiveSwitchReportControlFrame class. 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 Sender or Receiver Report control frame.

Method Documentation

◆ fixedPayloadHeaderLength

+ (int) fixedPayloadHeaderLength

Gets the report control frame fixed payload header length.

◆ getReportBlockWithSynchronizationSource:

- (FMLiveSwitchReportBlock*) getReportBlockWithSynchronizationSource: (long long)  synchronizationSource

Gets the report block.

Parameters
synchronizationSourceThe synchronization source.

◆ initWithPayloadType:reportBlock:

- (instancetype) initWithPayloadType: (int)  payloadType
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
reportBlockThe report block.

◆ initWithPayloadType:reportBlock:reportBlockOffset:

- (instancetype) initWithPayloadType: (int)  payloadType
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock
reportBlockOffset: (int)  reportBlockOffset 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
reportBlockThe report block.
reportBlockOffsetThe report block offset.

◆ initWithPayloadType:reportBlockOffset:buffer:

- (instancetype) initWithPayloadType: (int)  payloadType
reportBlockOffset: (int)  reportBlockOffset
buffer: (FMLiveSwitchDataBuffer *)  buffer 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeThe payload type.
reportBlockOffsetThe offset of the report block.
bufferThe backing data buffer.

◆ initWithPayloadType:reportBlocks:

- (instancetype) initWithPayloadType: (int)  payloadType
reportBlocks: (NSMutableArray *)  reportBlocks 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
reportBlocksThe report blocks.

◆ initWithPayloadType:reportBlocks:reportBlockOffset:

- (instancetype) initWithPayloadType: (int)  payloadType
reportBlocks: (NSMutableArray *)  reportBlocks
reportBlockOffset: (int)  reportBlockOffset 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
reportBlocksThe report blocks.
reportBlockOffsetThe report block offset.

◆ initWithPayloadType:synchronizationSource:reportBlock:

- (instancetype) initWithPayloadType: (int)  payloadType
synchronizationSource: (long long)  synchronizationSource
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlockThe report block.

◆ initWithPayloadType:synchronizationSource:reportBlock:reportBlockOffset:

- (instancetype) initWithPayloadType: (int)  payloadType
synchronizationSource: (long long)  synchronizationSource
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock
reportBlockOffset: (int)  reportBlockOffset 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlockThe report block.
reportBlockOffsetThe report block offset.

◆ initWithPayloadType:synchronizationSource:reportBlocks:

- (instancetype) initWithPayloadType: (int)  payloadType
synchronizationSource: (long long)  synchronizationSource
reportBlocks: (NSMutableArray *)  reportBlocks 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlocksThe report blocks.

◆ initWithPayloadType:synchronizationSource:reportBlocks:reportBlockOffset:

- (instancetype) initWithPayloadType: (int)  payloadType
synchronizationSource: (long long)  synchronizationSource
reportBlocks: (NSMutableArray *)  reportBlocks
reportBlockOffset: (int)  reportBlockOffset 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlocksThe report blocks.
reportBlockOffsetThe report block offset.

◆ receptionReportCount

- (int) receptionReportCount

Gets the feedback message type.

◆ reportBlock

- (FMLiveSwitchReportBlock*) reportBlock

Gets the report block.

◆ reportBlocks

- (NSMutableArray*) reportBlocks

Gets the report blocks.

◆ reportControlFrameWithPayloadType:reportBlock:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
reportBlockThe report block.

◆ reportControlFrameWithPayloadType:reportBlock:reportBlockOffset:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock
reportBlockOffset: (int)  reportBlockOffset 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
reportBlockThe report block.
reportBlockOffsetThe report block offset.

◆ reportControlFrameWithPayloadType:reportBlockOffset:buffer:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
reportBlockOffset: (int)  reportBlockOffset
buffer: (FMLiveSwitchDataBuffer *)  buffer 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeThe payload type.
reportBlockOffsetThe offset of the report block.
bufferThe backing data buffer.

◆ reportControlFrameWithPayloadType:reportBlocks:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
reportBlocks: (NSMutableArray *)  reportBlocks 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
reportBlocksThe report blocks.

◆ reportControlFrameWithPayloadType:reportBlocks:reportBlockOffset:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
reportBlocks: (NSMutableArray *)  reportBlocks
reportBlockOffset: (int)  reportBlockOffset 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
reportBlocksThe report blocks.
reportBlockOffsetThe report block offset.

◆ reportControlFrameWithPayloadType:synchronizationSource:reportBlock:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
synchronizationSource: (long long)  synchronizationSource
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlockThe report block.

◆ reportControlFrameWithPayloadType:synchronizationSource:reportBlock:reportBlockOffset:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
synchronizationSource: (long long)  synchronizationSource
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock
reportBlockOffset: (int)  reportBlockOffset 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlockThe report block.
reportBlockOffsetThe report block offset.

◆ reportControlFrameWithPayloadType:synchronizationSource:reportBlocks:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
synchronizationSource: (long long)  synchronizationSource
reportBlocks: (NSMutableArray *)  reportBlocks 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlocksThe report blocks.

◆ reportControlFrameWithPayloadType:synchronizationSource:reportBlocks:reportBlockOffset:

+ (FMLiveSwitchReportControlFrame*) reportControlFrameWithPayloadType: (int)  payloadType
synchronizationSource: (long long)  synchronizationSource
reportBlocks: (NSMutableArray *)  reportBlocks
reportBlockOffset: (int)  reportBlockOffset 

Initializes a new instance of the FMLiveSwitchReportControlFrame class.

Parameters
payloadTypeType of the payload.
synchronizationSourceThe synchronization source.
reportBlocksThe report blocks.
reportBlockOffsetThe report block offset.

◆ setReportBlock:

- (void) setReportBlock: (FMLiveSwitchReportBlock *)  value

Sets the report block.

◆ setReportBlocks:

- (void) setReportBlocks: (NSMutableArray *)  value

Sets the report blocks.

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long)  value

Sets the synchronization source.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.