GBA: Jingle Playback

Functions
static mm_bool	mmActiveSub (void)
	Check if a jingle is playing or not.
static void	mmJingle (mm_word module_ID)
	Plays a jingle.
mm_bool	mmJingleActive (void)
	Check if a jingle is playing or not.
void	mmJinglePause (void)
	Pauses playback of the active jingle.
void	mmJingleResume (void)
	Resume jingle playback.
void	mmJingleStart (mm_word module_ID, mm_pmode mode)
	Plays a jingle.
void	mmJingleStop (void)
	Stops playback of the active jingle.
void	mmSetJingleVolume (mm_word volume)
	Use this function to change the master volume scale for jingle playback.

Detailed Description

Function Documentation

mmActiveSub()

static mm_bool mmActiveSub ( void  )

inlinestatic

Check if a jingle is playing or not.

Deprecated:

Alias of mmJingleActive().

Returns

Returns nonzero if a jingle is actively playing.

mmJingle()

static void mmJingle ( mm_word  module_ID )

inlinestatic

Plays a jingle.

Deprecated:

Use mmJingleStart() instead.

Parameters

module_ID

Index of module to be played. (Defined in soundbank header)

mmJingleActive()

mm_bool mmJingleActive

(

void

)

Check if a jingle is playing or not.

Returns

Returns nonzero if a jingle is actively playing.

mmJinglePause()

void mmJinglePause

(

void

)

Pauses playback of the active jingle.

Resume with mmJingleResume().

mmJingleResume()

void mmJingleResume

(

void

)

Resume jingle playback.

Pause with mmJinglePause().

mmJingleStart()

void mmJingleStart	(	mm_word	module_ID,
		mm_pmode	mode
	)

Plays a jingle.

Jingles are normal modules that can be mixed with the normal module playback.

For GBA, the module is read directly from the cartridge space. For jingles, the playback mode is fixed to MM_PLAY_ONCE.

Note that jingles must be limited to 4 channels only.

Parameters

module_ID	Index of module to be played. (Defined in soundbank header)
mode	Mode of playback. Can be MM_PLAY_LOOP (play and loop until stopped manually) or MM_PLAY_ONCE (play until end).

mmJingleStop()

void mmJingleStop

(

void

)

Stops playback of the active jingle.

Start again (from the beginning) with mmJingleStart().

Any channels used by the active module will be freed.

mmSetJingleVolume()

void mmSetJingleVolume

(

mm_word

volume

)

Use this function to change the master volume scale for jingle playback.

Parameters

volume

New volume level. Ranges from 0 (silent) to 1024 (normal).