nw::snd::StreamSoundHandle::SetTrackPan Member Function

Syntax

#include <nw/snd/snd_StreamSoundHandle.h>
void SetTrackPan(
     u32 trackBitFlag,
     f32 pan
);

Arguments

Name Description
in trackBitFlag Bit flag for each track.
in pan Relative change in the pan with 0.0 as the base value.

Return Values

None.

Description

Changes the pan (lateral localization) of a streaming sound's tracks.

Changes the pan of streaming tracks 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 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.

pan specifies a value representing the relative change in the location of the sound. If 0.0 is specified, the pan value set within data is unchanged. When 1.0 is specified, a sound located at the center will be located at the far right, and when -1.0 is specified, a sound that located at the center will be located at the far left. The default value is 0.0.

Revision History

2010/01/22
Initial version.

CONFIDENTIAL