FMLiveSwitchJitterConfig Class Reference

A Jitter config. More...

Instance Methods

(int) - bufferLength
 Gets the initial jitter buffer length in milliseconds. More...
 
(bool) - disableBuffering
 Gets a value indicating whether the jitter buffer should be disabled. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchJitterConfig class. More...
 
(instancetype) - initWithBufferLength:
 Initializes a new instance of the FMLiveSwitchJitterConfig class. More...
 
(void) - setBufferLength:
 Sets the initial jitter buffer length in milliseconds. More...
 
(void) - setDisableBuffering:
 Sets a value indicating whether the jitter buffer should be disabled. More...
 

Class Methods

(FMLiveSwitchJitterConfig *) + jitterConfig
 Initializes a new instance of the FMLiveSwitchJitterConfig class. More...
 
(FMLiveSwitchJitterConfig *) + jitterConfigWithBufferLength:
 Initializes a new instance of the FMLiveSwitchJitterConfig class. More...
 

Detailed Description

A Jitter config.

JitterConfig is for configuring the jitter buffer. The jitter buffer helps to eliminate the effects of varying network delay and delivery times by holding packets for a brief period of time before releasing them to the playout track. The jitter buffer holds on to the packets so that any out of order arriving packets can be released in the correct order. You can modify the buffer size, but it will increase latency, and should generally be left with default values. The option to set these values will most likely be removed in a future release as our adaptive algorithms improve.

Method Documentation

◆ bufferLength

- (int) bufferLength

Gets the initial jitter buffer length in milliseconds.

Defaults to 100 (ms).

◆ disableBuffering

- (bool) disableBuffering

Gets a value indicating whether the jitter buffer should be disabled.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchJitterConfig class.

◆ initWithBufferLength:

- (instancetype) initWithBufferLength: (int)  bufferLength

Initializes a new instance of the FMLiveSwitchJitterConfig class.

Parameters
bufferLengthLength of the buffer.

◆ jitterConfig

+ (FMLiveSwitchJitterConfig*) jitterConfig

Initializes a new instance of the FMLiveSwitchJitterConfig class.

◆ jitterConfigWithBufferLength:

+ (FMLiveSwitchJitterConfig*) jitterConfigWithBufferLength: (int)  bufferLength

Initializes a new instance of the FMLiveSwitchJitterConfig class.

Parameters
bufferLengthLength of the buffer.

◆ setBufferLength:

- (void) setBufferLength: (int)  value

Sets the initial jitter buffer length in milliseconds.

Defaults to 100 (ms).

◆ setDisableBuffering:

- (void) setDisableBuffering: (bool)  value

Sets a value indicating whether the jitter buffer should be disabled.