Skip to content

Interface: LiveBufferConfig ​

Properties ​

catchupRate? ​

optional catchupRate?: number

The playback rate when behind the target latency; 2 - catchupRate when ahead. Between 1 and 2, default 1.1.


jumpFactor? ​

optional jumpFactor?: number

A forward buffer this many times its goal is jumped instead of caught up. Above 1, default 4.


jumpTolerance? ​

optional jumpTolerance?: number

On a sink without a precise rate: seconds the forward buffer may stray from its goal before a jump, which is a visible skip. Above 0, default 0.5.


minRate? ​

optional minRate?: number

The slowest rate, when about to stall. Above 0 and at most 1, default 0.6.


stallThreshold? ​

optional stallThreshold?: number

Seconds of forward buffer below which playback is about to stall; no goal is lower. At least 0, default 0.5. On a canvas, lower the playout sink's preroll with it, else each stall still refills 0.5 s.


targetLatency? ​

optional targetLatency?: number

Seconds of latency to hold when the catalog sets no targetLatency or buffers. Measured like the catalog's: wallclock latency when the timeline has it, else the forward buffer. Above 0, default 1.


tolerance? ​

optional tolerance?: number

Seconds the forward buffer may stray from its goal before the rate changes. At least 0, default 0.1.