Audio module

Contents

Music for your ears, provided by Maxmod.

Modules

module Music
module Sound effects

Files

file bn_audio.h
file bn_audio_mixing_rate.h
file bn_config_audio.h

Namespaces

namespace bn
Main Butano namespace.
namespace bn::audio
Audio related functions.

Defines

#define BN_AUDIO_MIXING_RATE_8_KHZ
#define BN_AUDIO_MIXING_RATE_10_KHZ
#define BN_AUDIO_MIXING_RATE_13_KHZ
#define BN_AUDIO_MIXING_RATE_16_KHZ
#define BN_AUDIO_MIXING_RATE_18_KHZ
#define BN_AUDIO_MIXING_RATE_21_KHZ
#define BN_AUDIO_MIXING_RATE_27_KHZ
#define BN_AUDIO_MIXING_RATE_31_KHZ
#define BN_CFG_AUDIO_MIXING_RATE
#define BN_CFG_AUDIO_MAX_COMMANDS

Define documentation

#define BN_AUDIO_MIXING_RATE_8_KHZ

8KHz mixing rate, provides poor quality.

#define BN_AUDIO_MIXING_RATE_10_KHZ

10Khz mixing rate, provides low quality.

#define BN_AUDIO_MIXING_RATE_13_KHZ

13Khz mixing rate, provides almost OK quality.

#define BN_AUDIO_MIXING_RATE_16_KHZ

16Khz mixing rate, provides OK quality, standard setting.

#define BN_AUDIO_MIXING_RATE_18_KHZ

18Khz mixing rate, provides better quality, high CPU load.

#define BN_AUDIO_MIXING_RATE_21_KHZ

21Khz mixing rate, provides even better quality, higher CPU load.

#define BN_AUDIO_MIXING_RATE_27_KHZ

27Khz mixing rate, provides almost the best quality, almost the highest CPU load.

#define BN_AUDIO_MIXING_RATE_31_KHZ

31Khz mixing rate, provides the best quality, highest CPU load.

#define BN_CFG_AUDIO_MIXING_RATE

Specifies software audio mixing rate in KHz.

Values not specified in BN_AUDIO_MIXING_RATE_* macros are not allowed.

#define BN_CFG_AUDIO_MAX_COMMANDS

Specifies the size of the audio commands queue.

This queue is processed and cleared when bn::core::update() is called.