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