FMLiveSwitchTmmbnControlFrame Class Reference

An RTCP temporary maximum media-stream bitrate notification (TMMBN) packet. More...

Instance Methods

(NSMutableArray *) - entries
 Gets the entries. More...
 
(FMLiveSwitchTmmbnEntry *) - entry
 Gets the entry. More...
 
(instancetype) - initWithBuffer:
 Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class. More...
 
(instancetype) - initWithEntries:
 Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class. More...
 
(instancetype) - initWithEntry:
 Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class. More...
 
(instancetype) - initWithMaximumBitrate:synchronizationSource:
 Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class. More...
 
(void) - setEntries:
 Sets the entries. More...
 
(void) - setEntry:
 Sets the entry. 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

(FMLiveSwitchTmmbnControlFrame *) + normalizedWithNormalizedMaximumBitrate:synchronizationSource:
 Creates a FMLiveSwitchTmmbnControlFrame using normalized parameters. More...
 
(FMLiveSwitchTmmbnControlFrame *) + normalizedWithNormalizedMaximumBitrate:synchronizationSource:packetSenderSynchronizationSource:
 Creates a FMLiveSwitchTmmbnControlFrame using normalized parameters. More...
 
(int) + registeredFeedbackMessageType
 Gets the type of the registered feedback message. More...
 
(FMLiveSwitchTmmbnControlFrame *) + tmmbnControlFrameWithBuffer:
 Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class. More...
 
(FMLiveSwitchTmmbnControlFrame *) + tmmbnControlFrameWithEntries:
 Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class. More...
 
(FMLiveSwitchTmmbnControlFrame *) + tmmbnControlFrameWithEntry:
 Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class. More...
 
(FMLiveSwitchTmmbnControlFrame *) + tmmbnControlFrameWithMaximumBitrate:synchronizationSource:
 Initializes a new instance of the FMLiveSwitchTmmbnControlFrame 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 temporary maximum media-stream bitrate notification (TMMBN) packet.

Method Documentation

◆ entries

- (NSMutableArray*) entries

Gets the entries.

◆ entry

Gets the entry.

◆ initWithBuffer:

- (instancetype) initWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class.

Parameters
bufferThe buffer.

Implements FMLiveSwitchMediaControlFrame.

◆ initWithEntries:

- (instancetype) initWithEntries: (NSMutableArray *)  entries

Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class.

Parameters
entriesThe entries.

◆ initWithEntry:

- (instancetype) initWithEntry: (FMLiveSwitchTmmbnEntry *)  entry

Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class.

Parameters
entryThe entry.

◆ initWithMaximumBitrate:synchronizationSource:

- (instancetype) initWithMaximumBitrate: (long long)  maximumBitrate
synchronizationSource: (long long)  synchronizationSource 

Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class.

Parameters
maximumBitrateThe maximum bitrate.
synchronizationSourceThe synchronization source.

◆ normalizedWithNormalizedMaximumBitrate:synchronizationSource:

+ (FMLiveSwitchTmmbnControlFrame*) normalizedWithNormalizedMaximumBitrate: (int)  normalizedMaximumBitrate
synchronizationSource: (long long)  synchronizationSource 

Creates a FMLiveSwitchTmmbnControlFrame using normalized parameters.

Parameters
normalizedMaximumBitrateThe normalized maximum bitrate.
synchronizationSourceThe synchronization source.

◆ normalizedWithNormalizedMaximumBitrate:synchronizationSource:packetSenderSynchronizationSource:

+ (FMLiveSwitchTmmbnControlFrame*) normalizedWithNormalizedMaximumBitrate: (int)  normalizedMaximumBitrate
synchronizationSource: (long long)  synchronizationSource
packetSenderSynchronizationSource: (long long)  packetSenderSynchronizationSource 

Creates a FMLiveSwitchTmmbnControlFrame using normalized parameters.

Parameters
normalizedMaximumBitrateThe normalized maximum bitrate.
synchronizationSourceThe synchronization source.
packetSenderSynchronizationSourceThe packet sender synchronization source.

◆ registeredFeedbackMessageType

+ (int) registeredFeedbackMessageType

Gets the type of the registered feedback message.

◆ setEntries:

- (void) setEntries: (NSMutableArray *)  value

Sets the entries.

◆ setEntry:

- (void) setEntry: (FMLiveSwitchTmmbnEntry *)  value

Sets the entry.

◆ tmmbnControlFrameWithBuffer:

+ (FMLiveSwitchTmmbnControlFrame*) tmmbnControlFrameWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class.

Parameters
bufferThe buffer.

◆ tmmbnControlFrameWithEntries:

+ (FMLiveSwitchTmmbnControlFrame*) tmmbnControlFrameWithEntries: (NSMutableArray *)  entries

Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class.

Parameters
entriesThe entries.

◆ tmmbnControlFrameWithEntry:

+ (FMLiveSwitchTmmbnControlFrame*) tmmbnControlFrameWithEntry: (FMLiveSwitchTmmbnEntry *)  entry

Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class.

Parameters
entryThe entry.

◆ tmmbnControlFrameWithMaximumBitrate:synchronizationSource:

+ (FMLiveSwitchTmmbnControlFrame*) tmmbnControlFrameWithMaximumBitrate: (long long)  maximumBitrate
synchronizationSource: (long long)  synchronizationSource 

Initializes a new instance of the FMLiveSwitchTmmbnControlFrame class.

Parameters
maximumBitrateThe maximum bitrate.
synchronizationSourceThe synchronization source.