Cava Widget Configuration

NOTE: This widget requires cava version >= 0.10.4 to be installed on your system. You can install it using winget (winget install karlstav.cava) or from the official repository. Cava needs to be accessible in the system PATH. YASB will create temporary configuration files for cava in the %LOCALAPPDATA%\YASB directory.

Example Configuration

  cava:
    type: "yasb.cava.CavaWidget"
    options:
      bar_height: 12
      min_bar_height: 0
      gradient: 1
      foreground: "#89b4fa"
      gradient_color_1: '#74c7ec'
      gradient_color_2: '#89b4fa'
      gradient_color_3: '#cba6f7'
      bars_number: 8
      bar_spacing: 2
      bar_width: 4
      bar_type: "bars"
      framerate: 60
      hide_empty: true

Description of Options

• class_name: Additional CSS class names for the widget container. (optional)
• bar_height: The height of bars in pixels.
• min_bar_height: The minimum height of bars in pixels.
• bars_number: The number of bars to display. Can be between 0 and 512. 0 sets it to auto.
• output_bit_format: Binary bit format, can be '8bit' (0-255) or '16bit' (0-65530).
• bar_spacing: Space between bars in number of characters.
• bar_width: Bars' width in number of characters.
• sleep_timer: Seconds with no input before cava goes to sleep mode. 0 to disable.
• sensitivity: Manual sensitivity in %. 200 means double height.
• lower_cutoff_freq: Lower cutoff frequencies for lowest bars.
• higher_cutoff_freq: Higher cutoff frequencies for highest bars.
• framerate: Accepts only non-negative values.
• noise_reduction: Noise reduction, 0-100. Higher = smoother but slower, lower = faster but noisier.
• channels: Visual channels. Can be 'stereo' or 'mono'.
• mono_option: Set mono to take input from 'left', 'right' or 'average'.
• reverse: Set to 1 to display frequencies the other way around.
• waveform: Show waveform instead of frequency spectrum, 1 = on, 0 = off.
• monstercat: Disables or enables the so-called "Monstercat smoothing" with or without "waves". Set to 0 to disable.
• waves: Related to monstercat, 1 = on, 0 = off.
• foreground: Foreground color in hex format.
• gradient: Gradient mode, 1 = on, 0 = off.
• gradient_color_1: First gradient color in hex format.
• gradient_color_2: Second gradient color in hex format.
• gradient_color_3: Third gradient color in hex format. (optional)
• hide_empty: Hide widget when no audio is playing (requires sleep_timer to be enabled).
• bar_type: Type of bar display. Can be 'bars', 'bars_mirrored', 'waves', or 'waves_mirrored'.
• edge_fade: Apply fade effect to edges. Creates a smooth fade-out effect on the edges of the visualization. Can be configured in two ways:
• Single value (e.g., 15): Applies the same fade width to both left and right edges
• Array format (e.g., [10, 20]): Applies different fade widths - first value for left edge, second for right edge
• Set to 0 or [0, 0] to disable. Important: When both sides have fade, each is automatically capped to half the widget width to prevent overlapping. When only one side has fade (e.g., [180, 0]), it can use the full widget width.
• callbacks: A dictionary specifying the callbacks for mouse events. The keys are on_left, on_middle, and on_right, and the values are the names of the callback functions.

Note: The waves and waves_mirrored ignore the bar_spacing option.

Allowed Callbacks:

"reload_cava"
"do_nothing"

More information on this option is documented in the example config file

Style

.cava-widget {
    padding: 0;
    margin: 0;
}
.cava-widget .widget-container {}