DOLY-DIY/cpp/_sound_control_8h_source.html

#pragma once

#include "SoundEvent.h"


enum class SoundState :uint8_t

{

    SET,

    STOP,

    PLAY

};


namespace SoundControl

{

    int8_t init();


    int8_t dispose();


    int8_t play(std::string file_name, uint16_t id);


    void Abort();


    SoundState getState();


    bool isActive();


    int8_t setVolume(uint8_t volume);


    float getVersion();


};


SoundState
SoundState
Sound activity state.
Definition SoundControl.h:29

SoundState::STOP
@ STOP
Definition SoundControl.h:31

SoundState::PLAY
@ PLAY
Definition SoundControl.h:32

SoundState::SET
@ SET
Definition SoundControl.h:30

SoundEvent.h
Event registration helpers for the sound subsystem.

SoundControl
Definition SoundControl.h:36

SoundControl::setVolume
int8_t setVolume(uint8_t volume)
Set playback volume as a percentage.

SoundControl::getState
SoundState getState()
Get current sound playback state.

SoundControl::isActive
bool isActive()
Check whether the sound subsystem is active (initialized).

SoundControl::getVersion
float getVersion()
Get current library version.

SoundControl::dispose
int8_t dispose()
Dispose/stop the sound subsystem and release resources.

SoundControl::init
int8_t init()
Initialize sound control.

SoundControl::Abort
void Abort()
Abort the currently playing sound (if any).

SoundControl::play
int8_t play(std::string file_name, uint16_t id)
Start playing a sound file (non-blocking).