nw::snd::SoundArchivePlayer Class

Header file: nw/snd/snd_SoundArchivePlayer.h

Syntax

class SoundArchivePlayer : public nw::snd::SoundStartable

Description

A class that plays back sounds in a sound archive.

The sounds played back by the SoundArchivePlayer can be controlled using the handle class.

Member Functions

Constructors/Destructors
SoundArchivePlayer Constructor.
V ~SoundArchivePlayer Destructor.
Initialization
GetRequiredMemSize Gets the size of memory required for initialization.
GetRequiredStreamBufferSize Gets the size of the stream buffer required for initialization.
Initialize Initializes a sound archive player.
Finalize Destroys a sound archive player.
IsAvailable Checks availability for use.
Update
Update Updates the sound archive player.
Other
GetSoundArchive Gets the sound archive bound to a player.
GetSoundPlayer Gets the sound player with the specified ID.
GetSoundPlayerCount Gets the number of sound players.
GetFreeSequenceSoundCount Retrieves the remaining number of playable sequence sounds.
GetFreeWaveSoundCount Retrieves the remaining number of playable wave sounds.
GetFreeStreamSoundCount Retrieves the remaining number of playable stream sounds.
SetSequenceUserprocCallback Registers the callback function invoked by the userproc sequence command.
Play
StartSound Plays the sound having the specified ID.(Inherited from SoundStartable.
HoldSound Plays or continues the sound with the specified ID.(Inherited from SoundStartable.
PrepareSound Prepares to play the sound with the specified ID.(Inherited from SoundStartable.

Class Hierarchy

nw::snd::SoundStartable
  nw::snd::SoundArchivePlayer

See Also

SoundHandle Class
SoundStartable Interface

Revision History

2010/01/15
Initial version.

CONFIDENTIAL