FMLiveSwitchReportBlock Class Reference

An RTCP report block. More...

Instance Methods

(int) - cumulativeNumberOfPacketsLost
 Gets the cumulative number of packets lost. More...
 
(FMLiveSwitchDataBuffer *) - dataBuffer
 Gets the backing data buffer. More...
 
(long long) - delaySinceLastSenderReport
 Gets the delay since last sender report. More...
 
(NSString *) - description
 Returns a string that represents this instance. More...
 
(long long) - extendedHighestSequenceNumberReceived
 Gets the extended highest sequence number received. More...
 
(int) - fractionLost
 Gets the fraction lost according to RFC 1889. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchReportBlock class. More...
 
(instancetype) - initWithDataBuffer:
 Initializes a new instance of the FMLiveSwitchReportBlock class. More...
 
(instancetype) - initWithFractionLost:cumulativeNumberOfPacketsLost:extendedHighestSequenceNumberReceived:interarrivalJitter:lastSenderReportTimestamp:delaySinceLastSenderReport:
 Initializes a new instance of the FMLiveSwitchReportBlock class. More...
 
(instancetype) - initWithSynchronizationSource:fractionLost:cumulativeNumberOfPacketsLost:extendedHighestSequenceNumberReceived:interarrivalJitter:lastSenderReportTimestamp:delaySinceLastSenderReport:
 Initializes a new instance of the FMLiveSwitchReportBlock class. More...
 
(long long) - interarrivalJitter
 Gets the interarrival jitter. More...
 
(long long) - lastSenderReportTimestamp
 Gets the last sender report timestamp. More...
 
(double) - percentLost
 Gets the percentage of lost packets. More...
 
(void) - setCumulativeNumberOfPacketsLost:
 Sets the cumulative number of packets lost. More...
 
(void) - setDataBuffer:
 Sets the backing data buffer. More...
 
(void) - setDelaySinceLastSenderReport:
 Sets the delay since last sender report. More...
 
(void) - setExtendedHighestSequenceNumberReceived:
 Sets the extended highest sequence number received. More...
 
(void) - setFractionLost:
 Sets the fraction lost according to RFC 1889. More...
 
(void) - setInterarrivalJitter:
 Sets the interarrival jitter. More...
 
(void) - setLastSenderReportTimestamp:
 Sets the last sender report timestamp. More...
 
(void) - setSynchronizationSource:
 Sets the synchronization source. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 

Class Methods

(int) + fixedPayloadLength
 Gets the fixed length of a report block. More...
 
(FMLiveSwitchReportBlock *) + reportBlock
 Initializes a new instance of the FMLiveSwitchReportBlock class. More...
 
(FMLiveSwitchReportBlock *) + reportBlockWithDataBuffer:
 Initializes a new instance of the FMLiveSwitchReportBlock class. More...
 
(FMLiveSwitchReportBlock *) + reportBlockWithFractionLost:cumulativeNumberOfPacketsLost:extendedHighestSequenceNumberReceived:interarrivalJitter:lastSenderReportTimestamp:delaySinceLastSenderReport:
 Initializes a new instance of the FMLiveSwitchReportBlock class. More...
 
(FMLiveSwitchReportBlock *) + reportBlockWithSynchronizationSource:fractionLost:cumulativeNumberOfPacketsLost:extendedHighestSequenceNumberReceived:interarrivalJitter:lastSenderReportTimestamp:delaySinceLastSenderReport:
 Initializes a new instance of the FMLiveSwitchReportBlock class. More...
 
- Class Methods inherited from FMLiveSwitchControlFrameEntry
(FMLiveSwitchControlFrameEntry *) + controlFrameEntry
 

Detailed Description

An RTCP report block.

Method Documentation

◆ cumulativeNumberOfPacketsLost

- (int) cumulativeNumberOfPacketsLost

Gets the cumulative number of packets lost.

◆ dataBuffer

- (FMLiveSwitchDataBuffer*) dataBuffer

