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>nw::snd::SoundStartable::PrepareSound Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundStartable.h&gt;
14
15<a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">StartResult</a> PrepareSound(
16     <a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> * pHandle,
17     <a href="../../../nw/snd/SoundArchive/ItemId.html">SoundArchive::ItemId</a> soundId,
18     const <a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">StartInfo</a> * pStartInfo = NULL
19);
20
21<a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">StartResult</a> PrepareSound(
22     <a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> * pHandle,
23     const char * pSoundName,
24     const <a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">StartInfo</a> * pStartInfo = NULL
25);
26</pre>
27    </div>
28    <h2>List of Overloaded Member Functions</h2>
29    <div class="section">
30      <table class="members">
31        <tr>
32          <td>
33            <a href="./PrepareSound(0).html">PrepareSound ( SoundHandle *, SoundArchive::ItemId, const StartInfo * ) </a>
34          </td>
35          <td>Prepares to play the sound with the specified ID.</td>
36        </tr>
37        <tr>
38          <td>
39            <a href="./PrepareSound(1).html">PrepareSound ( SoundHandle *, const char *, const StartInfo * ) </a>
40          </td>
41          <td>Prepares to play the sound with the specified label string.</td>
42        </tr> </table>
43    </div>
44    <h2>Description of PrepareSound ( SoundHandle *, SoundArchive::ItemId, const StartInfo * )</h2>
45    <div class="section"><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 the ID of 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>
46    <h2>Description of PrepareSound ( SoundHandle *, const char *, const StartInfo * )</h2>
47    <div class="section"><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>
48  <hr><p>CONFIDENTIAL</p></body>
49</html>