nw::snd::StreamSoundHandle::SetTrackSurroundPan Member Function

Syntax

#include <nw/snd/snd_StreamSoundHandle.h>

void SetTrackSurroundPan(
     u32 trackBitFlag,
     f32 surroundPan
);

Arguments

Name Description
in trackBitFlag Bit flag for each track.
in surroundPan Relative change in the surround pan, taking 0.0 as a reference point.

Return Values

None.

Description

Changes the surround pan (front-back position) of a track in a stream sound.

Changes the surround pan of a stream track in the sound associated with the handle. If the handle is invalid, the function does nothing.

The value specified by this function operates independently of other surround pan parameters, which are all layered.

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.

surroundPan specifies a value representing the relative change in the location of the sound. Pitch does not change when 0.0 is specified. If 1.0 is specified, a sound located in the center is relocated to the front. If 2.0 is specified, a sound located in the center is relocated to the back. Specify a negative number if you wish to move the location toward the front. The default value is 0.0.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL