nw::snd::WaveSoundHandle Class

Header file: nw/snd/snd_WaveSoundHandle.h

Syntax

class WaveSoundHandle

Description

A handle class used to control wave sounds that are played back.

If the sound is bound to the general-purpose sound handle SoundHandle at time of playback, unique processing for the wave sound is not implemented for the general-purpose handle.

If you want to execute a unique process for the wave sound, be sure to use a wave sound handle created using a contructor that takes the general-purpose sound handle as an argument.

Handles are used like the general-purpose sound handle SoundHandle.

Member Functions

Constructors/Destructors
WaveSoundHandle Constructor.
~WaveSoundHandle Destructor.
Play, Stop, Pause, Resume
StartPrepared Plays the sound whose preparation for playback has completed.
Stop Stops the sound.
Pause Pauses or restarts a sound.
IsPrepared Checks whether preparation for sound playback is complete.
IsPause Checks whether the sound is currently paused.
FadeIn Fades in the sound when playback starts.
Updating Parameters
SetVolume Changes the volume of the sound.
SetPitch Changes the pitch of the sound.
SetPan Changes the pan (right/left location) of the sound.
SetPlayerPriority Changes the player priority.
SetMainSend Changes the main send volume of the sound.
SetFxSend Changes the effect send volume of the sound.
SetChannelPriority Changes the voicing priority.
Sets or gets handle control information.
IsAttachedSound Checks whether there is a sound associated with the handle.
DetachSound Frees sounds from handles.
Get/Set Information
SetId Sets the ID of a sound.
GetId Gets the sound's ID.
ReadWaveSoundDataInfo Obtains the wave sound data information.
GetPlaySamplePosition Gets the playback position for the wave sound data currently playing.

See Also

SoundHandle Class

Revision History

2010/01/22
Initial version.

CONFIDENTIAL