Settings to configure the channel control plugin.

interface ChannelSettings {
    autoRegister: boolean;
    billing?: string;
    channelRouter: ChannelRouter;
    fftSize: number;
    fftSizeFrequency: number;
    globalSolo: boolean;
    maxDecibels: number;
    minDecibels: number;
    playbackRates?: number[];
    preferredOutputCount: number;
    seekStrategy?: SeekStrategyType;
    updateSrc?: ((src, srcId) => Promise<string>);
    verbose?: boolean;
}

Hierarchy

  • PlayerSettings
    • ChannelSettings

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
channelRouter: ChannelRouter

(default: defaultChannelRouter) Enables the registration of custom channel merger. i.e if source is 5.1 but outputCount is stereo.

fftSize: number

(default 2048) The sample size used by the analyse node to do the fft transformation.

fftSizeFrequency: number

(default 128) The fft size to use for frequency analysis.

globalSolo: boolean

(default: true) If this setting is true, solo a channel in one track will affect all registered tracks.

maxDecibels: number

(default: -30) Sets an upper decibel limit to the audio analysing node.

minDecibels: number

(default: -100) Sets a lower decibel limit to the audio analysing node.

playbackRates?: number[]

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

preferredOutputCount: number

(default: 2) The desired output mode, i.e stereo output (default) would be 2, 5.1 system would be 6. If the browser or system doesn't support the preferred setting the setting will be set to the highest available.

seekStrategy?: SeekStrategyType

Controls how seeks are executed.

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>

verbose?: boolean