Gets the backing data buffer.

◆ delaySinceLastSenderReport

- (long long) delaySinceLastSenderReport

Gets the delay since last sender report.

◆ description

- (NSString*) description

Returns a string that represents this instance.

◆ extendedHighestSequenceNumberReceived

- (long long) extendedHighestSequenceNumberReceived

Gets the extended highest sequence number received.

◆ fixedPayloadLength

+ (int) fixedPayloadLength

Gets the fixed length of a report block.

◆ fractionLost

- (int) fractionLost

Gets the fraction lost according to RFC 1889.

The value has a range of 0 (no packet loss) to 255 (all packets lost).

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchReportBlock class.

Implements FMLiveSwitchControlFrameEntry.

◆ initWithDataBuffer:

- (instancetype) initWithDataBuffer: (FMLiveSwitchDataBuffer *)  dataBuffer

Initializes a new instance of the FMLiveSwitchReportBlock class.

Parameters
dataBufferThe data buffer.

◆ initWithFractionLost:cumulativeNumberOfPacketsLost:extendedHighestSequenceNumberReceived:interarrivalJitter:lastSenderReportTimestamp:delaySinceLastSenderReport:

- (instancetype) initWithFractionLost: (int)  fractionLost
cumulativeNumberOfPacketsLost: (int)  cumulativeNumberOfPacketsLost
extendedHighestSequenceNumberReceived: (long long)  extendedHighestSequenceNumberReceived
interarrivalJitter: (long long)  interarrivalJitter
lastSenderReportTimestamp: (long long)  lastSenderReportTimestamp
delaySinceLastSenderReport: (long long)  delaySinceLastSenderReport 

Initializes a new instance of the FMLiveSwitchReportBlock class.

Parameters
fractionLostThe fraction lost.
cumulativeNumberOfPacketsLostThe cumulative number of packets lost.
extendedHighestSequenceNumberReceivedThe extended highest sequence number received.
interarrivalJitterThe interarrival jitter.
lastSenderReportTimestampThe last sender report timestamp.
delaySinceLastSenderReportThe delay since last sender report.

◆ initWithSynchronizationSource:fractionLost:cumulativeNumberOfPacketsLost:extendedHighestSequenceNumberReceived:interarrivalJitter:lastSenderReportTimestamp:delaySinceLastSenderReport:

- (instancetype) initWithSynchronizationSource: (long long)  synchronizationSource
fractionLost: (int)  fractionLost
cumulativeNumberOfPacketsLost: (int)  cumulativeNumberOfPacketsLost
extendedHighestSequenceNumberReceived: (long long)  extendedHighestSequenceNumberReceived
interarrivalJitter: (long long)  interarrivalJitter
lastSenderReportTimestamp: (long long)  lastSenderReportTimestamp
delaySinceLastSenderReport: (long long)  delaySinceLastSenderReport 

Initializes a new instance of the FMLiveSwitchReportBlock class.

Parameters
synchronizationSourceThe synchronization source.
fractionLostThe fraction lost.
cumulativeNumberOfPacketsLostThe cumulative number of packets lost.
extendedHighestSequenceNumberReceivedThe extended highest sequence number received.
interarrivalJitterThe interarrival jitter.
lastSenderReportTimestampThe last sender report timestamp.
delaySinceLastSenderReportThe delay since last sender report.

◆ interarrivalJitter

- (long long) interarrivalJitter

Gets the interarrival jitter.

◆ lastSenderReportTimestamp

- (long long) lastSenderReportTimestamp

Gets the last sender report timestamp.

◆ percentLost

- (double) percentLost

Gets the percentage of lost packets.

The value has a range of 0.0 (no packet loss) to 1.0 (all packets lost).

◆ reportBlock

+ (FMLiveSwitchReportBlock*) reportBlock

Initializes a new instance of the FMLiveSwitchReportBlock class.

◆ reportBlockWithDataBuffer:

