Interface MKLowLatencyAPI

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

Index

Methods

getCatchupConfig getFallbackConfig getLatency getTargetLatency setCatchupConfig setFallbackConfig setTargetLatency

Methods

getCatchupConfig

getCatchupConfig(): MKLowLatencySyncConfig
Returns the current latency sync configuration for catchup.

Returns MKLowLatencySyncConfig
the catchup sync configuration.

getFallbackConfig

getFallbackConfig(): MKLowLatencySyncConfig
Returns the current latency sync configuration for fallback.

Returns MKLowLatencySyncConfig
the fallback sync configuration.

getLatency

getLatency(): number
Returns the current latency in seconds.

Returns number

getTargetLatency

getTargetLatency(): number
Returns the current target latency in seconds.

Returns number

setCatchupConfig

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

setFallbackConfig

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

setTargetLatency

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