#include <Audio/VolumeControl.hpp>
template<uint8_t N>
class VolumeControl< N >
A class for controlling the volume of AudioMixer4 objects using a potentiometer.
- Template Parameters
-
- Examples
- 1.Volume-Controlled-USB-DAC.ino, and 2.VU-Meter-OLED-USB-DAC.ino.
Definition at line 23 of file VolumeControl.hpp.
|
void | enable () |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
void | disable () |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
bool | isEnabled () const |
| Check if this updatable is enabled.
|
|
void | moveDown () |
| Move down this element in the list.
|
|
static void | enable (UpdatableCRTP *element) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
static void | enable (UpdatableCRTP &element) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
template<class U , size_t N> |
static void | enable (U(&array)[N]) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
static void | disable (UpdatableCRTP *element) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
static void | disable (UpdatableCRTP &element) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
template<class U , size_t N> |
static void | disable (U(&array)[N]) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
|
static void | beginAll () |
| Begin all enabled instances of this class.
|
|
static void | updateAll () |
| Update all enabled instances of this class.
|
|
◆ VolumeControl()
Create a new VolumeControl object.
- Parameters
-
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.
◆ update()
◆ begin()
◆ map()
Specify a mapping function that is applied to the raw analog value before setting the volume.
- Parameters
-
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. |
- See also
- FilteredAnalog::map
Definition at line 70 of file VolumeControl.hpp.
◆ invert()
◆ beginAll()
template<class T = NormalUpdatable>
◆ updateAll()
template<class T = NormalUpdatable>
static void updateAll |
( |
| ) |
|
|
inlinestaticinherited |
◆ enable() [1/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 96 of file Updatable.hpp.
◆ enable() [2/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 125 of file Updatable.hpp.
◆ enable() [3/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 127 of file Updatable.hpp.
◆ enable() [4/4]
template<class Derived >
template<class U , size_t N>
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 130 of file Updatable.hpp.
◆ disable() [1/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 106 of file Updatable.hpp.
◆ disable() [2/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 136 of file Updatable.hpp.
◆ disable() [3/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 138 of file Updatable.hpp.
◆ disable() [4/4]
template<class Derived >
template<class U , size_t N>
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 141 of file Updatable.hpp.
◆ isEnabled()
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 120 of file Updatable.hpp.
◆ moveDown()
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
◆ mixers
template<uint8_t N>
Array<AudioMixer4 *, N> mixers |
|
private |
◆ filteredAnalog
◆ maxGain
◆ updatables
◆ next
◆ previous
The documentation for this class was generated from the following file: