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::SequenceSoundHandle</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::SequenceSoundHandle</CODE> Class</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_SequenceSoundHandle.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class SequenceSoundHandle</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>A handle class used to control sequence sounds that are played back.</p><p>If the sound is bound to the general-purpose sound handle <a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> at time of playback, unique processing for the sequence sound is not implemented for the general-purpose handle.</p><p>If you want to execute a unique process for the sequence sound, be sure to use a sequence sound handle created using a contructor that takes the general-purpose sound handle as an argument.</p><p>Handles are used like the general-purpose sound handle <CODE><A href="../SoundHandle/snd_SoundHandle_Overview.html">SoundHandle</A></CODE>.</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/SequenceSoundHandle/SequenceSoundHandle.html">SequenceSoundHandle</a> 72 </th> 73 <td>Constructor.</td> 74 </tr> 75 <tr> 76 <td width="100"> </td> 77 <th> 78 <a href="../../../nw/snd/SequenceSoundHandle/~SequenceSoundHandle.html">~SequenceSoundHandle</a> 79 </th> 80 <td>Destructor.</td> 81 </tr> 82 <tr> 83 <th class="category" colspan="3">Play, Stop, Pause, Resume</th> 84 </tr> 85 <tr> 86 <td width="100"> </td> 87 <th> 88 <a href="../../../nw/snd/SequenceSoundHandle/StartPrepared.html">StartPrepared</a> 89 </th> 90 <td>Waits for playback preparations to complete, and plays the sound.</td> 91 </tr> 92 <tr> 93 <td width="100"> </td> 94 <th> 95 <a href="../../../nw/snd/SequenceSoundHandle/Stop.html"><CODE>Stop</CODE></a> 96 </th> 97 <td>Stops the sound.</td> 98 </tr> 99 <tr> 100 <td width="100"> </td> 101 <th> 102 <a href="../../../nw/snd/SequenceSoundHandle/Pause.html">Pause</a> 103 </th> 104 <td>Pauses or restarts a sound.</td> 105 </tr> 106 <tr> 107 <td width="100"> </td> 108 <th> 109 <a href="../../../nw/snd/SequenceSoundHandle/IsPrepared.html">IsPrepared</a> 110 </th> 111 <td>Checks whether preparation for sound playback is complete.</td> 112 </tr> 113 <tr> 114 <td width="100"> </td> 115 <th> 116 <a href="../../../nw/snd/SequenceSoundHandle/IsPause.html">IsPause</a> 117 </th> 118 <td>Checks whether the sound is currently paused.</td> 119 </tr> 120 <tr> 121 <td width="100"> </td> 122 <th> 123 <a href="../../../nw/snd/SequenceSoundHandle/FadeIn.html">FadeIn</a> 124 </th> 125 <td>Fades in the sound when playback starts.</td> 126 </tr> 127 <tr> 128 <th class="category" colspan="3">Updating Parameters</th> 129 </tr> 130 <tr> 131 <td width="100"> </td> 132 <th> 133 <a href="../../../nw/snd/SequenceSoundHandle/SetVolume.html">SetVolume</a> 134 </th> 135 <td>Changes the volume of the sound.</td> 136 </tr> 137 <tr> 138 <td width="100"> </td> 139 <th> 140 <a href="../../../nw/snd/SequenceSoundHandle/SetPitch.html">SetPitch</a> 141 </th> 142 <td>Changes the pitch of the sound.</td> 143 </tr> 144 <tr> 145 <td width="100"> </td> 146 <th> 147 <a href="../../../nw/snd/SequenceSoundHandle/SetPan.html">SetPan</a> 148 </th> 149 <td>Changes the pan (right/left location) of the sound.</td> 150 </tr> 151 <tr> 152 <td width="100"> </td> 153 <th> 154 <a href="../../../nw/snd/SequenceSoundHandle/SetPlayerPriority.html">SetPlayerPriority</a> 155 </th> 156 <td>Changes the player priority.</td> 157 </tr> 158 <tr> 159 <td width="100"> </td> 160 <th> 161 <a href="../../../nw/snd/SequenceSoundHandle/SetMainSend.html">SetMainSend</a> 162 </th> 163 <td>Changes the main send volume of the sound.</td> 164 </tr> 165 <tr> 166 <td width="100"> </td> 167 <th> 168 <a href="../../../nw/snd/SequenceSoundHandle/SetFxSend.html">SetFxSend</a> 169 </th> 170 <td>Changes the effect send volume of the sound.</td> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175 <a href="../../../nw/snd/SequenceSoundHandle/SetChannelPriority.html">SetChannelPriority</a> 176 </th> 177 <td>Changes the voicing priority.</td> 178 </tr> 179 <tr> 180 <td width="100"> </td> 181 <th> 182 <a href="../../../nw/snd/SequenceSoundHandle/SetTempoRatio.html">SetTempoRatio</a> 183 </th> 184 <td>Changes the ratio of the tempo of the sequence sound.</td> 185 </tr> 186 <tr> 187 <th class="category" colspan="3">Sequence Variables</th> 188 </tr> 189 <tr> 190 <td width="100"> </td> 191 <th> 192 <a href="../../../nw/snd/SequenceSoundHandle/ReadVariable.html">ReadVariable</a> 193 </th> 194 <td>Reads sequence local variables.</td> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199 <a href="../../../nw/snd/SequenceSoundHandle/ReadTrackVariable.html">ReadTrackVariable</a> 200 </th> 201 <td>Reads sequence command track variables.</td> 202 </tr> 203 <tr> 204 <td width="100"> </td> 205 <th> 206 <a href="../../../nw/snd/SequenceSoundHandle/WriteVariable.html">WriteVariable</a> 207 </th> 208 <td>Writes the sequence local variable.</td> 209 </tr> 210 <tr> 211 <td width="100"> </td> 212 <th> 213 <a href="../../../nw/snd/SequenceSoundHandle/WriteTrackVariable.html">WriteTrackVariable</a> 214 </th> 215 <td>Writes the sequence track variable.</td> 216 </tr> 217 <tr> 218 <td width="100"> 219 <span class="static_style" title="static">S</span> </td> 220 <th> 221 <a href="../../../nw/snd/SequenceSoundHandle/ReadGlobalVariable.html">ReadGlobalVariable</a> 222 </th> 223 <td>Reads sequence global variables.</td> 224 </tr> 225 <tr> 226 <td width="100"> 227 <span class="static_style" title="static">S</span> </td> 228 <th> 229 <a href="../../../nw/snd/SequenceSoundHandle/WriteGlobalVariable.html">WriteGlobalVariable</a> 230 </th> 231 <td>Writes the sequence global variable.</td> 232 </tr> 233 <tr> 234 <th class="category" colspan="3">track parameter settings</th> 235 </tr> 236 <tr> 237 <td width="100"> </td> 238 <th> 239 <a href="../../../nw/snd/SequenceSoundHandle/SetTrackMute.html">SetTrackMute</a> 240 </th> 241 <td>Mutes sequence sound tracks. Or cancels mute.</td> 242 </tr> 243 <tr> 244 <td width="100"> </td> 245 <th> 246 <a href="../../../nw/snd/SequenceSoundHandle/SetTrackSilence.html">SetTrackSilence</a> 247 </th> 248 <td>Places a sequence sound track in silent status, or cancels silent status.</td> 249 </tr> 250 <tr> 251 <td width="100"> </td> 252 <th> 253 <a href="../../../nw/snd/SequenceSoundHandle/SetTrackVolume.html">SetTrackVolume</a> 254 </th> 255 <td>Changes the volume of a track in a sequence sound.</td> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260 <a href="../../../nw/snd/SequenceSoundHandle/SetTrackPitch.html">SetTrackPitch</a> 261 </th> 262 <td>Changes the track pitch of the sequence sound.</td> 263 </tr> 264 <tr> 265 <td width="100"> </td> 266 <th> 267 <a href="../../../nw/snd/SequenceSoundHandle/SetTrackPan.html">SetTrackPan</a> 268 </th> 269 <td>Changes the sequence sound's track pan (lateral localization).</td> 270 </tr> 271 <tr> 272 <td width="100"> </td> 273 <th> 274 <a href="../../../nw/snd/SequenceSoundHandle/SetTrackBankIndex.html">SetTrackBankIndex</a> 275 </th> 276 <td>Changes the track bank of the sequence sound.</td> 277 </tr> 278 <tr> 279 <th class="category" colspan="3">Handle Operations</th> 280 </tr> 281 <tr> 282 <td width="100"> </td> 283 <th> 284 <a href="../../../nw/snd/SequenceSoundHandle/IsAttachedSound.html">IsAttachedSound</a> 285 </th> 286 <td>Checks whether there is a sound associated with the handle.</td> 287 </tr> 288 <tr> 289 <td width="100"> </td> 290 <th> 291 <a href="../../../nw/snd/SequenceSoundHandle/DetachSound.html">DetachSound</a> 292 </th> 293 <td>Frees sounds from handles.</td> 294 </tr> 295 <tr> 296 <th class="category" colspan="3">Get/Set Information</th> 297 </tr> 298 <tr> 299 <td width="100"> </td> 300 <th> 301 <a href="../../../nw/snd/SequenceSoundHandle/SetId.html">SetId</a> 302 </th> 303 <td>Sets the ID of a sound.</td> 304 </tr> 305 <tr> 306 <td width="100"> </td> 307 <th> 308 <a href="../../../nw/snd/SequenceSoundHandle/GetId.html"><CODE>GetId</CODE></a> 309 </th> 310 <td>Gets the sound's ID.</td> 311 </tr> 312 <tr> 313 <td width="100"> </td> 314 <th> 315 <a href="../../../nw/snd/SequenceSoundHandle/GetTick.html">GetTick</a> 316 </th> 317 <td>Obtains the number of ticks since playback started.</td> 318 </tr> </table> 319 </div> 320 </a> 321 <h2>See Also</h2> 322 <div class="section"> 323 <p class="reference"><CODE>SoundHandle</CODE> Class </p> 324 </div> 325 <h2>Revision History</h2> 326 <div class="section"> 327 <dl class="history"> 328 <dt>2010/01/22</dt> 329 <dd>Initial version.<br /> 330 </dd> 331 </dl> 332 </div> 333 <hr><p>CONFIDENTIAL</p></body> 334</html> 335