nw::snd::SequenceSoundHandle::SetTrackSilence Member Function

#include <nw/snd/snd_SequenceSoundHandle.h>

void SetTrackSilence(
     u32 trackBitFlag,
     bool silenceFlag,
     int fadeTimes
);

	Name	Description
in	trackBitFlag	Bit flag for each track.
in	silenceFlag	Specify true when a track is put in silent status; false when silent status is cancelled.
in	fadeTimes	Fade time (in milliseconds) to be applied when changing the silent status.

None.

Places a sequence sound track in silent status, or cancels silent status.

Changes the silent status 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. Tracks are identified from the lower bit in sequence; for example, Track 0, Track 1, Track 2 and so on. The silent status will change for all tracks with enabled bits. For example, to change the silent status of Track 2 and Track 5, use (1 << 2) | (1 << 5); i.e., 0x0024.

Silent status is simlar to mute status (SetTrackMute). Sound is no longer output for a track that is in mute status because the note on processing is not performed. Although note on processing can be performed for a track in silent status, it can be set to not produce sound by setting the volume to zero. This allows for sound to suddenly begin playing midway through a note when silent status is canceled.

Note that fadeTimes has an effect only on sounds that are currently being played when this function is called. Consequently, sounds that begin to play during the fade interval (the interval in which previously playing sounds transition to silent status) will begin playing in mute status.

Note: In silent status, voices for which note was performed are used while the sound is off.

Mute status and silent status can be set separately. If both are set, a track not produce sound until both are cancelled.

SetTrackMute

2010/01/22

Initial version.