Arduboy Documentation

Audio

The audio APIs exist to help play sound and manage the audio hardware.

The included audio API

The audio API in the base Arduboy library only exists to set up the hardware to play audio and store the user's preference on whether to play audio to persistent memory. If the default begin function is called on an Arduboy class instance, an instance of this audio API is initialized to set up the hardware.

If you skipped calling the begin function you will need to initialize the audio instance yourself, as follows:

#include <Arduboy.h>

Arduboy arduboy;

void setup ()
{
  arduboy.boot();
  arduboy.audio.begin();
}

ArduboyTunes class

The ArduboyTunes class provides more useful methods for playing audio. It offers the ability to play scores, have two audio channels, and play individual notes or tones. This class is included with the core library.

Examples on using the ArduboyTunes class go here...

The ArduboyTunes score format

How to write data for the playScore function goes here...