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::StreamSoundHandle</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::StreamSoundHandle</CODE> Class</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_StreamSoundHandle.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class StreamSoundHandle</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>A handle class used to control stream 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 stream sound is not implemented for the general-purpose handle.</p><p>If you want to execute a unique process for the stream sound, be sure to use a stream 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/StreamSoundHandle/StreamSoundHandle.html">StreamSoundHandle</a> 72 </th> 73 <td>Constructor.</td> 74 </tr> 75 <tr> 76 <td width="100"> </td> 77 <th> 78 <a href="../../../nw/snd/StreamSoundHandle/~StreamSoundHandle.html">~StreamSoundHandle</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/StreamSoundHandle/StartPrepared.html">StartPrepared</a> 89 </th> 90 <td>Plays the sound whose preparation for playback has completed.</td> 91 </tr> 92 <tr> 93 <td width="100"> </td> 94 <th> 95 <a href="../../../nw/snd/StreamSoundHandle/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/StreamSoundHandle/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/StreamSoundHandle/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/StreamSoundHandle/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/StreamSoundHandle/IsSuspendByLoadingDelay.html">IsSuspendByLoadingDelay</a> 124 </th> 125 <td>Checks whether or not streaming has been stopped due to a loading delay.</td> 126 </tr> 127 <tr> 128 <td width="100"> </td> 129 <th> 130 <a href="../../../nw/snd/StreamSoundHandle/FadeIn.html">FadeIn</a> 131 </th> 132 <td>Fades in the sound when playback starts.</td> 133 </tr> 134 <tr> 135 <th class="category" colspan="3">Updating Parameters</th> 136 </tr> 137 <tr> 138 <td width="100"> </td> 139 <th> 140 <a href="../../../nw/snd/StreamSoundHandle/SetVolume.html">SetVolume</a> 141 </th> 142 <td>Changes the volume of the sound.</td> 143 </tr> 144 <tr> 145 <td width="100"> </td> 146 <th> 147 <a href="../../../nw/snd/StreamSoundHandle/SetPitch.html">SetPitch</a> 148 </th> 149 <td>Changes the pitch of the sound.</td> 150 </tr> 151 <tr> 152 <td width="100"> </td> 153 <th> 154 <a href="../../../nw/snd/StreamSoundHandle/SetPan.html">SetPan</a> 155 </th> 156 <td>Changes the pan (right/left location) of the sound.</td> 157 </tr> 158 <tr> 159 <td width="100"> </td> 160 <th> 161 <a href="../../../nw/snd/StreamSoundHandle/SetPlayerPriority.html">SetPlayerPriority</a> 162 </th> 163 <td>Changes the player priority.</td> 164 </tr> 165 <tr> 166 <td width="100"> </td> 167 <th> 168 <a href="../../../nw/snd/StreamSoundHandle/SetMainSend.html">SetMainSend</a> 169 </th> 170 <td>Changes the main send volume of the sound.</td> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175 <a href="../../../nw/snd/StreamSoundHandle/SetFxSend.html">SetFxSend</a> 176 </th> 177 <td>Changes the effect send volume of the sound.</td> 178 </tr> 179 <tr> 180 <th class="category" colspan="3">Updating Track Parameters</th> 181 </tr> 182 <tr> 183 <td width="100"> </td> 184 <th> 185 <a href="../../../nw/snd/StreamSoundHandle/SetTrackVolume.html">SetTrackVolume</a> 186 </th> 187 <td>Changes the volume of streaming sound tracks.</td> 188 </tr> 189 <tr> 190 <td width="100"> </td> 191 <th> 192 <a href="../../../nw/snd/StreamSoundHandle/SetTrackPan.html">SetTrackPan</a> 193 </th> 194 <td>Changes the pan (lateral localization) of a streaming sound's tracks.</td> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199 <a href="../../../nw/snd/StreamSoundHandle/SetTrackSurroundPan.html">SetTrackSurroundPan</a> 200 </th> 201 <td>Changes the surround pan (front-back position) of a track in a stream sound.</td> 202 </tr> 203 <tr> 204 <th class="category" colspan="3">Handle Operations</th> 205 </tr> 206 <tr> 207 <td width="100"> </td> 208 <th> 209 <a href="../../../nw/snd/StreamSoundHandle/IsAttachedSound.html">IsAttachedSound</a> 210 </th> 211 <td>Checks whether there is a sound associated with the handle.</td> 212 </tr> 213 <tr> 214 <td width="100"> </td> 215 <th> 216 <a href="../../../nw/snd/StreamSoundHandle/DetachSound.html">DetachSound</a> 217 </th> 218 <td>Frees sounds from handles.</td> 219 </tr> 220 <tr> 221 <th class="category" colspan="3">Get/Set Information</th> 222 </tr> 223 <tr> 224 <td width="100"> </td> 225 <th> 226 <a href="../../../nw/snd/StreamSoundHandle/SetId.html">SetId</a> 227 </th> 228 <td>Sets the ID of a sound.</td> 229 </tr> 230 <tr> 231 <td width="100"> </td> 232 <th> 233 <a href="../../../nw/snd/StreamSoundHandle/GetId.html"><CODE>GetId</CODE></a> 234 </th> 235 <td>Gets the sound's ID.</td> 236 </tr> 237 <tr> 238 <td width="100"> </td> 239 <th> 240 <a href="../../../nw/snd/StreamSoundHandle/ReadStreamDataInfo.html">ReadStreamDataInfo</a> 241 </th> 242 <td>Obtains stream data information.</td> 243 </tr> 244 <tr> 245 <td width="100"> </td> 246 <th> 247 <a href="../../../nw/snd/StreamSoundHandle/GetPlayLoopCount.html">GetPlayLoopCount</a> 248 </th> 249 <td>Obtains the loop count for the stream data currently playing.</td> 250 </tr> 251 <tr> 252 <td width="100"> </td> 253 <th> 254 <a href="../../../nw/snd/StreamSoundHandle/GetPlaySamplePosition.html">GetPlaySamplePosition</a> 255 </th> 256 <td>Obtains the playback position for the stream data currently playing.</td> 257 </tr> 258 <tr> 259 <td width="100"> </td> 260 <th> 261 <a href="../../../nw/snd/StreamSoundHandle/GetFilledBufferPercentage.html">GetFilledBufferPercentage</a> 262 </th> 263 <td>Gets the percentage of the stream buffer that has been filled with waveform data.</td> 264 </tr> </table> 265 </div> 266 </a> 267 <h2>See Also</h2> 268 <div class="section"> 269 <p class="reference"><CODE>SoundHandle</CODE> Class </p> 270 </div> 271 <h2>Revision History</h2> 272 <div class="section"> 273 <dl class="history"> 274 <dt>2010/01/22</dt> 275 <dd>Initial version.<br /> 276 </dd> 277 </dl> 278 </div> 279 <hr><p>CONFIDENTIAL</p></body> 280</html> 281