fm.liveswitch.RedFecConfig Class Reference

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

Public Member Functions

int getActivationThreshold ()
 Gets the FEC activation threshold. More...
 
boolean getBursty ()
 Gets a value indicating whether to use algorithms tuned for bursty packet loss. More...
 
fm.liveswitch.FecProtectionParameters getDeltaParameters ()
 Gets the parameters used to protect delta frames. More...
 
boolean getDisabled ()
 Gets a value indicating whether RED Forward Error Correction (FEC) is disabled. More...
 
fm.liveswitch.FecProtectionParameters getKeyFrameParameters ()
 Gets the parameters used to protect key-frames. More...
 
 RedFecConfig ()
 Initializes a new instance of the fm.liveswitch.RedFecConfig class. More...
 
void setActivationThreshold (int value)
 Sets the FEC activation threshold. More...
 
void setBursty (boolean value)
 Sets a value indicating whether to use algorithms tuned for bursty packet loss. More...
 
void setDeltaParameters (fm.liveswitch.FecProtectionParameters value)
 Sets the parameters used to protect delta frames. More...
 
void setKeyFrameParameters (fm.liveswitch.FecProtectionParameters value)
 Sets the parameters used to protect key-frames. 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.

Constructor & Destructor Documentation

◆ RedFecConfig()

fm.liveswitch.RedFecConfig.RedFecConfig ( )

Initializes a new instance of the fm.liveswitch.RedFecConfig class.

Member Function Documentation

◆ getActivationThreshold()

int fm.liveswitch.RedFecConfig.getActivationThreshold ( )

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.

◆ getBursty()

boolean fm.liveswitch.RedFecConfig.getBursty ( )

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.

◆ getDeltaParameters()

fm.liveswitch.FecProtectionParameters fm.liveswitch.RedFecConfig.getDeltaParameters ( )

Gets the parameters used to protect delta frames.

◆ getDisabled()

boolean fm.liveswitch.RedFecConfig.getDisabled ( )

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

◆ getKeyFrameParameters()

fm.liveswitch.FecProtectionParameters fm.liveswitch.RedFecConfig.getKeyFrameParameters ( )

Gets the parameters used to protect key-frames.

◆ setActivationThreshold()

void fm.liveswitch.RedFecConfig.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 fm.liveswitch.RedFecConfig.setBursty ( boolean  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 fm.liveswitch.RedFecConfig.setDeltaParameters ( fm.liveswitch.FecProtectionParameters  value)

Sets the parameters used to protect delta frames.

◆ setKeyFrameParameters()

void fm.liveswitch.RedFecConfig.setKeyFrameParameters ( fm.liveswitch.FecProtectionParameters  value)

Sets the parameters used to protect key-frames.