3.3 Getting Information About Banks

In this section we explain the functions that can be used to obtain organizational information when you are handling a number of sample banks and sound effect banks.

The function you use to get the address of the current default sample bank is MusPtrBankGetCurrent. Note that this function is not affected by any override.


Get the default sample bank
Function name: MusPtrBankGetCurrent
Syntax: void *MusPtrBankGetCurrent(void)
Arguments: None
Return value: Address of sample bank


The function you use to get the address of the current default sound-effect bank is MusFxBankGetCurrent. Note that this function is not affected by any override.


Get the default sound effect bank
Function name: MusFxBankGetCurrent
Syntax: void *MusFxBankGetCurrent(void)
Arguments: None
Return value: Address of sound effect bank


The function you use to get the address of the default sample bank that is set in the sound effect bank is MusFxBankGetPtrBank. Note that this function is not effected by any override.


Get the sound-effect bank's default sample bank
Function name: MusFxBankGetPtrBank
Syntax: void *MusFxBankGetPtrBank(void *ifxbank)
Arguments: ifxbank  Address of an initialized sound effect bank
Return value: Address of sample bank


The function used to get the address of the sample bank being used by the currently playing songs or sound effects is MusHandleGetPtrBank.


Get the address of currently playing sample bank
Function name: MusHandleGetPtrBank
Syntax: void *MusHandleGetPtrBank(musHandle handle)
Arguments: handle Sound handle
Return value: Address of sample bank