NNS_SndPlayerSetTrackVolume

C Specification

#include <nnsys/snd.h>
void NNS_SndPlayerSetTrackVolume(
NNSSndHandle*   handle,
u16 trackBitMask,
int volume );

Arguments

handle The sound handle pointer.
trackBitMask This is the track bit mask.
volume Volume value. Takes a value between 0 and 127.

Return Values

None.

Description

This function changes the volume of the sequence track.

The track volume of the sequence bound to the Sound Handle is changed. 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 volume changed. For example, to change the volume of Track 2 and Track 5, use (1 << 2) | (1 << 5); i.e., 0x0024.

The default value for volume is the maximum of 127. This value affects all sequence tracks. Furthermore, this value exhibits effects that are independent of all other track volume parameters. The track volume parameters have an cumulative effect.

See Also

None.

Revision History

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

04/01/2004 Initial version.