nw::snd::SoundActor Classclass SoundActor : public nw::snd::SoundStartable
A class used to play back and manage multiple sounds together.
A sound actor is expected to be used in association with an in-game character or model. For example, one possible usage is to change the sound orientation of the sound actor associated with a character to match that character's movements.
The parameters set for a sound actor affect all sounds that the actor is playing.
Internally, a sound actor has four actor players. It is possible to limit the number of sounds that can be simultaneously played by each actor player. If the configured sound count is exceeded, the player priorities set for each sound are compared and the sounds with the lowest priority are stopped. The default values for the number of sounds that can be played back simultaneously are defined as follows.
• Actor player #0 is unlimited.
• Everything else is set to 1.
The actor player in which to play a sound is set in the sound data. This information can be overwritten at playback time by using nw::snd::SoundStartable::StartInfo.
| S |
ACTOR_PLAYER_COUNT
|
const int |
The number of actor players that are retained. |
|---|
| Constructors/Destructors | ||
|---|---|---|
SoundActor
|
Constructor. | |
| V |
~SoundActor
|
Destructor. |
| Initialization | ||
Initialize
|
Initialize the sound actor. | |
| Finalize | Destroys the sound actor. | |
| Play | ||
| StopAllSound | Stops all sounds currently playing on the actor. | |
| PauseAllSound | Pauses or restarts all sounds that the actor is currently playing. | |
| protected V |
SetupSound
|
Virtual function called when a sound is played. |
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. |
|
| Setting, Getting Parameters | ||
| SetVolume | Changes the volume of the actor. | |
GetVolume
|
Gets the volume set for the actor. | |
| SetPitch | Changes the pitch of the actor. | |
GetPitch
|
Gets the pitch set for the actor. | |
| SetPan | Changes the pan (left/right orientation) of the actor. | |
| GetPan | Gets the pan set for the actor. | |
GetPlayingSoundCount
|
Returns the number of sounds currently playing in the actor player. | |
SetPlayableSoundCount
|
Sets the number of sounds that are simultaneously playable. | |
GetPlayableSoundCount
|
Gets the number of sounds that can be simultaneously played by the actor player. | |
| Other | ||
| ForEachSound | Performs processing for all sounds that the actor is currently playing. | |
nw::snd::SoundStartable
nw::snd::SoundActor
SoundStartable Class
CONFIDENTIAL