FMLiveSwitchFeedbackControlFrame Class Reference

An RTCP Feedback packet. More...

Instance Methods

(FMLiveSwitchDataBuffer *) - feedbackControlInformation
 Gets the Feedback Control Information field. More...
 
(int) - feedbackControlInformationOffset
 Gets the feedback control information offset. More...
 
(int) - feedbackMessageType
 Gets the feedback message type. More...
 
(instancetype) - initWithFeedbackMessageType:payloadType:
 Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class. More...
 
(instancetype) - initWithFeedbackMessageType:payloadType:buffer:
 Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class. More...
 
(instancetype) - initWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:
 Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class. More...
 
(instancetype) - initWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:feedbackControlInformation:
 Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class. More...
 
(long long) - mediaSourceSynchronizationSource
 Gets the SSRC of the media source that this piece of feedback information is related to. More...
 
(long long) - packetSenderSynchronizationSource
 Gets the SSRC of the packet sender - the synchronization source identifier for the originator of this packet. More...
 
(void) - setFeedbackMessageType:
 Sets the feedback message type. More...
 
(void) - setMediaSourceSynchronizationSource:
 Sets the SSRC of the media source that this piece of feedback information is related to. More...
 
(void) - setPacketSenderSynchronizationSource:
 Sets the SSRC of the packet sender - the synchronization source identifier for the originator of this packet. 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

(FMLiveSwitchFeedbackControlFrame *) + feedbackControlFrameWithFeedbackMessageType:payloadType:
 Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class. More...
 
(FMLiveSwitchFeedbackControlFrame *) + feedbackControlFrameWithFeedbackMessageType:payloadType:buffer:
 Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class. More...
 
(FMLiveSwitchFeedbackControlFrame *) + feedbackControlFrameWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:
 Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class. More...
 
(FMLiveSwitchFeedbackControlFrame *) + feedbackControlFrameWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:feedbackControlInformation:
 Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class. More...
 
(int) + fixedPayloadHeaderLength
 Gets the fixed payload header length of a Feedback Control packet. 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 Feedback packet.

Method Documentation

◆ feedbackControlFrameWithFeedbackMessageType:payloadType:

+ (FMLiveSwitchFeedbackControlFrame*) feedbackControlFrameWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType 

Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class.

Parameters
feedbackMessageTypeType of the feedback message.
payloadTypeType of the payload.

◆ feedbackControlFrameWithFeedbackMessageType:payloadType:buffer:

+ (FMLiveSwitchFeedbackControlFrame*) feedbackControlFrameWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType
buffer: (FMLiveSwitchDataBuffer *)  buffer 

Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class.

Parameters
feedbackMessageTypeThe feedback message type.
payloadTypePayload type.
bufferThe backing data buffer.

◆ feedbackControlFrameWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:

+ (FMLiveSwitchFeedbackControlFrame*) feedbackControlFrameWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType
senderSynchronizationSource: (long long)  senderSynchronizationSource
mediaSynchronizationSource: (long long)  mediaSynchronizationSource 

Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class.

Parameters
feedbackMessageTypeType of the feedback message.
payloadTypeType of the payload.
senderSynchronizationSourceThe sender synchronization source.
mediaSynchronizationSourceThe media synchronization source.

◆ feedbackControlFrameWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:feedbackControlInformation:

+ (FMLiveSwitchFeedbackControlFrame*) feedbackControlFrameWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType
senderSynchronizationSource: (long long)  senderSynchronizationSource
mediaSynchronizationSource: (long long)  mediaSynchronizationSource
feedbackControlInformation: (FMLiveSwitchDataBuffer *)  feedbackControlInformation 

Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class.

Parameters
feedbackMessageTypeType of the feedback message.
payloadTypeType of the payload.
senderSynchronizationSourceThe sender synchronization source.
mediaSynchronizationSourceThe media synchronization source.
feedbackControlInformationThe feedback control information.

◆ feedbackControlInformation

- (FMLiveSwitchDataBuffer*) feedbackControlInformation

Gets the Feedback Control Information field.

◆ feedbackControlInformationOffset

- (int) feedbackControlInformationOffset

Gets the feedback control information offset.

◆ feedbackMessageType

- (int) feedbackMessageType

Gets the feedback message type.

◆ fixedPayloadHeaderLength

+ (int) fixedPayloadHeaderLength

Gets the fixed payload header length of a Feedback Control packet.

◆ initWithFeedbackMessageType:payloadType:

- (instancetype) initWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType 

Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class.

Parameters
feedbackMessageTypeType of the feedback message.
payloadTypeType of the payload.

◆ initWithFeedbackMessageType:payloadType:buffer:

- (instancetype) initWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType
buffer: (FMLiveSwitchDataBuffer *)  buffer 

Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class.

Parameters
feedbackMessageTypeThe feedback message type.
payloadTypePayload type.
bufferThe backing data buffer.

◆ initWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:

- (instancetype) initWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType
senderSynchronizationSource: (long long)  senderSynchronizationSource
mediaSynchronizationSource: (long long)  mediaSynchronizationSource 

Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class.

Parameters
feedbackMessageTypeType of the feedback message.
payloadTypeType of the payload.
senderSynchronizationSourceThe sender synchronization source.
mediaSynchronizationSourceThe media synchronization source.

Implemented in FMLiveSwitchRtpControlFrame.

◆ initWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:feedbackControlInformation:

- (instancetype) initWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType
senderSynchronizationSource: (long long)  senderSynchronizationSource
mediaSynchronizationSource: (long long)  mediaSynchronizationSource
feedbackControlInformation: (FMLiveSwitchDataBuffer *)  feedbackControlInformation 

Initializes a new instance of the FMLiveSwitchFeedbackControlFrame class.

Parameters
feedbackMessageTypeType of the feedback message.
payloadTypeType of the payload.
senderSynchronizationSourceThe sender synchronization source.
mediaSynchronizationSourceThe media synchronization source.
feedbackControlInformationThe feedback control information.

Implemented in FMLiveSwitchRtpControlFrame.

◆ mediaSourceSynchronizationSource

- (long long) mediaSourceSynchronizationSource

Gets the SSRC of the media source that this piece of feedback information is related to.

◆ packetSenderSynchronizationSource

- (long long) packetSenderSynchronizationSource

Gets the SSRC of the packet sender - the synchronization source identifier for the originator of this packet.

◆ setFeedbackMessageType:

- (void) setFeedbackMessageType: (int)  value

Sets the feedback message type.

◆ setMediaSourceSynchronizationSource:

- (void) setMediaSourceSynchronizationSource: (long long)  value

Sets the SSRC of the media source that this piece of feedback information is related to.

◆ setPacketSenderSynchronizationSource:

- (void) setPacketSenderSynchronizationSource: (long long)  value

Sets the SSRC of the packet sender - the synchronization source identifier for the originator of this packet.