sound.h File Reference

Menu Sound. More...

Go to the source code of this file.

Macros
#define	SOUND_MP3_PLAYER_CHANNEL   (0)
#define	SOUND_SFX_CHANNEL   (2)

Enumerations
enum	sound_effect_t {   SFX_CURSOR , SFX_ERROR , SFX_ENTER , SFX_EXIT ,   SFX_SETTING }
	Enumeration of available sound effects for menu interactions. More...

Functions
void	sound_init_default (void)
	Initialize the default sound system.
void	sound_init_mp3_playback (void)
	Initialize the MP3 playback system.
void	sound_init_sfx (void)
	Initialize the sound effects system.
void	sound_use_sfx (bool enable)
	Enable or disable sound effects.
void	sound_play_effect (sound_effect_t sfx)
	Play a specified sound effect.
void	sound_deinit (void)
	Deinitialize the sound system.
void	sound_poll (void)
	Poll the sound system.

Detailed Description

Menu Sound.

Macro Definition Documentation

SOUND_MP3_PLAYER_CHANNEL

#define SOUND_MP3_PLAYER_CHANNEL   (0)

Channel for MP3 player sound

SOUND_SFX_CHANNEL

#define SOUND_SFX_CHANNEL   (2)

Channel for sound effects

Enumeration Type Documentation

sound_effect_t

enum sound_effect_t

Enumeration of available sound effects for menu interactions.

This enumeration defines the different sound effects that can be used for menu interactions.

Enumerator
SFX_CURSOR	Sound effect for cursor movement
SFX_ERROR	Sound effect for error
SFX_ENTER	Sound effect for entering a menu
SFX_EXIT	Sound effect for exiting a menu
SFX_SETTING	Sound effect for changing a setting

Function Documentation

sound_init_default()

void sound_init_default

(

void

)

Initialize the default sound system.

This function initializes the default sound system, setting up necessary resources and configurations.

sound_init_mp3_playback()

void sound_init_mp3_playback

(

void

)

Initialize the MP3 playback system.

This function initializes the MP3 playback system, preparing it for playing MP3 files.

Initialize the MP3 playback system.

sound_init_sfx()

void sound_init_sfx

(

void

)

Initialize the sound effects system.

This function initializes the sound effects system, setting up necessary resources and configurations for playing sound effects.

Initialize the sound effects system.

sound_use_sfx()

void sound_use_sfx

(

bool

state

)

Enable or disable sound effects.

Parameters

enable	True to enable sound effects, false to disable.
state	True to enable, false to disable.

sound_play_effect()

void sound_play_effect

(

sound_effect_t

sfx

)

Play a specified sound effect.

Parameters

sfx	The sound effect to play, as defined in sound_effect_t.

Play a specified sound effect.

Parameters

sfx	The sound effect to play.

sound_deinit()

void sound_deinit

(

void

)

Deinitialize the sound system.

This function deinitializes the sound system, releasing any resources that were allocated.

sound_poll()

void sound_poll

(

void

)

Poll the sound system.

This function polls the sound system, updating its state as necessary.

Poll the sound system.