FMLiveSwitchTransportCCControlFrame Class Reference

An RTCP transport-wide congestion control (transport-cc) packet. More...

Instance Methods

(int) - baseSequenceNumber
 Gets the base sequence number. More...
 
(NSString *) - description
 Returns a string representation of this instance. More...
 
(int) - feedbackPacketCount
 Gets the feedback packet count. More...
 
(instancetype) - initWithBaseSequenceNumber:packetStatusCount:referenceTime:feedbackPacketCount:packetStatusChunks:receiveDeltas:
 Initializes a new instance of the FMLiveSwitchTransportCCControlFrame class. More...
 
(instancetype) - initWithBuffer:
 Initializes a new instance of the FMLiveSwitchTransportCCControlFrame class. More...
 
(NSMutableArray *) - packetStatusChunks
 Gets the packet status chunks. More...
 
(int) - packetStatusCount
 Gets the packet status count. More...
 
(NSMutableArray *) - receiveDeltas
 Gets the receive deltas. More...
 
(NSMutableArray *) - receiveDeltasInMillis
 Gets the receive deltas in milliseconds. More...
 
(NSMutableArray *) - receiveDeltasInTicks
 Gets the receive deltas in ticks. More...
 
(int) - referenceTime
 Gets the reference time. More...
 
(int) - referenceTimeInMillis
 Gets the reference time in milliseconds. More...
 
(int) - referenceTimeInTicks
 Gets the reference time in ticks. More...
 
- Instance Methods inherited from FMLiveSwitchRtpControlFrame
(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...
 
(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

(double) + receiveDeltaInMillisWithReceiveDelta:
 Gets a receive delta in milliseconds. More...
 
(int) + receiveDeltaInTicksWithReceiveDelta:
 Gets a receive delta in ticks. More...
 
(int) + registeredFeedbackMessageType
 Gets the type of the transport-wide congestion control message. More...
 
(FMLiveSwitchTransportCCControlFrame *) + transportCCControlFrameWithBaseSequenceNumber:packetStatusCount:referenceTime:feedbackPacketCount:packetStatusChunks:receiveDeltas:
 Initializes a new instance of the FMLiveSwitchTransportCCControlFrame class. More...
 
(FMLiveSwitchTransportCCControlFrame *) + transportCCControlFrameWithBuffer:
 Initializes a new instance of the FMLiveSwitchTransportCCControlFrame class. More...
 
- Class Methods inherited from FMLiveSwitchRtpControlFrame
(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 transport-wide congestion control (transport-cc) packet.

Method Documentation

◆ baseSequenceNumber

- (int) baseSequenceNumber

Gets the base sequence number.

◆ description

- (NSString*) description

Returns a string representation of this instance.

◆ feedbackPacketCount

- (int) feedbackPacketCount

Gets the feedback packet count.

◆ initWithBaseSequenceNumber:packetStatusCount:referenceTime:feedbackPacketCount:packetStatusChunks:receiveDeltas:

- (instancetype) initWithBaseSequenceNumber: (int)  baseSequenceNumber
packetStatusCount: (int)  packetStatusCount
referenceTime: (int)  referenceTime
feedbackPacketCount: (int)  feedbackPacketCount
packetStatusChunks: (NSMutableArray *)  packetStatusChunks
receiveDeltas: (NSMutableArray *)  receiveDeltas 

Initializes a new instance of the FMLiveSwitchTransportCCControlFrame class.

◆ initWithBuffer:

- (instancetype) initWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchTransportCCControlFrame class.

Parameters
bufferThe buffer.

Implements FMLiveSwitchMediaControlFrame.

◆ packetStatusChunks

- (NSMutableArray*) packetStatusChunks

Gets the packet status chunks.

◆ packetStatusCount

- (int) packetStatusCount

Gets the packet status count.

◆ receiveDeltaInMillisWithReceiveDelta:

+ (double) receiveDeltaInMillisWithReceiveDelta: (int)  receiveDelta

Gets a receive delta in milliseconds.

Parameters
receiveDeltaThe receive delta.
Returns
The receive delta in milliseconds.

◆ receiveDeltaInTicksWithReceiveDelta:

+ (int) receiveDeltaInTicksWithReceiveDelta: (int)  receiveDelta

Gets a receive delta in ticks.

Parameters
receiveDeltaThe receive delta.
Returns
The receive delta in ticks.

◆ receiveDeltas

- (NSMutableArray*) receiveDeltas

Gets the receive deltas.

◆ receiveDeltasInMillis

- (NSMutableArray*) receiveDeltasInMillis

Gets the receive deltas in milliseconds.

◆ receiveDeltasInTicks

- (NSMutableArray*) receiveDeltasInTicks

Gets the receive deltas in ticks.

◆ referenceTime

- (int) referenceTime

Gets the reference time.

◆ referenceTimeInMillis

- (int) referenceTimeInMillis

Gets the reference time in milliseconds.

◆ referenceTimeInTicks

- (int) referenceTimeInTicks

Gets the reference time in ticks.

◆ registeredFeedbackMessageType

+ (int) registeredFeedbackMessageType

Gets the type of the transport-wide congestion control message.

◆ transportCCControlFrameWithBaseSequenceNumber:packetStatusCount:referenceTime:feedbackPacketCount:packetStatusChunks:receiveDeltas:

+ (FMLiveSwitchTransportCCControlFrame*) transportCCControlFrameWithBaseSequenceNumber: (int)  baseSequenceNumber
packetStatusCount: (int)  packetStatusCount
referenceTime: (int)  referenceTime
feedbackPacketCount: (int)  feedbackPacketCount
packetStatusChunks: (NSMutableArray *)  packetStatusChunks
receiveDeltas: (NSMutableArray *)  receiveDeltas 

Initializes a new instance of the FMLiveSwitchTransportCCControlFrame class.

◆ transportCCControlFrameWithBuffer:

+ (FMLiveSwitchTransportCCControlFrame*) transportCCControlFrameWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchTransportCCControlFrame class.

Parameters
bufferThe buffer.