Skip to content

MiP_Sound

github-actions[bot] edited this page Aug 10, 2026 · 11 revisions

Class MiP_Sound

Manages MiP's sounds.

Members & Functions

Type Signature Description
variable constexpr uint8_t MIP_CMD_PLAY_SOUNDNone MiP protocol command bytes used by the sound subsystem.
variable constexpr uint8_t MIP_CMD_SET_VOLUMENone
variable constexpr uint8_t MIP_CMD_GET_VOLUMENone
variable MiP & m_mipNone
variable uint8_t m_playCommand[1+18]
variable int8_t m_soundIndexNone
variable uint8_t m_playVolumeNone
function MiP_Sound(MiP &mip) Constructs the sound manager.
function void beginList() Starts a new sound list sequence.
function void addEntryToList(MiPSoundIndex sound, uint16_t delay=0, MiPVolume volume=MIP_VOLUME_DEFAULT) Adds a sound (with optional delay and volume change) to the current sound list.
function void playList(uint8_t repeatCount=0) Plays the current sound list.
function void play(MiPSoundIndex sound, MiPVolume volume=MIP_VOLUME_DEFAULT) Plays a single sound at the specified volume.
function void writeVolume(uint8_t volume) Sets the MiP speaker volume and verifies the change.
function uint8_t readVolume() Reads the current speaker volume.
function void end() Cleans up the sound subsystem upon end.
function int8_t rawGetVolume(uint8_t &volume)
function void rawSetVolume(uint8_t volume)

Clone this wiki locally