Sound Meter  0.8.0
Fully resizing juce meter module.
sd::SoundMeter::Options Struct Reference

All meter options for appearance and functionality. More...

Public Attributes

bool enabled = true
 Enable the meter. More...
 
bool headerEnabled = true
 Enable the 'header' part of the meter. More...
 
bool valueEnabled = true
 Enable the 'value' part of the meter. More...
 
bool faderEnabled = true
 Enable the fader (overlayed over the meter). Only works if fader have been enabled in the module. More...
 
bool useGradient = true
 Use gradients to fill the meter or hard segment boundaries. More...
 
bool showPeakHoldIndicator = true
 Show the peak hold indicator (a line that marks the highest level up to now). More...
 
float warningSegment_db = Constants::kWarningLevel_db
 Boundary level from normal to warning segment. More...
 
float peakSegment_db = Constants::kPeakLevel_db
 Boundary level from warning to peak segment. More...
 
float decayTime_ms = Constants::kDefaultDecay_ms
 Meter decay in milliseconds. More...
 
float refreshRate = 24.0f
 Meter refresh rate when using internal timing. More...
 
bool tickMarksEnabled = true
 Show tick-marks. Divider lines on the meter at certain db levels. More...
 
bool tickMarksOnTop = false
 Show the tick-marks below the level or above the level (level might obscure the tick-marks if loud enough). More...
 
std::vector< float > tickMarks = { -1.0f, -3.0f, -6.0f, -9.0f, -18.0f }
 Tick-mark position in db. More...
 

Detailed Description

All meter options for appearance and functionality.

Member Data Documentation

◆ enabled

bool sd::SoundMeter::Options::enabled = true

◆ headerEnabled

bool sd::SoundMeter::Options::headerEnabled = true

Enable the 'header' part of the meter.

Referenced by sd::SoundMeter::MetersComponent::enableHeader(), and sd::SoundMeter::MeterChannel::setOptions().

◆ valueEnabled

bool sd::SoundMeter::Options::valueEnabled = true

◆ faderEnabled

bool sd::SoundMeter::Options::faderEnabled = true

Enable the fader (overlayed over the meter). Only works if fader have been enabled in the module.

Referenced by sd::SoundMeter::MetersComponent::MetersComponent(), and sd::SoundMeter::MeterChannel::setOptions().

◆ useGradient

bool sd::SoundMeter::Options::useGradient = true

◆ showPeakHoldIndicator

bool sd::SoundMeter::Options::showPeakHoldIndicator = true

Show the peak hold indicator (a line that marks the highest level up to now).

Referenced by sd::SoundMeter::Level::isPeakHoldVisible(), sd::SoundMeter::Level::setOptions(), and sd::SoundMeter::Level::showPeakHold().

◆ warningSegment_db

float sd::SoundMeter::Options::warningSegment_db = Constants::kWarningLevel_db

Boundary level from normal to warning segment.

Referenced by sd::SoundMeter::MetersComponent::defineSegments(), and sd::SoundMeter::Level::setOptions().

◆ peakSegment_db

float sd::SoundMeter::Options::peakSegment_db = Constants::kPeakLevel_db

Boundary level from warning to peak segment.

Referenced by sd::SoundMeter::MetersComponent::defineSegments(), and sd::SoundMeter::Level::setOptions().

◆ decayTime_ms

◆ refreshRate

float sd::SoundMeter::Options::refreshRate = 24.0f

◆ tickMarksEnabled

bool sd::SoundMeter::Options::tickMarksEnabled = true

◆ tickMarksOnTop

bool sd::SoundMeter::Options::tickMarksOnTop = false

Show the tick-marks below the level or above the level (level might obscure the tick-marks if loud enough).

Referenced by sd::SoundMeter::MeterChannel::setOptions().

◆ tickMarks

std::vector<float> sd::SoundMeter::Options::tickMarks = { -1.0f, -3.0f, -6.0f, -9.0f, -18.0f }

Tick-mark position in db.

Referenced by sd::SoundMeter::Level::setOptions().


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