Skip to content

Background Audio Options

Type: number | false
Default: 1

The volume level to use for playback, ranging from 0.0 (muted) to 1.0 (full volume). Setting to false or 0 will mute the audio.


Type: 'lowpass' | 'highpass' | 'bandpass' | 'lowshelf' | 'highshelf' | 'notch' | 'allpass'

The type of audio filter to apply to the background audio. Leave blank to disable filtering.


Type: number
Default: 0

The frequency for the audio filter in Hz. Only applies when filterType is set.


Type: number | false
Default: 0

The amount of noise to add to the audio, ranging from 0.0 (no noise) to 1.0 (maximum noise). Setting to false disables noise.


Type: true | false

Disable audio processing when the audio source doesn’t have proper CORS headers. Note that filter options won’t work when this is enabled.


Type: string

A description of the audio being played. Use the station name for live radio or song and artist information for music. This description will be shown in the info OSD (press i i to toggle).


Type: string

URL to fetch the now playing information from for dynamic content updates.


Type: string

The provider to use for fetching now playing information. Supported providers are:

  • azuracast
  • icecast

See the guide on background audio for more information.


Type: true | false

Whether to shuffle the playlist if the background audio is a playlist. The default value is false.