sd::SoundMeter::Options Struct Reference

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

#include <sd_MeterHelpers.h>

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 (overlay-ed over the meter). Only works if fader have been enabled in the module. More...
bool	useMinimalMode = true
	Automatically adapt the meter to use the most of the space available (by hiding header, value, tick-marks, etc...). More...
float	decayTime_ms = Constants::kDefaultDecay_ms
	Meter decay in milliseconds. More...
float	refreshRate = 30.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...
bool	useGradient = true
	Use gradients for the meter segments, in stead of solid colours. More...
bool	showPeakHoldIndicator = true
	Enable peak hold indicator. More...
std::vector< float >	tickMarks = { 0.0f, -3.0f, -6.0f, -9.0f, -12.0f, -18.0f, -30.0f, -40.0f, -50.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

Enable the meter.

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

headerEnabled

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

Enable the 'header' part of the meter.

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

valueEnabled

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

Enable the 'value' part of the meter.

Referenced by sd::SoundMeter::Level::setMeterBounds(), sd::SoundMeter::MetersComponent::showValue(), and sd::SoundMeter::MeterChannel::showValue().

faderEnabled

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

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

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

useMinimalMode

bool sd::SoundMeter::Options::useMinimalMode = true

Automatically adapt the meter to use the most of the space available (by hiding header, value, tick-marks, etc...).

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

decayTime_ms

float sd::SoundMeter::Options::decayTime_ms = Constants::kDefaultDecay_ms

Meter decay in milliseconds.

Referenced by sd::SoundMeter::Level::getDecay(), sd::SoundMeter::Level::setDecay(), and sd::SoundMeter::MetersComponent::setDecay().

refreshRate

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

Meter refresh rate when using internal timing.

Referenced by sd::SoundMeter::Level::getRefreshRate(), sd::SoundMeter::MetersComponent::MetersComponent(), sd::SoundMeter::MetersComponent::setRefreshRate(), and sd::SoundMeter::Level::setRefreshRate().

tickMarksEnabled

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

Show tick-marks. Divider lines on the meter at certain db levels.

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

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::Segment::draw(), and sd::SoundMeter::MeterChannel::showTickMarksOnTop().

useGradient

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

Use gradients for the meter segments, in stead of solid colours.

Referenced by sd::SoundMeter::Segment::draw(), sd::SoundMeter::Segment::setMeterBounds(), and sd::SoundMeter::MeterChannel::useGradients().

showPeakHoldIndicator

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

Enable peak hold indicator.

Referenced by sd::SoundMeter::Segment::draw(), and sd::SoundMeter::MeterChannel::showPeakHold().

tickMarks

std::vector<float> sd::SoundMeter::Options::tickMarks = { 0.0f, -3.0f, -6.0f, -9.0f, -12.0f, -18.0f, -30.0f, -40.0f, -50.0f }

Tick-mark position in db.

Referenced by sd::SoundMeter::Segment::setMeterOptions(), and sd::SoundMeter::MeterChannel::setTickMarks().

---

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

• sd_MeterHelpers.h