Interface DiscreteAudioSettings

Settings for the discrete audio plugin.

interface DiscreteAudioSettings {
    audioPreload?: PreloadHint;
    billing?: string;
    detectOutOfSync: boolean;
    frozenTimeout: number;
    maxEnabledTracks: number;
    playbackRates?: number[];
    seekStrategy?: SeekStrategyType;
    syncAheadPaused: number;
    syncAheadPlaying: number;
    syncByPlaybackRate: boolean;
    syncRate: number;
    toleratedOutOfSync: number;
    updateSrc?: ((src, srcId) => Promise<string>);
    verbose?: boolean;
}

Hierarchy

  • PlayerSettings
    • DiscreteAudioSettings

Properties

audioPreload? billing? detectOutOfSync frozenTimeout maxEnabledTracks playbackRates? seekStrategy? syncAheadPaused syncAheadPlaying syncByPlaybackRate syncRate toleratedOutOfSync updateSrc? verbose?

Properties

Optional audioPreload

audioPreload?: PreloadHint

Preload setting for generated audio elements.

Optional billing

billing?: string

detectOutOfSync

detectOutOfSync: boolean

Whether to detect sync issues between master and audio tracks.

frozenTimeout

frozenTimeout: number

Timeout in ms until player tries to recover from stalled connections. Set 0 to disable.

maxEnabledTracks

maxEnabledTracks: number

How many audio tracks can be enabled at the same time. Disabled if less than 1.

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.

syncAheadPaused

syncAheadPaused: number

Offset how far ahead of the master the audio tracks should seek when paused.

syncAheadPlaying

syncAheadPlaying: number

Offset how far ahead of the master the audio tracks should seek when playing.

syncByPlaybackRate

syncByPlaybackRate: boolean

Whether to sync by playback rate or setting currentTime.

syncRate

syncRate: number

How often to check if audio tracks is out of sync (seconds).

toleratedOutOfSync

toleratedOutOfSync: number

How much an audio track can be out of sync without correcting it (seconds).

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