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::SoundArchivePlayer</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::SoundArchivePlayer</CODE> Class</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_SoundArchivePlayer.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class SoundArchivePlayer : public <a href="../../../nw/snd/SoundStartable/Overview.html">nw::snd::SoundStartable</a></pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>A class that plays back sounds in a sound archive.</p><p>The sounds played back by the SoundArchivePlayer can be controlled using the handle class.</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/SoundArchivePlayer/SoundArchivePlayer.html">SoundArchivePlayer</a> 72 </th> 73 <td>Constructor.</td> 74 </tr> 75 <tr> 76 <td width="100"> <span class="virtual_style" title="virtual">V</span> 77 </td> 78 <th> 79 <a href="../../../nw/snd/SoundArchivePlayer/~SoundArchivePlayer.html">~SoundArchivePlayer</a> 80 </th> 81 <td>Destructor.</td> 82 </tr> 83 <tr> 84 <th class="category" colspan="3">Initialization</th> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89 <a href="../../../nw/snd/SoundArchivePlayer/GetRequiredMemSize.html">GetRequiredMemSize</a> 90 </th> 91 <td>Gets the size of memory required for initialization.</td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96 <a href="../../../nw/snd/SoundArchivePlayer/GetRequiredStreamBufferSize.html">GetRequiredStreamBufferSize</a> 97 </th> 98 <td>Gets the size of the stream buffer required for initialization.</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103 <a href="../../../nw/snd/SoundArchivePlayer/Initialize.html"><CODE>Initialize</CODE></a> 104 </th> 105 <td>Initializes a sound archive player.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110 <a href="../../../nw/snd/SoundArchivePlayer/Finalize.html">Finalize</a> 111 </th> 112 <td>Destroys a sound archive player.</td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117 <a href="../../../nw/snd/SoundArchivePlayer/IsAvailable.html">IsAvailable</a> 118 </th> 119 <td>Checks availability for use.</td> 120 </tr> 121 <tr> 122 <th class="category" colspan="3">Update</th> 123 </tr> 124 <tr> 125 <td width="100"> </td> 126 <th> 127 <a href="../../../nw/snd/SoundArchivePlayer/Update.html">Update</a> 128 </th> 129 <td>Updates the sound archive player.</td> 130 </tr> 131 <tr> 132 <th class="category" colspan="3">Other</th> 133 </tr> 134 <tr> 135 <td width="100"> </td> 136 <th> 137 <a href="../../../nw/snd/SoundArchivePlayer/GetSoundArchive.html">GetSoundArchive</a> 138 </th> 139 <td>Gets the sound archive bound to a player.</td> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144 <a href="../../../nw/snd/SoundArchivePlayer/GetSoundPlayer.html">GetSoundPlayer</a> 145 </th> 146 <td>Gets the sound player with the specified ID.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151 <a href="../../../nw/snd/SoundArchivePlayer/GetSoundPlayerCount.html">GetSoundPlayerCount</a> 152 </th> 153 <td>Gets the number of sound players.</td> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158 <a href="../../../nw/snd/SoundArchivePlayer/GetFreeSequenceSoundCount.html">GetFreeSequenceSoundCount</a> 159 </th> 160 <td>Retrieves the remaining number of playable sequence sounds.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165 <a href="../../../nw/snd/SoundArchivePlayer/GetFreeWaveSoundCount.html">GetFreeWaveSoundCount</a> 166 </th> 167 <td>Retrieves the remaining number of playable wave sounds.</td> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172 <a href="../../../nw/snd/SoundArchivePlayer/GetFreeStreamSoundCount.html">GetFreeStreamSoundCount</a> 173 </th> 174 <td>Retrieves the remaining number of playable stream sounds.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179 <a href="../../../nw/snd/SoundArchivePlayer/SetSequenceUserprocCallback.html">SetSequenceUserprocCallback</a> 180 </th> 181 <td>Registers the callback function invoked by the <span>userproc</span> sequence command.</td> 182 </tr> 183 <tr> 184 <th class="category" colspan="3">Play</th> 185 </tr> 186 <tr> 187 <td width="100"> </td> 188 <th> 189 <a href="../../../nw/snd/SoundStartable/StartSound.html"><CODE>StartSound</CODE></a> 190 </th> 191 <td>Plays the sound having the specified ID.(Inherited from <a href="../../../nw/snd/SoundStartable/Overview.html"><CODE>SoundStartable</CODE></a>.</td> 192 </tr> 193 <tr> 194 <td width="100"> </td> 195 <th> 196 <a href="../../../nw/snd/SoundStartable/HoldSound.html"><CODE>HoldSound</CODE></a> 197 </th> 198 <td>Plays or continues the sound with the specified ID.(Inherited from <a href="../../../nw/snd/SoundStartable/Overview.html"><CODE>SoundStartable</CODE></a>.</td> 199 </tr> 200 <tr> 201 <td width="100"> </td> 202 <th> 203 <a href="../../../nw/snd/SoundStartable/PrepareSound.html"><CODE>PrepareSound</CODE></a> 204 </th> 205 <td>Prepares to play the sound with the specified ID.(Inherited from <a href="../../../nw/snd/SoundStartable/Overview.html"><CODE>SoundStartable</CODE></a>.</td> 206 </tr> </table> 207 </div> 208 </a> 209 <h2>Class Hierarchy</h2> 210 <div class="section"> 211 <p class="hierarchy"><a href="../../../nw/snd/SoundStartable/Overview.html">nw::snd::SoundStartable</a><br /> <b>nw::snd::SoundArchivePlayer</b> 212 </p> 213 </div> 214 <h2>See Also</h2> 215 <div class="section"> 216 <p class="reference"><CODE><a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a></CODE> Class<br /><CODE><a href="../../../nw/snd/SoundStartable/Overview.html">SoundStartable</a></CODE> Interface<br /> </p> 217 </div> 218 <h2>Revision History</h2> 219 <div class="section"> 220 <dl class="history"> 221 <dt>2010/01/15</dt> 222 <dd>Initial version.<br /> 223 </dd> 224 </dl> 225 </div> 226 <hr><p>CONFIDENTIAL</p></body> 227</html> 228