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>SetupSound</title>
8  </head>
9  <body>
10    <h1>nw::snd::SoundActor::SetupSound Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundActor.h&gt;
14
15protected:
16virtual <a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">SoundStartable::StartResult</a> SetupSound(
17     <a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a>* handle,
18     <span>u32</span> soundId,
19     const <a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">SoundStartable::StartInfo</a> * startInfo,
20     void* setupArg
21);
22</pre>
23    </div>
24    <h2>Arguments</h2>
25    <div class="section">
26      <table class="arguments">
27        <thead>
28          <tr>
29            <td width="15" />
30            <th>Name</th>
31            <td>Description</td>
32          </tr>
33        </thead>
34        <tr>
35          <td>in</td>
36          <th>handle</th>
37          <td>The handle associated with the sound to play.</td>
38        </tr>
39        <tr>
40          <td>in</td>
41          <th>soundId</th>
42          <td>ID of the sound to play.</td>
43        </tr>
44        <tr>
45          <td>in</td>
46          <th>startInfo</th>
47          <td>Detailed playback parameters.</td>
48        </tr>
49        <tr>
50          <td>in</td>
51          <th>setupArg</th>
52          <td>Parameter used at setup time.</td>
53        </tr> </table>
54    </div>
55    <h2>Return Values</h2>
56    <div class="section">Returns the result of playback as a <a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">SoundStartable::StartResult</a> type. </div>
57    <h2>Description</h2>
58    <div class="section">
59      <p>Virtual function called when a sound is played.</p><p>Processing during sound playback can be customized by overriding this function.</p><p></a>setupArg<a href="../../../nw/snd/SoundActor/SetupSound.html"> is passed unchanged as an argument when calling <a href="../../../nw/snd/SoundActor/SetupSound.html">SoundActor::SetupSound</a>.</p></div>
60    <h2>See Also</h2>
61    <div class="section">
62      <p class="reference"><a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> Class<br /><a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">SoundStartable::StartResult</a><br /><a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">SoundStartable::StartInfo</a><br /> </p>
63    </div>
64    <h2>Revision History</h2>
65    <div class="section">
66      <dl class="history">
67        <dt>2010/02/23</dt>
68        <dd>Initial version.<br />
69        </dd>
70      </dl>
71    </div>
72  <hr><p>CONFIDENTIAL</p></body>
73</html>