nw::snd::SoundPlayer Classclass SoundPlayer
A class used to play sounds.
Call SoundArchivePlayer::GetSoundPlayer to get an instance of the SoundPlayer class.
A single SoundPlayer can play multiple sounds. You can set the number of sounds that can be played simultaneously; if this number is exceeded, the player priorities assigned to each sound are compared and the sound with the lowest priority is stopped.
| Constructors/Destructors | ||
|---|---|---|
| SoundPlayer | Constructor. | |
| ~SoundPlayer | Destructor. | |
| Update | ||
| Update | Updates the sound player. | |
| Playback control | ||
| StopAllSound | Stops all sounds. | |
| PauseAllSound | Pauses or restarts all sounds. | |
| Setting, Getting Parameters | ||
| SetVolume | Changes a player's volume. | |
GetVolume
|
Gets a player's audio volume. | |
| SetMainSend | Changes the send volume to the player's main output. | |
| GetMainSend | Gets the send volume to the main output that is set for the player. | |
| SetFxSend | Changes the send volume to the player's effect. | |
| GetFxSend | Gets the send volume to the effect set for the player. | |
GetPlayingSoundCount
|
Returns the number of sounds currently playing in the player. | |
SetPlayableSoundCount
|
Sets the number of sounds that are simultaneously playable. | |
GetPlayableSoundCount
|
Gets the number of sounds that can be simultaneously played by the player. | |
| Other | ||
| ForEachSound | Performs the processing for all sound currently playing on the player. | |
| ForEachSoundPriorityOrder | Performs the processing for all sound currently playing on the player in order of priority. | |
CONFIDENTIAL