FMLiveSwitchSRControlFrame Class Reference

A sender report control frame. More...

Instance Methods

(instancetype) - init
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(instancetype) - initWithBuffer:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(instancetype) - initWithReportBlock:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(instancetype) - initWithReportBlocks:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(instancetype) - initWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(instancetype) - initWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:reportBlock:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(instancetype) - initWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:reportBlocks:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(long long) - ntpTimestamp
 Gets the time when this report was sent (NTP-style). More...
 
(long long) - octetCount
 Gets the sender's octet count. More...
 
(long long) - packetCount
 Gets the sender's packet count. More...
 
(long long) - rtpTimestamp
 Gets the time when this report was sent (RTP-style). More...
 
(void) - setNtpTimestamp:
 Sets the time when this report was sent (NTP-style). More...
 
(void) - setOctetCount:
 Sets the sender's octet count. More...
 
(void) - setPacketCount:
 Sets the sender's packet count. More...
 
(void) - setRtpTimestamp:
 Sets the time when this report was sent (RTP-style). More...
 
- Instance Methods inherited from FMLiveSwitchReportControlFrame
(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...
 
(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) + fixedSenderInfoPayloadLength
 Gets the fixed payload header length of a Sender Report. More...
 
(int) + registeredPayloadType
 Gets the sender report payload type. More...
 
(int) + reportBlockOffset
 Gets the report block offset. More...
 
(FMLiveSwitchSRControlFrame *) + srControlFrame
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(FMLiveSwitchSRControlFrame *) + srControlFrameWithBuffer:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(FMLiveSwitchSRControlFrame *) + srControlFrameWithReportBlock:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(FMLiveSwitchSRControlFrame *) + srControlFrameWithReportBlocks:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(FMLiveSwitchSRControlFrame *) + srControlFrameWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(FMLiveSwitchSRControlFrame *) + srControlFrameWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:reportBlock:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
(FMLiveSwitchSRControlFrame *) + srControlFrameWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:reportBlocks:
 Initializes a new instance of the FMLiveSwitchSRControlFrame class. More...
 
- Class Methods inherited from FMLiveSwitchReportControlFrame
(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

A sender report control frame.

Method Documentation

◆ fixedSenderInfoPayloadLength

+ (int) fixedSenderInfoPayloadLength

Gets the fixed payload header length of a Sender Report.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Implements FMLiveSwitchMediaControlFrame.

◆ initWithBuffer:

- (instancetype) initWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
bufferThe data buffer.

Implements FMLiveSwitchMediaControlFrame.

◆ initWithReportBlock:

- (instancetype) initWithReportBlock: (FMLiveSwitchReportBlock *)  reportBlock

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
reportBlockThe report block.

◆ initWithReportBlocks:

- (instancetype) initWithReportBlocks: (NSMutableArray *)  reportBlocks

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
reportBlocksThe report blocks.

◆ initWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:

- (instancetype) initWithSynchronizationSource: (long long)  synchronizationSource
ntpTimestamp: (long long)  ntpTimestamp
rtpTimestamp: (long long)  rtpTimestamp
packetCount: (long long)  packetCount
octetCount: (long long)  octetCount 

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.

◆ initWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:reportBlock:

- (instancetype) initWithSynchronizationSource: (long long)  synchronizationSource
ntpTimestamp: (long long)  ntpTimestamp
rtpTimestamp: (long long)  rtpTimestamp
packetCount: (long long)  packetCount
octetCount: (long long)  octetCount
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock 

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.
reportBlockThe report block.

◆ initWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:reportBlocks:

- (instancetype) initWithSynchronizationSource: (long long)  synchronizationSource
ntpTimestamp: (long long)  ntpTimestamp
rtpTimestamp: (long long)  rtpTimestamp
packetCount: (long long)  packetCount
octetCount: (long long)  octetCount
reportBlocks: (NSMutableArray *)  reportBlocks 

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.
reportBlocksThe report blocks.

◆ ntpTimestamp

- (long long) ntpTimestamp

Gets the time when this report was sent (NTP-style).

◆ octetCount

- (long long) octetCount

Gets the sender's octet count.

◆ packetCount

- (long long) packetCount

Gets the sender's packet count.

◆ registeredPayloadType

+ (int) registeredPayloadType

Gets the sender report payload type.

◆ reportBlockOffset

+ (int) reportBlockOffset

Gets the report block offset.

◆ rtpTimestamp

- (long long) rtpTimestamp

Gets the time when this report was sent (RTP-style).

◆ setNtpTimestamp:

- (void) setNtpTimestamp: (long long)  value

Sets the time when this report was sent (NTP-style).

◆ setOctetCount:

- (void) setOctetCount: (long long)  value

Sets the sender's octet count.

◆ setPacketCount:

- (void) setPacketCount: (long long)  value

Sets the sender's packet count.

◆ setRtpTimestamp:

- (void) setRtpTimestamp: (long long)  value

Sets the time when this report was sent (RTP-style).

◆ srControlFrame

+ (FMLiveSwitchSRControlFrame*) srControlFrame

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

◆ srControlFrameWithBuffer:

+ (FMLiveSwitchSRControlFrame*) srControlFrameWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
bufferThe data buffer.

◆ srControlFrameWithReportBlock:

+ (FMLiveSwitchSRControlFrame*) srControlFrameWithReportBlock: (FMLiveSwitchReportBlock *)  reportBlock

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
reportBlockThe report block.

◆ srControlFrameWithReportBlocks:

+ (FMLiveSwitchSRControlFrame*) srControlFrameWithReportBlocks: (NSMutableArray *)  reportBlocks

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
reportBlocksThe report blocks.

◆ srControlFrameWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:

+ (FMLiveSwitchSRControlFrame*) srControlFrameWithSynchronizationSource: (long long)  synchronizationSource
ntpTimestamp: (long long)  ntpTimestamp
rtpTimestamp: (long long)  rtpTimestamp
packetCount: (long long)  packetCount
octetCount: (long long)  octetCount 

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.

◆ srControlFrameWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:reportBlock:

+ (FMLiveSwitchSRControlFrame*) srControlFrameWithSynchronizationSource: (long long)  synchronizationSource
ntpTimestamp: (long long)  ntpTimestamp
rtpTimestamp: (long long)  rtpTimestamp
packetCount: (long long)  packetCount
octetCount: (long long)  octetCount
reportBlock: (FMLiveSwitchReportBlock *)  reportBlock 

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.
reportBlockThe report block.

◆ srControlFrameWithSynchronizationSource:ntpTimestamp:rtpTimestamp:packetCount:octetCount:reportBlocks:

+ (FMLiveSwitchSRControlFrame*) srControlFrameWithSynchronizationSource: (long long)  synchronizationSource
ntpTimestamp: (long long)  ntpTimestamp
rtpTimestamp: (long long)  rtpTimestamp
packetCount: (long long)  packetCount
octetCount: (long long)  octetCount
reportBlocks: (NSMutableArray *)  reportBlocks 

Initializes a new instance of the FMLiveSwitchSRControlFrame class.

Parameters
synchronizationSourceThe synchronization source.
ntpTimestampThe time when this report was sent (NTP-style).
rtpTimestampThe time when this report was sent (RTP-style).
packetCountThe sender's packet count.
octetCountThe sender's octet count.
reportBlocksThe report blocks.