nw::snd::SequenceSoundHandle::SetTrackMute Member Function

#include <nw/snd/snd_SequenceSoundHandle.h>

void SetTrackMute(
     u32 trackBitFlag,
     SeqMute mute
);

void SetTrackMute(
     u32 trackBitFlag,
     bool muteFlag
);

Changes the muting of the sound sequence track associated with the handle. This function does not perform any action if the stream handle is invalid.

The trackBitFlag argument specifies the track. 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.

When a track is muted, the note on command can no longer be executed on the specified track after that point.

Whether the sound is stopped depends on the specification made with SeqMute. 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.

Much like mute status, silent status (SetTrackSilence) is available to turn off the volume of tracks. Mute status and silent status can be set separately. If both are set, a track not produce sound until both are cancelled.

Changes the muting of the sound sequence track associated with the handle. This function does not perform any action if the stream handle is invalid.

The trackBitFlag argument specifies the track. 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.

When a track is muted, the note on command can no longer be executed on the specified track after that point.

Setting muteFlag to true mutes the sequence track. At the same time, the sound reproduced by that track is immediately stopped. (This is the same as MUTE_STOP used with SeqMute.)

Setting muteFlag to false cancels muting.

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.

Much like mute status, silent status (SetTrackSilence) is available to turn off the volume of tracks. Mute status and silent status can be set separately. If both are set, a track not produce sound until both are cancelled.