Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
VolumeControl< N > Class Template Reference

#include <Audio/VolumeControl.hpp>

Detailed Description

template<uint8_t N>
class VolumeControl< N >

A class for controlling the volume of AudioMixer4 objects using a potentiometer.

Template Parameters
NThe number of mixers.
Examples
1.Volume-Controlled-USB-DAC.ino, and 2.VU-Meter-OLED-USB-DAC.ino.

Definition at line 23 of file VolumeControl.hpp.

+ Inheritance diagram for VolumeControl< N >:
+ Collaboration diagram for VolumeControl< N >:

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

 VolumeControl (const Array< AudioMixer4 *, N > &mixers, pin_t analogPin, float maxGain=1.0)
 Create a new VolumeControl object. More...
 
void update () override
 Read the potentiometer value, and adjust the gain of the mixers. More...
 
void begin () override
 Initialize. More...
 
void map (MappingFunction fn)
 Specify a mapping function that is applied to the raw analog value before setting the volume. More...
 
void invert ()
 Invert the analog value. More...
 

Protected Attributes

Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Private Attributes

Array< AudioMixer4 *, N > mixers
 
AH::FilteredAnalog filteredAnalog
 
const float maxGain
 

Constructor & Destructor Documentation

◆ VolumeControl()

VolumeControl ( const Array< AudioMixer4 *, N > &  mixers,
pin_t  analogPin,
float  maxGain = 1.0 
)
inline

Create a new VolumeControl object.

Parameters
mixersAn array of pointers to audio mixers.
Only the pointers are saved, so the mixers should outlive this object.
analogPinThe analog pin with the potentiometer connected.
maxGainThe maximum gain for the mixers.

Definition at line 37 of file VolumeControl.hpp.

Member Function Documentation

◆ update()

void update ( )
inlineoverridevirtual

Read the potentiometer value, and adjust the gain of the mixers.

Implements Updatable< T >.

Definition at line 44 of file VolumeControl.hpp.

◆ begin()

void begin ( )
inlineoverridevirtual

Initialize.

Implements Updatable< T >.

Examples
1.Volume-Controlled-USB-DAC.ino.

Definition at line 56 of file VolumeControl.hpp.

◆ map()

void map ( MappingFunction  fn)
inline

Specify a mapping function that is applied to the raw analog value before setting the volume.

Parameters
fnA function pointer to the mapping function. This function should take the filtered analog value of \( 16 - \mathrm{ANALOG\_FILTER\_SHIFT\_FACTOR} \) bits as a parameter, and should return a value in the same range.
See also
FilteredAnalog::map

Definition at line 70 of file VolumeControl.hpp.

◆ invert()

void invert ( )
inline

Invert the analog value.

Definition at line 73 of file VolumeControl.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()

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< NormalUpdatable > > *  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< NormalUpdatable > > &  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< NormalUpdatable > > *  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< NormalUpdatable > > &  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

◆ mixers

Array<AudioMixer4 *, N> mixers
private

Definition at line 76 of file VolumeControl.hpp.

◆ filteredAnalog

AH::FilteredAnalog filteredAnalog
private

Definition at line 77 of file VolumeControl.hpp.

◆ maxGain

const float maxGain
private

Definition at line 78 of file VolumeControl.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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