|
Maxmod
|
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. | |
| mm_word | mmJingleStart (mm_word module_ID, mm_pmode mode) |
| Plays a jingle. | |
| void | mmJingleStop (void) |
| Stops playback of the active jingle. | |
| void | mmSetJinglePitch (mm_word pitch) |
| Change the master pitch scale for jingle playback. | |
| void | mmSetJingleTempo (mm_word tempo) |
| Change the master tempo for jingle playback. | |
| void | mmSetJingleVolume (mm_word volume) |
| Use this function to change the master volume scale for jingle playback. | |
|
inlinestatic |
Check if a jingle is playing or not.
|
inlinestatic |
Plays a jingle.
| module_ID | Index of module to be played. (Defined in soundbank header) |
| mm_bool mmJingleActive | ( | void | ) |
Check if a jingle is playing or not.
| void mmJinglePause | ( | void | ) |
Pauses playback of the active jingle.
Resume with mmJingleResume().
| void mmJingleResume | ( | void | ) |
Resume jingle playback.
Pause with mmJinglePause().
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.
Note that jingles must be limited to 4 channels only.
| 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). |
| 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.
| void mmSetJinglePitch | ( | mm_word | pitch | ) |
Change the master pitch scale for jingle playback.
Specifying 1024 will play the jingle at its normal pitch. Minimum/Maximum range of the pitch change is +-1 octave.
Range = 0x200 -> 0x800 = 0.5 -> 2.0
| pitch | New pitch scale. Value = 1024 * 2^(semitones/12) |
| void mmSetJingleTempo | ( | mm_word | tempo | ) |
Change the master tempo for jingle playback.
Specifying 1024 will play the jingle at its normal speed. Minimum and maximum values are 50% (512) and 200% (2048). Note that increasing the tempo will also increase the jingle processing load.
It uses a fixed point (Q10) value representing tempo.
Range = 0x200 -> 0x800 = 0.5 -> 2.0
| tempo | New tempo value. Tempo = (speed_percentage * 1024) / 100. |
| void mmSetJingleVolume | ( | mm_word | volume | ) |
Use this function to change the master volume scale for jingle playback.
| volume | New volume level. Ranges from 0 (silent) to 1024 (normal). |