Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChannelSettings

Settings to configure the channel control plugin.

Hierarchy

  • PlayerSettings
    • ChannelSettings

Index

Properties

autoRegister

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.

Optional billing

billing: string

channelRouter

channelRouter: ChannelRouter

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

fftSize

fftSize: number

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

globalSolo

globalSolo: boolean

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

maxDecibels

maxDecibels: number

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

minDecibels

minDecibels: number

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

preferredOutputCount

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.

Optional seekStrategy

seekStrategy: SeekStrategyType

Controls how seeks are executed.

Optional updateSrc

updateSrc: (videoFile: VideoFile) => Promise<string>

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

param

the current video file that failed

Type declaration

    • (videoFile: VideoFile): Promise<string>
    • Parameters

      • videoFile: VideoFile

      Returns Promise<string>

Optional verbose

verbose: boolean