Interface LowLatencyAPI

interface LowLatencyAPI {
    getCatchupConfig(): LowLatencySyncConfig;
    getFallbackConfig(): LowLatencySyncConfig;
    getLatency(): number;
    getTargetLatency(): number;
    setCatchupConfig(config: LowLatencySyncConfig): void;
    setFallbackConfig(config: LowLatencySyncConfig): void;
    setTargetLatency(latency: number): void;
}

Index

Methods

getCatchupConfig getFallbackConfig getLatency getTargetLatency setCatchupConfig setFallbackConfig setTargetLatency

Methods

getCatchupConfig

getCatchupConfig(): LowLatencySyncConfig

Returns the current latency sync configuration for catchup.

Returns LowLatencySyncConfig
the catchup sync configuration.

Since
v8.3

getFallbackConfig

getFallbackConfig(): LowLatencySyncConfig

Returns the current latency sync configuration for fallback.

Returns LowLatencySyncConfig
the fallback sync configuration.

Since
v8.3

getLatency

getLatency(): number

Returns the current latency in seconds.

Returns number

Since
v8.3

getTargetLatency

getTargetLatency(): number

Returns the current target latency in seconds.

Returns number

Since
v8.3

setCatchupConfig

setCatchupConfig(config: LowLatencySyncConfig): void
Sets the configuration specifying parameters for latency catchup.
Parameters
- config: LowLatencySyncConfig
  the sync configuration for latency catchup.
Returns void

Since
v8.3

setFallbackConfig

setFallbackConfig(config: LowLatencySyncConfig): void
Sets the configuration specifying parameters for latency fallback.
Parameters
- config: LowLatencySyncConfig
  the sync configuration for latency fallback.
Returns void

Since
v8.3

setTargetLatency

setTargetLatency(latency: number): void
Sets the target latency to be maintained during playback. Causes firing a TargetLatencyChanged event.
Parameters
- latency: number
  the target latency in seconds.
Returns void

Since
v8.3