Aviate Audio Multiverse Library
Public Member Functions | List of all members
Aviate::TunerManager Class Reference

The TunerManager class provides an API to access the Tuner display on the Multiverse hardware screen. More...

#include <TunerManager.h>

Public Member Functions

 TunerManager (Avalon::AvalonHardwareControls &hardwareControls)
 
void setTunerMode (bool enabled)
 Set the TunerMode on the display to on or off. More...
 
bool getTunerMode ()
 Retrieve the tuner mode. More...
 
void sendNoteUpdate (TunerNote note, float cents, bool noFiltering=false)
 Send an update to the tuner display. More...
 

Detailed Description

The TunerManager class provides an API to access the Tuner display on the Multiverse hardware screen.

Important: you do not call the TunerManager constructor. The system constructors and initializes the tuner via tunerManagerPtr. Use this pointer to access the TunerManager.

Member Function Documentation

◆ getTunerMode()

bool Aviate::TunerManager::getTunerMode ( )

Retrieve the tuner mode.

Returns
the current tuner mode

◆ sendNoteUpdate()

void Aviate::TunerManager::sendNoteUpdate ( TunerNote  note,
float  cents,
bool  noFiltering = false 
)

Send an update to the tuner display.

Parameters
notethe nearest note to the detected pitch
centsthe difference in cents to the nearest note. Must be (-50.0f <= cents <= 50.0f)
noFilteringwhen set to true, disableds the built-in smoothing of the displayed results. Use this when you want to do your own custom smoothing of the results in your EFX instead.

◆ setTunerMode()

void Aviate::TunerManager::setTunerMode ( bool  enabled)

Set the TunerMode on the display to on or off.

Parameters
enabledwhen true, the Tuner display mode is enabled, when false, it is disabled.

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