HBMSoundCallback Type

Syntax


#include <revolution/hbm.h>

/* Declaration of callback function for sound */
typedef int (*HBMSoundCallback)( int evt, int num );

Arguments

`evt`	Value that indicates the event that called the callback function.
`num`	Value that indicates which button sound to play.

Return Values

Returns HBMSEV_RET_XXX enumerator value for sound callback function call.

Description

This is the callback function declaration used when playing sound effects for an application. It is called by the library at the time the sound effect is played. The value of the HBMSEV_XXX enumerator passed using evt indicates which event caused the call.
The following values are passed in num depending on the value of evt.

HBMSEV_BEFORE_INIT_SOUND
HBMSEV_INIT_SOUND
HBMSEV_END_MENU Always passes zero.

HBMSEV_BEGIN_EXIT_ANIM
HBMSEV_BEGIN_BLACKOUT
HBMSEV_BEGIN_BLACKOUT_TO_MANUAL Passes the number of frames required to black out the HOME Menu.

HBMSEV_PLAY_SOUND Passes the type of sound effect to be played by the application according to the value of the HBMSE_XXX enumerator.

HBMSEV_BEFORE_INIT_SOUND HBMSEV_INIT_SOUND HBMSEV_END_MENU	Always passes zero.
HBMSEV_BEGIN_EXIT_ANIM HBMSEV_BEGIN_BLACKOUT HBMSEV_BEGIN_BLACKOUT_TO_MANUAL	Passes the number of frames required to black out the HOME Menu.
HBMSEV_PLAY_SOUND	Passes the type of sound effect to be played by the application according to the value of the `HBMSE_XXX` enumerator.

Revision History

2007/10/26: Revised the header explanation.
2006/10/19: Added HBMSEV_BEGIN_BLACKOUT_TO_MANUAL to Description.
2006/10/06: Changed the return values.
2006/10/02: Changed the arguments.
2006/09/25: Initial version.