Mus Library Reference

MusFxBankGetPtrBank()

Get the sound effect bank sample bank override.

Syntax

  void *MusFxBankGetPtrBank(void *ifxbank);

Arguments

• ifxbank is the address of an initialized sound effect bank

Explanation
Get the sample bank override associated with the specified initialized sound effect bank. If no sample bank override has been set for the specified sound effect bank, this function will return NULL.

The default sample bank is used when the MusStartEffect() or the MusStartEffect2() function is used to start sound effects, if no sample bank override has been defined. If a sample bank override has been specified with the MusFxBankSetPtrBank() function for the effect bank to which the triggering sound effect belongs, then the MusFxBankSetPtrBank() will be used, unless a higher priority override has been defined using the MusPtrBankSetSingle() function.

The ifxbank must contain the address of a sound effect bank initialized with the MusFxBankInitialize() function.

Return Value
Sample bank address or NULL.

Example

  void GameFxBankSetDefault(void *fx_bank)
  {
    void *ptr_bank;

    ptr_bank = MusFxBankGetPtrBank(fx_bank);
    MusPtrBankSetCurrent(ptr_bank);
  }

See Also
MusFxBankInitialize()
MusFxBankNumberOfEffects()
MusFxBankGetCurrent()
MusFxBankSetCurrent()
MusFxBankSetPtrBank()
MusFxBankSetSingle()

Nintendo® Confidential Warning: all information in this document is confidential and covered by a non-disclosure agreement. You are responsible for keeping this information confidential and protected. Nintendo will vigorously enforce this responsibility. Copyright © 1998-1999 Nintendo of America Inc. All rights reserved Nintendo and N64 are registered trademarks of Nintendo Last updated March 1999