A class for controlling the volume of AudioMixer4 objects using a potentiometer. More...
#include <Audio/VolumeControl.hpp>
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... | |
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< Potentiometer > *element) |
static void | disable (Updatable< Potentiometer > &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 | |
Updatable< Potentiometer > * | next |
Updatable< Potentiometer > * | previous |
Private Attributes | |
Array< AudioMixer4 *, N > | mixers |
AH::FilteredAnalog | filteredAnalog |
const float | maxGain |
Static Private Attributes | |
static DoublyLinkedList< Updatable< Potentiometer > > | updatables |
A class for controlling the volume of AudioMixer4 objects using a potentiometer.
N | The number of mixers. |
Definition at line 23 of file VolumeControl.hpp.
|
inline |
Create a new VolumeControl object.
mixers | An array of pointers to audio mixers. Only the pointers are saved, so the mixers should outlive this object. |
analogPin | The analog pin with the potentiometer connected. |
maxGain | The maximum gain for the mixers. |
Definition at line 37 of file VolumeControl.hpp.
|
inlineoverridevirtual |
Read the potentiometer value, and adjust the gain of the mixers.
Implements Updatable< Potentiometer >.
Definition at line 44 of file VolumeControl.hpp.
|
inlineoverridevirtual |
|
inline |
Specify a mapping function that is applied to the raw analog value before setting the volume.
fn | A 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. |
Definition at line 70 of file VolumeControl.hpp.
|
inline |
Invert the analog value.
Definition at line 73 of file VolumeControl.hpp.
|
inlineinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 45 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 85 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 87 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 90 of file Updatable.hpp.
|
inlineinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 55 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 95 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 97 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 100 of file Updatable.hpp.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 69 of file Updatable.hpp.
|
inlinestaticinherited |
Begin all enabled instances of this class.
Definition at line 73 of file Updatable.hpp.
|
inlinestaticinherited |
Update all enabled instances of this class.
Definition at line 80 of file Updatable.hpp.
|
private |
Definition at line 76 of file VolumeControl.hpp.
|
private |
Definition at line 77 of file VolumeControl.hpp.
|
private |
Definition at line 78 of file VolumeControl.hpp.
|
staticprivateinherited |
Definition at line 106 of file Updatable.hpp.
|
protectedinherited |
Definition at line 305 of file LinkedList.hpp.
|
protectedinherited |
Definition at line 306 of file LinkedList.hpp.