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