FMLiveSwitchTmmbrEntry Class Reference

An RTCP temporary maximum media-stream bitrate request (TMMBR) packet entry. More...

Instance Methods

(FMLiveSwitchDataBuffer *) - dataBuffer
 Gets the backing data buffer. More...
 
(instancetype) - initWithDataBuffer:
 Initializes a new instance of the FMLiveSwitchTmmbrEntry class. More...
 
(instancetype) - initWithMaximumBitrate:synchronizationSource:
 Initializes a new instance of the FMLiveSwitchTmmbrEntry class. More...
 
(long long) - maximumBitrate
 Gets the maximum bitrate. More...
 
(int) - maximumBitrateExponent
 Gets the maximum bitrate exponent. More...
 
(int) - maximumBitrateMantissa
 Gets the maximum bitrate mantissa. More...
 
(int) - measuredOverhead
 Gets the measured average packet overhead in bytes. More...
 
(int) - normalizedMaximumBitrate
 Gets the normalized maximum bitrate. More...
 
(void) - setDataBuffer:
 Sets the backing data buffer. More...
 
(void) - setMaximumBitrate:
 Sets the maximum bitrate. More...
 
(void) - setMaximumBitrateExponent:
 Sets the maximum bitrate exponent. More...
 
(void) - setMaximumBitrateMantissa:
 Sets the maximum bitrate mantissa. More...
 
(void) - setMeasuredOverhead:
 Sets the measured average packet overhead in bytes. More...
 
(void) - setNormalizedMaximumBitrate:
 Sets the normalized maximum bitrate. More...
 
(void) - setSynchronizationSource:
 Sets the synchronization source. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 
- Instance Methods inherited from FMLiveSwitchControlFrameEntry
(instancetype) - init
 

Class Methods

(int) + fixedPayloadLength
 Gets the fixed length of an FIR entry. More...
 
(FMLiveSwitchTmmbrEntry *) + normalizedWithNormalizedMaximumBitrate:synchronizationSource:
 Creates a FMLiveSwitchTmmbrEntry using normalized parameters. More...
 
(FMLiveSwitchTmmbrEntry *) + tmmbrEntryWithDataBuffer:
 Initializes a new instance of the FMLiveSwitchTmmbrEntry class. More...
 
(FMLiveSwitchTmmbrEntry *) + tmmbrEntryWithMaximumBitrate:synchronizationSource:
 Initializes a new instance of the FMLiveSwitchTmmbrEntry class. More...
 
- Class Methods inherited from FMLiveSwitchControlFrameEntry
(FMLiveSwitchControlFrameEntry *) + controlFrameEntry
 

Detailed Description

An RTCP temporary maximum media-stream bitrate request (TMMBR) packet entry.

Method Documentation

◆ dataBuffer

- (FMLiveSwitchDataBuffer*) dataBuffer

Gets the backing data buffer.

◆ fixedPayloadLength

+ (int) fixedPayloadLength

Gets the fixed length of an FIR entry.

◆ initWithDataBuffer:

- (instancetype) initWithDataBuffer: (FMLiveSwitchDataBuffer *)  dataBuffer

Initializes a new instance of the FMLiveSwitchTmmbrEntry class.

Parameters
dataBufferThe data buffer.

◆ initWithMaximumBitrate:synchronizationSource:

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

Initializes a new instance of the FMLiveSwitchTmmbrEntry class.

Parameters
maximumBitrateThe maximum bitrate.
synchronizationSourceThe synchronization source.

◆ maximumBitrate

- (long long) maximumBitrate

Gets the maximum bitrate.

◆ maximumBitrateExponent

- (int) maximumBitrateExponent

Gets the maximum bitrate exponent.

◆ maximumBitrateMantissa

- (int) maximumBitrateMantissa

Gets the maximum bitrate mantissa.

◆ measuredOverhead

- (int) measuredOverhead

Gets the measured average packet overhead in bytes.

◆ normalizedMaximumBitrate

- (int) normalizedMaximumBitrate

Gets the normalized maximum bitrate.

◆ normalizedWithNormalizedMaximumBitrate:synchronizationSource:

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

Creates a FMLiveSwitchTmmbrEntry using normalized parameters.

Parameters
normalizedMaximumBitrateThe normalized maximum bitrate.
synchronizationSourceThe synchronization source.

◆ setDataBuffer:

- (void) setDataBuffer: (FMLiveSwitchDataBuffer *)  value

Sets the backing data buffer.

◆ setMaximumBitrate:

- (void) setMaximumBitrate: (long long)  value

Sets the maximum bitrate.

◆ setMaximumBitrateExponent:

- (void) setMaximumBitrateExponent: (int)  value

Sets the maximum bitrate exponent.

◆ setMaximumBitrateMantissa:

- (void) setMaximumBitrateMantissa: (int)  value

Sets the maximum bitrate mantissa.

◆ setMeasuredOverhead:

- (void) setMeasuredOverhead: (int)  value

Sets the measured average packet overhead in bytes.

◆ setNormalizedMaximumBitrate:

- (void) setNormalizedMaximumBitrate: (int)  value

Sets the normalized maximum bitrate.

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long)  value

Sets the synchronization source.

Implements FMLiveSwitchControlFrameEntry.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.

Implements FMLiveSwitchControlFrameEntry.

◆ tmmbrEntryWithDataBuffer:

+ (FMLiveSwitchTmmbrEntry*) tmmbrEntryWithDataBuffer: (FMLiveSwitchDataBuffer *)  dataBuffer

Initializes a new instance of the FMLiveSwitchTmmbrEntry class.

Parameters
dataBufferThe data buffer.

◆ tmmbrEntryWithMaximumBitrate:synchronizationSource:

+ (FMLiveSwitchTmmbrEntry*) tmmbrEntryWithMaximumBitrate: (long long)  maximumBitrate
synchronizationSource: (long long)  synchronizationSource 

Initializes a new instance of the FMLiveSwitchTmmbrEntry class.

Parameters
maximumBitrateThe maximum bitrate.
synchronizationSourceThe synchronization source.