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