PhosphorAudio::SpectrumOptions Struct Reference

Full analysis parameter set for a spectrum provider. More...

#include <phosphor-audio/include/PhosphorAudio/IAudioSpectrumProvider.h>

Public Member Functions
bool	operator== (const SpectrumOptions &other) const =default

Public Attributes
int	barCount = Defaults::DefaultBarCount
int	framerate = Defaults::DefaultFramerate
bool	autosens = Defaults::DefaultAutosens
	Automatic gain: the analyzer self-scales so output fills 0..1.
int	sensitivity = Defaults::DefaultSensitivity
	Percent gain (100 = unity).
int	noiseReduction = Defaults::DefaultNoiseReduction
	Primary smoothing knob (cava's [smoothing] noise_reduction, 0-100): 0 = fast and twitchy, 100 = slow and smooth.
int	lowerCutoffHz = Defaults::DefaultLowerCutoffHz
	Analyzed frequency band.
int	higherCutoffHz = Defaults::DefaultHigherCutoffHz
bool	monstercat = Defaults::DefaultMonstercat
	Monstercat-style neighbor spread filter.
bool	waves = Defaults::DefaultWaves
	Wave-style spread filter.
ChannelMode	channelMode = ChannelMode::Stereo
bool	reverse = Defaults::DefaultReverse
	Reverse the frequency order of the emitted bars.
double	extraSmoothing = Defaults::DefaultExtraSmoothing
	Provider-side EMA on top of noiseReduction: fraction of the previous frame retained per update (0 = off).
QString	inputMethod
	Capture backend override ("pipewire", "pulse", ...). Empty = detect.
QString	inputSource = QStringLiteral("auto")
	Capture device/source for the backend. "auto" = the backend default.

Detailed Description

Full analysis parameter set for a spectrum provider.

A plain value type: build one (or copy the provider's current set via options()), adjust the fields, and hand it back through setOptions() — the provider normalizes (clamps ranges, rounds bars to even, sanitizes strings) and applies the whole set as one change, so a multi-field edit costs a single restart.

Member Function Documentation

operator==()

bool PhosphorAudio::SpectrumOptions::operator== ( const SpectrumOptions &  other ) const

default

Member Data Documentation

autosens

bool PhosphorAudio::SpectrumOptions::autosens = Defaults::DefaultAutosens

Automatic gain: the analyzer self-scales so output fills 0..1.

barCount

int PhosphorAudio::SpectrumOptions::barCount = Defaults::DefaultBarCount

channelMode

ChannelMode PhosphorAudio::SpectrumOptions::channelMode = ChannelMode::Stereo

extraSmoothing

double PhosphorAudio::SpectrumOptions::extraSmoothing = Defaults::DefaultExtraSmoothing

Provider-side EMA on top of noiseReduction: fraction of the previous frame retained per update (0 = off).

framerate

int PhosphorAudio::SpectrumOptions::framerate = Defaults::DefaultFramerate

higherCutoffHz

int PhosphorAudio::SpectrumOptions::higherCutoffHz = Defaults::DefaultHigherCutoffHz

inputMethod

QString PhosphorAudio::SpectrumOptions::inputMethod

Capture backend override ("pipewire", "pulse", ...). Empty = detect.

inputSource

QString PhosphorAudio::SpectrumOptions::inputSource = QStringLiteral("auto")

Capture device/source for the backend. "auto" = the backend default.

lowerCutoffHz

int PhosphorAudio::SpectrumOptions::lowerCutoffHz = Defaults::DefaultLowerCutoffHz

Analyzed frequency band.

The defaults' ranges guarantee lowerCutoffHz < higherCutoffHz for any pair of in-range values.

monstercat

bool PhosphorAudio::SpectrumOptions::monstercat = Defaults::DefaultMonstercat

Monstercat-style neighbor spread filter.

noiseReduction

int PhosphorAudio::SpectrumOptions::noiseReduction = Defaults::DefaultNoiseReduction

Primary smoothing knob (cava's [smoothing] noise_reduction, 0-100): 0 = fast and twitchy, 100 = slow and smooth.

reverse

bool PhosphorAudio::SpectrumOptions::reverse = Defaults::DefaultReverse

Reverse the frequency order of the emitted bars.

sensitivity

int PhosphorAudio::SpectrumOptions::sensitivity = Defaults::DefaultSensitivity

Percent gain (100 = unity).

With autosens on this is only the starting point the auto-gain adapts from.

waves

bool PhosphorAudio::SpectrumOptions::waves = Defaults::DefaultWaves

Wave-style spread filter.

---

The documentation for this struct was generated from the following file:

• phosphor-audio/include/PhosphorAudio/IAudioSpectrumProvider.h