Interface SmoothTimeUpdateSettings

Settings to configure the smooth time update plugin.

interface SmoothTimeUpdateSettings {
    billing?: string;
    forceRequestAnimationFrame: boolean;
    playbackRates?: number[];
    seekStrategy?: SeekStrategyType;
    updateCallback: updateCallback;
    updateSrc?: ((src, srcId) => Promise<string>);
    verbose?: boolean;
}

Hierarchy

  • PlayerSettings
    • SmoothTimeUpdateSettings

Properties

billing? forceRequestAnimationFrame playbackRates? seekStrategy? updateCallback updateSrc? verbose?

Properties

Optional billing

billing?: string

forceRequestAnimationFrame

forceRequestAnimationFrame: boolean

Determines whether to force the use of requestAnimationFrame. By default requestVideoFrameCallback is used if it is available with a fallback to requestAnimationFrame. requestVideoFrameCallback may not work if you play audio-only files for example.

Optional playbackRates

playbackRates?: number[]

List of playback rates to use. Note: All playback rates may not work with all type of players.

Optional seekStrategy

seekStrategy?: SeekStrategyType

Controls how seeks are executed.

updateCallback

updateCallback: updateCallback

(Default: dispatchOnFrameChange) The callback to be used on every animationFrame update.

Optional updateSrc

updateSrc?: ((src, srcId) => Promise<string>)

Type declaration

    • (src, srcId): Promise<string>

    • Sets a callback function that resolves a new url when the player encounters an error. The url provided by the callback replaces the current loaded file url and is reloaded in the player. The main use-case for this is for updating pre-signed urls.

      Parameters

      • src: string

        Current src.

      • srcId: string

        Id of source.

      Returns Promise<string>

Optional verbose

verbose?: boolean

Settings

Member Visibility

Theme

On This Page