FMLiveSwitchRtpControlFrame Class Reference

An RTCP Feedback RTP control frame. More...

Instance Methods

(instancetype) - initWithFeedbackMessageType:
 Initializes a new instance of the FMLiveSwitchRtpControlFrame class. More...
 
(instancetype) - initWithFeedbackMessageType:buffer:
 Initializes a new instance of the FMLiveSwitchRtpControlFrame class. More...
 
(instancetype) - initWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:
 Initializes a new instance of the FMLiveSwitchRtpControlFrame class. More...
 
(instancetype) - initWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:feedbackControlInformation:
 Initializes a new instance of the FMLiveSwitchRtpControlFrame class. More...
 
- Instance Methods inherited from FMLiveSwitchFeedbackControlFrame
(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...
 
(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

(int) + registeredPayloadType
 Gets the RTP payload type. More...
 
(FMLiveSwitchRtpControlFrame *) + rtpControlFrameWithFeedbackMessageType:
 Initializes a new instance of the FMLiveSwitchRtpControlFrame class. More...
 
(FMLiveSwitchRtpControlFrame *) + rtpControlFrameWithFeedbackMessageType:buffer:
 Initializes a new instance of the FMLiveSwitchRtpControlFrame class. More...
 
(FMLiveSwitchRtpControlFrame *) + rtpControlFrameWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:
 Initializes a new instance of the FMLiveSwitchRtpControlFrame class. More...
 
(FMLiveSwitchRtpControlFrame *) + rtpControlFrameWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:feedbackControlInformation:
 Initializes a new instance of the FMLiveSwitchRtpControlFrame class. More...
 
- Class Methods inherited from FMLiveSwitchFeedbackControlFrame
(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 RTP control frame.

Method Documentation

◆ initWithFeedbackMessageType:

- (instancetype) initWithFeedbackMessageType: (int)  feedbackMessageType

Initializes a new instance of the FMLiveSwitchRtpControlFrame class.

Parameters
feedbackMessageTypeThe feedback message type.

◆ initWithFeedbackMessageType:buffer:

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

Initializes a new instance of the FMLiveSwitchRtpControlFrame class.

Parameters
feedbackMessageTypeThe feedback message 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 FMLiveSwitchRtpControlFrame class.

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

Implements FMLiveSwitchFeedbackControlFrame.

◆ 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 FMLiveSwitchRtpControlFrame class.

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

Implements FMLiveSwitchFeedbackControlFrame.

◆ registeredPayloadType

+ (int) registeredPayloadType

Gets the RTP payload type.

◆ rtpControlFrameWithFeedbackMessageType:

+ (FMLiveSwitchRtpControlFrame*) rtpControlFrameWithFeedbackMessageType: (int)  feedbackMessageType

Initializes a new instance of the FMLiveSwitchRtpControlFrame class.

Parameters
feedbackMessageTypeThe feedback message type.

◆ rtpControlFrameWithFeedbackMessageType:buffer:

+ (FMLiveSwitchRtpControlFrame*) rtpControlFrameWithFeedbackMessageType: (int)  feedbackMessageType
buffer: (FMLiveSwitchDataBuffer *)  buffer 

Initializes a new instance of the FMLiveSwitchRtpControlFrame class.

Parameters
feedbackMessageTypeThe feedback message type.
bufferThe backing data buffer.

◆ rtpControlFrameWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:

+ (FMLiveSwitchRtpControlFrame*) rtpControlFrameWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType
senderSynchronizationSource: (long long)  senderSynchronizationSource
mediaSynchronizationSource: (long long)  mediaSynchronizationSource 

Initializes a new instance of the FMLiveSwitchRtpControlFrame class.

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

◆ rtpControlFrameWithFeedbackMessageType:payloadType:senderSynchronizationSource:mediaSynchronizationSource:feedbackControlInformation:

+ (FMLiveSwitchRtpControlFrame*) rtpControlFrameWithFeedbackMessageType: (int)  feedbackMessageType
payloadType: (int)  payloadType
senderSynchronizationSource: (long long)  senderSynchronizationSource
mediaSynchronizationSource: (long long)  mediaSynchronizationSource
feedbackControlInformation: (FMLiveSwitchDataBuffer *)  feedbackControlInformation 

Initializes a new instance of the FMLiveSwitchRtpControlFrame class.

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