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>StartSound</title>
8  </head>
9  <body>
10    <h1>nw::snd::SoundStartable::StartSound 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> StartSound(
16     <a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> * pHandle,
17     const char * pSoundName,
18     const <a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">StartInfo</a> * pStartInfo = NULL
19);
20</pre>
21    </div>
22    <h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28            <th>Name</th>
29            <td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33          <td>in</td>
34          <th>pHandle</th>
35          <td>The handle associated with the sound to play.</td>
36        </tr>
37        <tr>
38          <td>in</td>
39          <th>pSoundName</th>
40          <td>Label character string of the sound to play.</td>
41        </tr>
42        <tr>
43          <td>in</td>
44          <th>pStartInfo</th>
45          <td>Detailed playback parameters.</td>
46        </tr> </table>
47    </div>
48    <h2>Return Values</h2>
49    <div class="section">Returns the playback result as a <a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">StartResult</a> type. </div>
50    <h2>Description</h2>
51    <div class="section">
52      <p>Plays the sound with the specified label string.</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>Calling this function is the same as calling <a href="../../../nw/snd/SoundStartable/PrepareSound.html">PrepareSound</a> immediately followed by a call to the handle class <a href="../../../nw/snd/SoundHandle/StartPrepared.html">SoundHandle::StartPrepared</a>.</p><p>Midway playback of a sound using pStartInfo is not supported because this is not currently implemented.</p></div>
53    <h2>See Also</h2>
54    <div class="section">
55      <p class="reference"><a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> Class<br /><a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">StartResult</a><br /><a href="../../../nw/snd/SoundStartable/PrepareSound.html">StartSound</a><br /><a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">StartInfo</a><br /> </p>
56    </div>
57    <h2>Revision History</h2>
58    <div class="section">
59      <dl class="history">
60        <dt>2010/07/27</dt>
61        <dd>Added that midway playback of a sound using pStartInfo is not yet supported.<br />
62        </dd>
63        <dt>2010/01/15</dt>
64        <dd>Initial version.<br />
65        </dd>
66      </dl>
67    </div>
68  <hr><p>CONFIDENTIAL</p></body>
69</html>