Settings to configure AudioScrubPlugin

interface AudioScrubSettings {
    autoRegister: boolean;
    billing?: string;
    frameSoundDuration: number;
    playbackRates?: number[];
    seekStrategy?: SeekStrategyType;
    seekTimeout: number;
    updateSrc?: ((src, srcId) => Promise<string>);
    verbose?: boolean;
}

Hierarchy

  • PlayerSettings
    • AudioScrubSettings

Properties

autoRegister: boolean

(default: true) If this setting is true, the channelControl plugin will register the master element of the player and if the discrete audio plugin is enabled it will automatically register all discrete tracks as they are added or removed.

billing?: string

Billing information passed on to license server

frameSoundDuration: number

(default: 60) This setting is used to determine how long duration a track need to be playing to simulate a frame worth of sound.

playbackRates?: number[]

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

seekStrategy?: SeekStrategyType

Controls how seeks are executed.

seekTimeout: number

(default: 1000) This settings indicates the max wait time in milliseconds for seeking to the correct position to play the audio scrub sound. If the seek times out the audio scrub will be aborted.

updateSrc?: ((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.

Type declaration

    • (src, srcId): Promise<string>
    • Parameters

      • src: string

        Current src.

      • srcId: string

        Id of source.

      Returns Promise<string>

verbose?: boolean

If player should log verbosely in the console.