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