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    <title>PrepareSound</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::<a href="../../../nw/snd/SoundStartable/Overview.html">SoundStartable</a>::PrepareSound</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundStartable.h&gt;
14<a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">StartResult</a> PrepareSound(
15     <a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> * pHandle,
16     const char * pSoundName,
17     const <a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">StartInfo</a> * pStartInfo = NULL
18);
19</pre>
20    </div>
21    <h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27            <th>Name</th>
28            <td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td>in</td>
33          <th>pHandle</th>
34          <td>The handle associated with the sound to play.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>pSoundName</th>
39          <td>Label character string of the sound to play.</td>
40        </tr>
41        <tr>
42          <td>in</td>
43          <th>pStartInfo</th>
44          <td>Detailed playback parameters.</td>
45        </tr> </table>
46    </div>
47    <h2>Return Values</h2>
48    <div class="section">Returns the playback preparation result as a <a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">StartResult</a> type. </div>
49    <h2>Description</h2>
50    <div class="section">
51      <p>Prepares to play the sound with the specified label string.</p><p>You can call <span><span>SoundHandle::StartPrepared</span></span> from the handle class to start playing a sound for which preparations are complete.</p><p>The first argument specifies the sound handle. The sound for which playback succeeded is associated with this sound handle.</p><p>The second argument specifies a label string that identifies the sound to play.</p><p>The <span>pStartInfo</span> argument contains detailed parameters that can be set during playback. You can start playback without setting these parameters.</p><p>Midway playback of a sound using pStartInfo is not supported because this is not currently implemented.</p></div>
52    <h2>See Also</h2>
53    <div class="section">
54      <p class="reference"><CODE><a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a></CODE> Class<br /><CODE><a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">StartResult</a></CODE><br /><CODE><a href="../../../nw/snd/SoundStartable/StartSound.html">StartSound</a></CODE><br /><CODE><a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">StartInfo</a></CODE><br /> </p>
55    </div>
56    <h2>Revision History</h2>
57    <div class="section">
58      <dl class="history">
59        <dt>2010/07/27</dt>
60        <dd>Added that midway playback of a sound using pStartInfo is not yet supported.<br />
61        </dd>
62        <dt>2010/01/15</dt>
63        <dd>Initial version.<br />
64        </dd>
65      </dl>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>
69