Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LowLatencyAPI

Hierarchy

  • LowLatencyAPI

Index

Methods

getCatchupConfig

  • Returns the current latency sync configuration for catchup.

    since

    v8.3

    Returns LowLatencySyncConfig

    the catchup sync configuration.

getFallbackConfig

  • Returns the current latency sync configuration for fallback.

    since

    v8.3

    Returns LowLatencySyncConfig

    the fallback sync configuration.

getLatency

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

    since

    v8.3

    Returns number

getTargetLatency

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

    since

    v8.3

    Returns number

setCatchupConfig

  • Sets the configuration specifying parameters for latency catchup.

    since

    v8.3

    Parameters

    Returns void

setFallbackConfig

  • Sets the configuration specifying parameters for latency fallback.

    since

    v8.3

    Parameters

    Returns void

setTargetLatency

  • setTargetLatency(latency: number): void
  • Sets the target latency to be maintained during playback. Causes firing a PlayerEvent.TargetLatencyChanged event.

    since

    v8.3

    Parameters

    • latency: number

      the target latency in seconds.

    Returns void

Generated using TypeDoc