N64® Functions Menu

al - Audio Library Functions
gDP - DP GBI Macros
gdSP - General GBI Macros
gSP - SP GBI Macros
gt - Turbo Microcode RDP
gu - Graphics Utilities
Math - Math Functions
Mus - Mus Library
nuSys - NuSystem
os - N64 Operating System
sp - Sprite Library Functions
uh - Host to Target IO
64DD - N64 Disk Drive

Nintendo® Confidential

Mus Library Reference

## MusHandleStop()

Stop channels using a sound handle.

Syntax

      int MusHandleStop(musHandle handle, int speed);

Arguments

- handle is the sound handle

- speed is the number of video frames before channels are silenced

Explanation
Stop and silence the channels associated with the specified sound handle in a specified amount of time. This function allows the programmer to stop songs and sound effects, which frees the channels associated with them.

The handle must be a sound handle returned by MusStartSong(), MusStartEffect() or MusStartEffect2(). If an handle of zero is supplied, this function will always return zero.

The speed value is the number of video frames before the channel will be stopped. Any positive integer is valid. A value of zero will stop the sound handle's channels immediately.

Return Value
Number of channels set to stop.

Example

      void StopSpecificSound(unsigned long handle, int time);
      {
        MusHandleStop(handle, time);
        while (MusHandleAsk(handle))
          CallNormalProcessing();
      }

See Also
MusStartSong()
MusStartEffect()
MusStartEffect2()

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