FMLiveSwitchRedFecConfig Class Reference

RED Forward error correction (FEC) config. More...

Instance Methods

(int) - activationThreshold
 Gets the FEC activation threshold. More...
 
(bool) - bursty
 Gets a value indicating whether to use algorithms tuned for bursty packet loss. More...
 
(FMLiveSwitchFecProtectionParameters *) - deltaParameters
 Gets the parameters used to protect delta frames. More...
 
(bool) - disabled
 Gets a value indicating whether RED Forward Error Correction (FEC) is disabled. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchRedFecConfig class. More...
 
(FMLiveSwitchFecProtectionParameters *) - keyFrameParameters
 Gets the parameters used to protect key-frames. More...
 
(void) - setActivationThreshold:
 Sets the FEC activation threshold. More...
 
(void) - setBursty:
 Sets a value indicating whether to use algorithms tuned for bursty packet loss. More...
 
(void) - setDeltaParameters:
 Sets the parameters used to protect delta frames. More...
 
(void) - setKeyFrameParameters:
 Sets the parameters used to protect key-frames. More...
 

Class Methods

(FMLiveSwitchRedFecConfig *) + redFecConfig
 Initializes a new instance of the FMLiveSwitchRedFecConfig class. More...
 

Detailed Description

RED Forward error correction (FEC) config.

RedFecConfig is for enabling/configuring forward error correction. Forward error correction adds redundancy to the media stream (increased bandwidth) with the intention that media receivers can recover from packet loss without requiring the media server to retransmit anything. It is a last resort for high latency networks. It is disabled by default and not currently supported as it does not have sufficient test coverage.

Method Documentation

◆ activationThreshold

- (int) activationThreshold

Gets the FEC activation threshold.

FEC is activated when the RTCP receiver reports indicate that more than this threshold value of packets were lost (but only if supported by the remote peer); when this value diminishes blow the threshold, FEC is deactivated. The value is denoted in percentage points (between 0 and 100). Affects encoded data only. Defaults to 5.

◆ bursty

- (bool) bursty

Gets a value indicating whether to use algorithms tuned for bursty packet loss.

Bursty packet loss is more common on wireless networks. Defaults to false on desktop platforms and true on mobile platforms.

◆ deltaParameters

Gets the parameters used to protect delta frames.

◆ disabled

- (bool) disabled

Gets a value indicating whether RED Forward Error Correction (FEC) is disabled.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchRedFecConfig class.

◆ keyFrameParameters

- (FMLiveSwitchFecProtectionParameters*) keyFrameParameters

Gets the parameters used to protect key-frames.

◆ redFecConfig

+ (FMLiveSwitchRedFecConfig*) redFecConfig

Initializes a new instance of the FMLiveSwitchRedFecConfig class.

◆ setActivationThreshold:

- (void) setActivationThreshold: (int)  value

Sets the FEC activation threshold.

FEC is activated when the RTCP receiver reports indicate that more than this threshold value of packets were lost (but only if supported by the remote peer); when this value diminishes blow the threshold, FEC is deactivated. The value is denoted in percentage points (between 0 and 100). Affects encoded data only. Defaults to 5.

◆ setBursty:

- (void) setBursty: (bool)  value

Sets a value indicating whether to use algorithms tuned for bursty packet loss.

Bursty packet loss is more common on wireless networks. Defaults to false on desktop platforms and true on mobile platforms.

◆ setDeltaParameters:

- (void) setDeltaParameters: (FMLiveSwitchFecProtectionParameters *)  value

Sets the parameters used to protect delta frames.

◆ setKeyFrameParameters:

- (void) setKeyFrameParameters: (FMLiveSwitchFecProtectionParameters *)  value

Sets the parameters used to protect key-frames.