This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
AudioVULEDs< N > Class Template Reference

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

#include <AudioVULEDs.hpp>

Inheritance diagram for AudioVULEDs< N >:
Collaboration diagram for AudioVULEDs< N >:

Public Member Functions

 AudioVULEDs (const 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 (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...
 
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 ()
 Check if this updatable is enabled. More...
 

Static Public Member Functions

static void enable (Updatable *element)
 
static void enable (Updatable &element)
 
static void enable (U(&array)[N])
 
static void disable (Updatable< AudioVU > *element)
 
static void disable (Updatable< AudioVU > &element)
 
static void disable (U(&array)[N])
 
static void beginAll ()
 Begin all enabled instances of this class. More...
 
static void updateAll ()
 Update all enabled instances of this class. More...
 

Protected Attributes

const uint8_t max
 
Updatable< AudioVU > * next
 
Updatable< AudioVU > * previous
 

Private Attributes

DotBarDisplayLEDs< N > vuleds
 
uint8_t previousValue = 0
 
MovingCoilBallistics ballistics = MovingCoilBallistics::responsiveVU()
 
class AudioVU::Analyzer level
 
float gain
 

Static Private Attributes

static DoublyLinkedList< Updatable< AudioVU > > updatables
 

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
NThe number of LEDs.

Definition at line 21 of file AudioVULEDs.hpp.

Constructor & Destructor Documentation

◆ AudioVULEDs()

template<uint8_t N>
AudioVULEDs< N >::AudioVULEDs ( const DotBarDisplayLEDs< N > &  vuleds,
AudioAnalyzePeak &  level,
float  gain = 1.0 
)
inline

Create a new AudioVULEDs object.

Parameters
vuledsThe LEDs to display the VU meter to.
levelThe Teensy Audio peak analyzer object.
Note that it is kept by reference, so it must outlive the AudioVU instance.
gainA multiplier to calibrate the VU meter.

Definition at line 35 of file AudioVULEDs.hpp.

Member Function Documentation

◆ begin()

template<uint8_t N>
void AudioVULEDs< N >::begin ( )
inlineoverridevirtual

Initialize.

Implements Updatable< AudioVU >.

Definition at line 42 of file AudioVULEDs.hpp.

◆ update()

template<uint8_t N>
void AudioVULEDs< N >::update ( )
inlineoverridevirtual

Update the LEDs with the latest level.

Implements Updatable< AudioVU >.

Definition at line 47 of file AudioVULEDs.hpp.

◆ setMode()

template<uint8_t N>
void AudioVULEDs< N >::setMode ( DotBarMode  mode)
inline

Set the mode to either dot or bar mode.

Parameters
modeThe mode.

Definition at line 61 of file AudioVULEDs.hpp.

◆ dotMode()

template<uint8_t N>
void AudioVULEDs< N >::dotMode ( )
inline

Set the mode to dot mode.

Definition at line 66 of file AudioVULEDs.hpp.

◆ barMode()

template<uint8_t N>
void AudioVULEDs< N >::barMode ( )
inline

Set the mode to bar mode.

Definition at line 71 of file AudioVULEDs.hpp.

◆ getValue()

uint8_t AudioVU::getValue ( )
inlineoverridevirtualinherited

Get the value of the VU meter.

Returns
A value in [0, max]

Implements IVU.

Definition at line 61 of file AudioVU.hpp.

◆ getFloatValue()

float AudioVU::getFloatValue ( )
inlineoverridevirtualinherited

Get the value of the VU meter.

Returns
A value in [0.0, 1.0]

Reimplemented from IVU.

Definition at line 71 of file AudioVU.hpp.

◆ getOverload()

bool AudioVU::getOverload ( )
inlineoverridevirtualinherited
Note
This function will always return false for an AudioVU.

Implements IVU.

Definition at line 84 of file AudioVU.hpp.

◆ setGain()

void AudioVU::setGain ( float  gain)
inlineinherited

Set the gain for the VU meter.

Parameters
gainThe new gain.
Examples
2.VU-Meter-OLED-USB-DAC.ino.

Definition at line 91 of file AudioVU.hpp.

◆ getMax()

uint8_t IVU::getMax ( ) const
inlineinherited

Get the maximum value that this VU meter can return.

Definition at line 30 of file VU.hpp.

◆ enable() [1/4]

void Updatable< AudioVU >::enable ( )
inlineinherited

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

Definition at line 40 of file Updatable.hpp.

◆ enable() [2/4]

static void Updatable< AudioVU >::enable ( Updatable< AudioVU > *  element)
inlinestaticinherited

Definition at line 80 of file Updatable.hpp.

◆ enable() [3/4]

static void Updatable< AudioVU >::enable ( Updatable< AudioVU > &  element)
inlinestaticinherited

Definition at line 82 of file Updatable.hpp.

◆ enable() [4/4]

static void Updatable< AudioVU >::enable ( U(&)  array[N])
inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ disable() [1/4]

void Updatable< AudioVU >::disable ( )
inlineinherited

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

Definition at line 50 of file Updatable.hpp.

◆ disable() [2/4]

static void Updatable< AudioVU >::disable ( Updatable< AudioVU > *  element)
inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [3/4]

static void Updatable< AudioVU >::disable ( Updatable< AudioVU > &  element)
inlinestaticinherited

Definition at line 92 of file Updatable.hpp.

◆ disable() [4/4]

static void Updatable< AudioVU >::disable ( U(&)  array[N])
inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ isEnabled()

bool Updatable< AudioVU >::isEnabled ( )
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 64 of file Updatable.hpp.

◆ beginAll()

static void Updatable< AudioVU >::beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 68 of file Updatable.hpp.

◆ updateAll()

static void Updatable< AudioVU >::updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

Member Data Documentation

◆ vuleds

template<uint8_t N>
DotBarDisplayLEDs<N> AudioVULEDs< N >::vuleds
private

Definition at line 74 of file AudioVULEDs.hpp.

◆ previousValue

template<uint8_t N>
uint8_t AudioVULEDs< N >::previousValue = 0
private

Definition at line 75 of file AudioVULEDs.hpp.

◆ ballistics

MovingCoilBallistics AudioVU::ballistics = MovingCoilBallistics::responsiveVU()
privateinherited

Definition at line 94 of file AudioVU.hpp.

◆ level

class AudioVU::Analyzer AudioVU::level
privateinherited

◆ gain

float AudioVU::gain
privateinherited

Definition at line 135 of file AudioVU.hpp.

◆ max

const uint8_t IVU::max
protectedinherited

Definition at line 33 of file VU.hpp.

◆ updatables

DoublyLinkedList< Updatable< AudioVU > > Updatable< AudioVU >::updatables
staticprivateinherited

Definition at line 101 of file Updatable.hpp.

◆ next

Updatable< AudioVU > * DoublyLinkable< Updatable< AudioVU > >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous

Updatable< AudioVU > * DoublyLinkable< Updatable< AudioVU > >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.


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