+ (FMLiveSwitchReportBlock*) reportBlockWithDataBuffer: (FMLiveSwitchDataBuffer *)  dataBuffer

Initializes a new instance of the FMLiveSwitchReportBlock class.

Parameters
dataBufferThe data buffer.

◆ reportBlockWithFractionLost:cumulativeNumberOfPacketsLost:extendedHighestSequenceNumberReceived:interarrivalJitter:lastSenderReportTimestamp:delaySinceLastSenderReport:

+ (FMLiveSwitchReportBlock*) reportBlockWithFractionLost: (int)  fractionLost
cumulativeNumberOfPacketsLost: (int)  cumulativeNumberOfPacketsLost
extendedHighestSequenceNumberReceived: (long long)  extendedHighestSequenceNumberReceived
interarrivalJitter: (long long)  interarrivalJitter
lastSenderReportTimestamp: (long long)  lastSenderReportTimestamp
delaySinceLastSenderReport: (long long)  delaySinceLastSenderReport 

Initializes a new instance of the FMLiveSwitchReportBlock class.

Parameters
fractionLostThe fraction lost.
cumulativeNumberOfPacketsLostThe cumulative number of packets lost.
extendedHighestSequenceNumberReceivedThe extended highest sequence number received.
interarrivalJitterThe interarrival jitter.
lastSenderReportTimestampThe last sender report timestamp.
delaySinceLastSenderReportThe delay since last sender report.

◆ reportBlockWithSynchronizationSource:fractionLost:cumulativeNumberOfPacketsLost:extendedHighestSequenceNumberReceived:interarrivalJitter:lastSenderReportTimestamp:delaySinceLastSenderReport:

+ (FMLiveSwitchReportBlock*) reportBlockWithSynchronizationSource: (long long)  synchronizationSource
fractionLost: (int)  fractionLost
cumulativeNumberOfPacketsLost: (int)  cumulativeNumberOfPacketsLost
extendedHighestSequenceNumberReceived: (long long)  extendedHighestSequenceNumberReceived
interarrivalJitter: (long long)  interarrivalJitter
lastSenderReportTimestamp: (long long)  lastSenderReportTimestamp
delaySinceLastSenderReport: (long long)  delaySinceLastSenderReport 

Initializes a new instance of the FMLiveSwitchReportBlock class.

Parameters
synchronizationSourceThe synchronization source.
fractionLostThe fraction lost.
cumulativeNumberOfPacketsLostThe cumulative number of packets lost.
extendedHighestSequenceNumberReceivedThe extended highest sequence number received.
interarrivalJitterThe interarrival jitter.
lastSenderReportTimestampThe last sender report timestamp.
delaySinceLastSenderReportThe delay since last sender report.

◆ setCumulativeNumberOfPacketsLost:

- (void) setCumulativeNumberOfPacketsLost: (int)  value

Sets the cumulative number of packets lost.

◆ setDataBuffer:

- (void) setDataBuffer: (FMLiveSwitchDataBuffer *)  value

Sets the backing data buffer.

◆ setDelaySinceLastSenderReport:

- (void) setDelaySinceLastSenderReport: (long long)  value

Sets the delay since last sender report.

◆ setExtendedHighestSequenceNumberReceived:

- (void) setExtendedHighestSequenceNumberReceived: (long long)  value

Sets the extended highest sequence number received.

◆ setFractionLost:

- (void) setFractionLost: (int)  value

Sets the fraction lost according to RFC 1889.

The value has a range of 0 (no packet loss) to 255 (all packets lost).

◆ setInterarrivalJitter:

- (void) setInterarrivalJitter: (long long)  value

Sets the interarrival jitter.

◆ setLastSenderReportTimestamp:

- (void) setLastSenderReportTimestamp: (long long)  value

Sets the last sender report timestamp.

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long)  value

Sets the synchronization source.

Implements FMLiveSwitchControlFrameEntry.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.

Implements FMLiveSwitchControlFrameEntry.