1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nw::snd::SoundPlayer</title> 51 </head> 52 <body> 53 <h1>nw::snd::SoundPlayer Class</h1> 54 <div class="section"> 55 <b>Header file: </b>nw/snd/snd_SoundPlayer.h</div> 56 <h2>Syntax</h2> 57 <div class="section"> 58 <pre class="definition">class SoundPlayer</pre> 59 </div> 60 <h2>Description</h2> 61 <div class="section"> 62 <p>A class used to play sounds.</p><p>Call <span><span>SoundArchivePlayer::GetSoundPlayer</span></span> to get an instance of the <span><span>SoundPlayer</span></span> class.</p><p>A single <CODE>SoundPlayer</CODE> 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.</p></div> 63 <a name="function" id="function"> 64 <h2>Member Functions</h2> 65 <div class="section"> 66 <table class="members"> 67 <tr> 68 <th class="category" colspan="3">Constructors/Destructors</th> 69 </tr> 70 <tr> 71 <td width="100"> </td> 72 <th> 73 <a href="../../../nw/snd/SoundPlayer/SoundPlayer.html">SoundPlayer</a> 74 </th> 75 <td>Constructor.</td> 76 </tr> 77 <tr> 78 <td width="100"> </td> 79 <th> 80 <a href="../../../nw/snd/SoundPlayer/~SoundPlayer.html">~SoundPlayer</a> 81 </th> 82 <td>Destructor.</td> 83 </tr> 84 <tr> 85 <th class="category" colspan="3">Update</th> 86 </tr> 87 <tr> 88 <td width="100"> </td> 89 <th> 90 <a href="../../../nw/snd/SoundPlayer/Update.html">Update</a> 91 </th> 92 <td>Updates the sound player.</td> 93 </tr> 94 <tr> 95 <th class="category" colspan="3">Playback control</th> 96 </tr> 97 <tr> 98 <td width="100"> </td> 99 <th> 100 <a href="../../../nw/snd/SoundPlayer/StopAllSound.html">StopAllSound</a> 101 </th> 102 <td>Stops all sounds.</td> 103 </tr> 104 <tr> 105 <td width="100"> </td> 106 <th> 107 <a href="../../../nw/snd/SoundPlayer/PauseAllSound.html">PauseAllSound</a> 108 </th> 109 <td>Pauses or restarts all sounds.</td> 110 </tr> 111 <tr> 112 <th class="category" colspan="3">Setting, Getting Parameters</th> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117 <a href="../../../nw/snd/SoundPlayer/SetVolume.html">SetVolume</a> 118 </th> 119 <td>Changes a player's volume.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124 <a href="../../../nw/snd/SoundPlayer/GetVolume.html"><CODE>GetVolume</CODE></a> 125 </th> 126 <td>Gets a player's audio volume.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131 <a href="../../../nw/snd/SoundPlayer/SetMainSend.html">SetMainSend</a> 132 </th> 133 <td>Changes the send volume to the player's main output.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138 <a href="../../../nw/snd/SoundPlayer/GetMainSend.html">GetMainSend</a> 139 </th> 140 <td>Gets the send volume to the main output that is set for the player.</td> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145 <a href="../../../nw/snd/SoundPlayer/SetFxSend.html">SetFxSend</a> 146 </th> 147 <td>Changes the send volume to the player's effect.</td> 148 </tr> 149 <tr> 150 <td width="100"> </td> 151 <th> 152 <a href="../../../nw/snd/SoundPlayer/GetFxSend.html">GetFxSend</a> 153 </th> 154 <td>Gets the send volume to the effect set for the player.</td> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159 <a href="../../../nw/snd/SoundPlayer/GetPlayingSoundCount.html"><CODE>GetPlayingSoundCount</CODE></a> 160 </th> 161 <td>Returns the number of sounds currently playing in the player.</td> 162 </tr> 163 <tr> 164 <td width="100"> </td> 165 <th> 166 <a href="../../../nw/snd/SoundPlayer/SetPlayableSoundCount.html"><CODE>SetPlayableSoundCount</CODE></a> 167 </th> 168 <td>Sets the number of sounds that are simultaneously playable.</td> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173 <a href="../../../nw/snd/SoundPlayer/GetPlayableSoundCount.html"><CODE>GetPlayableSoundCount</CODE></a> 174 </th> 175 <td>Gets the number of sounds that can be simultaneously played by the player.</td> 176 </tr> 177 <tr> 178 <th class="category" colspan="3">Other</th> 179 </tr> 180 <tr> 181 <td width="100"> </td> 182 <th> 183 <a href="../../../nw/snd/SoundPlayer/ForEachSound.html"><CODE>ForEachSound</CODE></a> 184 </th> 185 <td>Performs the processing for all sound currently playing on the player.</td> 186 </tr> 187 <tr> 188 <td width="100"> </td> 189 <th> 190 <a href="../../../nw/snd/SoundPlayer/ForEachSoundPriorityOrder.html">ForEachSoundPriorityOrder</a> 191 </th> 192 <td>Performs the processing for all sound currently playing on the player in order of priority.</td> 193 </tr> </table> 194 </div> 195 </a> 196 <h2>See Also</h2> 197 <div class="section"> 198 <p class="reference"><a href="../../../nw/snd/SoundArchivePlayer/Overview.html">SoundArchivePlayer</a> Class<br /><a href="../../../nw/snd/SoundArchivePlayer/GetSoundPlayer.html">SoundArchivePlayer::GetSoundPlayer</a><br /> </p> 199 </div> 200 <h2>Revision History</h2> 201 <div class="section"> 202 <dl class="history"> 203 <dt>2010/01/15</dt> 204 <dd>Initial version.<br /> 205 </dd> 206 </dl> 207 </div> 208 <hr><p>CONFIDENTIAL</p></body> 209</html>