NNS_SndPlayerSetTrackMute

C Specification

#include <nnsys/snd.h>
void NNS_SndPlayerSetTrackMute(
NNSSndHandle*   handle,
u16 trackBitMask,
BOOL flag );

Arguments

handle The sound handle pointer.
trackBitMask This is the track bit mask.
flag Flag to indicate whether to mute or cancel. When TRUE, mute is applied; when FALSE, mute is canceled.

Return Values

None.

Description

This function mutes and stops a sequence track.

The sequence track bound to the Sound Handle is muted and stopped. This function does not perform any action if the stream handle is invalid.

trackBitMask specifies the track to be set. The tracks are identified from the lower bit in sequence: Track 0, Track 1, Track 2 .... All tracks that have enabled bits will have their mute settings changed. For example, to change the mute settings of Track 2 and Track 5, use (1 << 2) | (1 << 5); i.e., 0x0024.

Note

When a track is muted, all sounds that are being played are forcibly stopped and no further sounds will be played. If mute is canceled, sound will be produced but not begin to play immediately. Note that sound will begin to play on the next note-on.

See Also

None.

Revision History

06/01/2004 Revised to state that the Sound Handle binds to the sequence.

04/01/2004 Initial version.