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
VolumeControl< N > Class Template Reference

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

#include <VolumeControl.hpp>

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

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
 
FilteredAnalog filteredAnalog
 
const float maxGain
 

Static Private Attributes

static DoublyLinkedList< Updatable< Potentiometer > > updatables
 

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.

Constructor & Destructor Documentation

◆ VolumeControl()

template<uint8_t N>
VolumeControl< N >::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()

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

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

Implements Updatable< Potentiometer >.

Definition at line 44 of file VolumeControl.hpp.

◆ begin()

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

Initialize.

Implements Updatable< Potentiometer >.

Definition at line 56 of file VolumeControl.hpp.

◆ map()

template<uint8_t N>
void VolumeControl< N >::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()

template<uint8_t N>
void VolumeControl< N >::invert ( )
inline

Invert the analog value.

Definition at line 73 of file VolumeControl.hpp.

◆ enable() [1/4]

void Updatable< Potentiometer >::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< Potentiometer >::enable ( Updatable< Potentiometer > *  element)
inlinestaticinherited

Definition at line 80 of file Updatable.hpp.

◆ enable() [3/4]

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

Definition at line 82 of file Updatable.hpp.

◆ enable() [4/4]

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

Definition at line 85 of file Updatable.hpp.

◆ disable() [1/4]

void Updatable< Potentiometer >::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< Potentiometer >::disable ( Updatable< Potentiometer > *  element)
inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [3/4]

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

Definition at line 92 of file Updatable.hpp.

◆ disable() [4/4]

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

Definition at line 95 of file Updatable.hpp.

◆ isEnabled()

bool Updatable< Potentiometer >::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< Potentiometer >::beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 68 of file Updatable.hpp.

◆ updateAll()

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

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

Member Data Documentation

◆ mixers

template<uint8_t N>
Array<AudioMixer4 *, N> VolumeControl< N >::mixers
private

Definition at line 76 of file VolumeControl.hpp.

◆ filteredAnalog

template<uint8_t N>
FilteredAnalog VolumeControl< N >::filteredAnalog
private

Definition at line 77 of file VolumeControl.hpp.

◆ maxGain

template<uint8_t N>
const float VolumeControl< N >::maxGain
private

Definition at line 78 of file VolumeControl.hpp.

◆ updatables

DoublyLinkedList< Updatable< Potentiometer > > Updatable< Potentiometer >::updatables
staticprivateinherited

Definition at line 101 of file Updatable.hpp.

◆ next

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

Definition at line 301 of file LinkedList.hpp.

◆ previous

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

Definition at line 302 of file LinkedList.hpp.


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