Mus Library Reference

MusPtrBankSetSingle()

Set sample bank single-use override.

Syntax

  void MusPtrBankSetSingle(void *ipbank);

Arguments

• ipbank is the address of an initialized sample pointer bank file

Explanation
Set the address of the override sample bank. If the override is set to NULL, then it is disabled. The sample bank override is used then cleared when the MusStartSong(), MusStartSongFromMarker(), MusStartEffect(), or MusStartEffect2() functions are called.

The default sample bank is used when the MusStartSong() or the MusStartSongFromMarker() functions are used to start songs, if no sample bank override has been defined with the MusPtrBankSetSingle() function.

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

The ipbank must be the address of a sample pointer bank file that has been initialized with the MusPtrBankInitialize() function.

Return Value
None

Example

void StartBankEffect(int effect, void *fx_bank, void *samp_bank)
{
    MusFxBankSetSingle(fx_bank);
    MusPtrBankSetSingle(sample_bank);
    MusStartEffect(effect);
}

See Also
MusPtrBankInitialize()
MusPtrBankSetCurrent()
MusPtrBankGetCurrent()

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