#include <Audio/AudioVULEDs.hpp>

Detailed Description

template<uint8_t N>
class AudioVULEDs< N >

A VU meter that reads from an Audio stream using the AudioAnalyzePeak class, and displays it on an LED bar graph.

Template Parameters

N	The number of LEDs.

Definition at line 21 of file AudioVULEDs.hpp.

Inheritance diagram for AudioVULEDs< N >:

Collaboration diagram for AudioVULEDs< N >:

Detecting changes
bool	getDirty () const
	Check if the value was updated since the last time the dirty flag was cleared. More...

void	clearDirty ()
	Clear the dirty flag. More...

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

bool	isEnabled () const
	Check if this updatable is enabled. More...

void	moveDown ()
	Move down this element in the list. More...

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class. More...

static void	updateAll ()
	Update all enabled instances of this class. More...

Public Member Functions
	AudioVULEDs (const AH::DotBarDisplayLEDs< N > &vuleds, AudioAnalyzePeak &level, float gain=1.0)
	Create a new AudioVULEDs object. More...

void	begin () override
	Initialize. More...

void	update () override
	Update the LEDs with the latest level. More...

void	setMode (AH::DotBarMode mode)
	Set the mode to either dot or bar mode. More...

void	dotMode ()
	Set the mode to dot mode. More...

void	barMode ()
	Set the mode to bar mode. More...

uint8_t	getValue () override
	Get the value of the VU meter. More...

float	getFloatValue () override
	Get the value of the VU meter. More...

bool	getOverload () override

void	setGain (float gain)
	Set the gain for the VU meter. More...

uint8_t	getMax () const
	Get the maximum value that this VU meter can return. More...

Protected Attributes
uint8_t	max

bool	alwaysDirty

bool	dirty = true

Updatable< AudioVU > *	next

Updatable< AudioVU > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< AudioVU > >	updatables

Private Attributes
AH::DotBarDisplayLEDs< N >	vuleds

uint8_t	previousValue = 0

MovingCoilBallistics	ballistics = MovingCoilBallistics::responsiveVU()

class AudioVU::Analyzer	level

float	gain

Constructor & Destructor Documentation

◆ AudioVULEDs()

AudioVULEDs	(	const AH::DotBarDisplayLEDs< N > &	vuleds,
		AudioAnalyzePeak &	level,
		float	gain = `1.0`
	)

inline

Create a new AudioVULEDs object.

Parameters

vuleds	The LEDs to display the VU meter to.
level	The Teensy Audio peak analyzer object. Note that it is kept by reference, so it must outlive the AudioVU instance.
gain	A multiplier to calibrate the VU meter.

Definition at line 35 of file AudioVULEDs.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtual

Initialize.

Implements Updatable< AudioVU >.

Definition at line 42 of file AudioVULEDs.hpp.

◆ update()

void update ( )

inlineoverridevirtual

Update the LEDs with the latest level.

Implements Updatable< AudioVU >.

Definition at line 47 of file AudioVULEDs.hpp.

◆ setMode()

void setMode ( AH::DotBarMode mode )

inline

Set the mode to either dot or bar mode.

Parameters

mode The mode.

Definition at line 61 of file AudioVULEDs.hpp.

◆ dotMode()

void dotMode ( )

inline

Set the mode to dot mode.

Definition at line 66 of file AudioVULEDs.hpp.

◆ barMode()

void barMode ( )

inline

Set the mode to bar mode.

Definition at line 71 of file AudioVULEDs.hpp.

◆ getValue()

uint8_t getValue ( )

inlineoverridevirtualinherited

Get the value of the VU meter.

Returns: A value in [0, getMax()]

Implements IVU.

Definition at line 60 of file AudioVU.hpp.

◆ getFloatValue()

float getFloatValue ( )

inlineoverridevirtualinherited

Get the value of the VU meter.

Returns: A value in [0.0, 1.0]

Reimplemented from IVU.

Definition at line 70 of file AudioVU.hpp.

◆ getOverload()

bool getOverload ( )

inlineoverridevirtualinherited

Note: This function will always return false for an AudioVU.

Implements IVU.

Definition at line 83 of file AudioVU.hpp.

◆ setGain()

void setGain ( float gain )

inlineinherited

Set the gain for the VU meter.

Parameters

gain	The new gain.

Definition at line 91 of file AudioVU.hpp.

◆ getDirty()

bool getDirty ( ) const

inlineinherited

Check if the value was updated since the last time the dirty flag was cleared.

Definition at line 97 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )

inlineinherited

Clear the dirty flag.

Definition at line 99 of file InterfaceMIDIInputElements.hpp.

◆ getMax()

uint8_t getMax ( ) const

inlineinherited

Get the maximum value that this VU meter can return.

Definition at line 110 of file InterfaceMIDIInputElements.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Examples: 2.VU-Meter-OLED-USB-DAC.ino.

Definition at line 190 of file Updatable.hpp.

◆ enable() [1/4]

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 100 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< Updatable< AudioVU > > * element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< Updatable< AudioVU > > & element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 134 of file Updatable.hpp.

◆ disable() [1/4]

void disable ( )

inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 110 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< Updatable< AudioVU > > * element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/4]

static void disable ( UpdatableCRTP< Updatable< AudioVU > > & element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 145 of file Updatable.hpp.

◆ isEnabled()

bool isEnabled ( ) const

inlineinherited

Check if this updatable is enabled.

Note: Assumes that the updatable is not added to a different linked list by the user.

Definition at line 124 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

Member Data Documentation

◆ vuleds

AH::DotBarDisplayLEDs<N> vuleds

private

Definition at line 74 of file AudioVULEDs.hpp.

◆ previousValue

uint8_t previousValue = 0

private

Definition at line 75 of file AudioVULEDs.hpp.

◆ ballistics

MovingCoilBallistics ballistics = MovingCoilBallistics::responsiveVU()

privateinherited

Definition at line 94 of file AudioVU.hpp.

◆ level

class AudioVU::Analyzer level

privateinherited

◆ gain

float gain

privateinherited

Definition at line 135 of file AudioVU.hpp.

◆ max

uint8_t max

protectedinherited

Definition at line 113 of file InterfaceMIDIInputElements.hpp.

◆ alwaysDirty

bool alwaysDirty

protectedinherited

Definition at line 114 of file InterfaceMIDIInputElements.hpp.

◆ dirty

bool dirty = true

protectedinherited

Definition at line 115 of file InterfaceMIDIInputElements.hpp.

◆ updatables

DoublyLinkedList< Updatable< AudioVU > > updatables

staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< AudioVU > * next

protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< AudioVU > * previous

protectedinherited

Definition at line 325 of file LinkedList.hpp.

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

AudioVULEDs.hpp

Detailed Description

Detecting changes

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ AudioVULEDs()

Member Function Documentation

◆ begin()

◆ update()

◆ setMode()

◆ dotMode()

◆ barMode()

◆ getValue()

◆ getFloatValue()

◆ getOverload()

◆ setGain()

◆ getDirty()

◆ clearDirty()

◆ getMax()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ vuleds

◆ previousValue

◆ ballistics

◆ level

◆ gain

◆ max

◆ alwaysDirty

◆ dirty

◆ updatables

◆ next

◆ previous