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>HoldSound</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>::HoldSound</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> HoldSound(
15     <a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> * pHandle,
16     <a href="../../../nw/snd/SoundArchive/ItemId.html">SoundArchive::ItemId</a> soundId,
17     const <a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">StartInfo</a> * pHoldInfo = NULL
18);
19<a href="../../../nw/snd/SoundStartable/StartResult/Overview.html">StartResult</a> HoldSound(
20     <a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a> * pHandle,
21     const char * pSoundName,
22     const <a href="../../../nw/snd/SoundStartable/StartInfo/Overview.html">StartInfo</a> * pHoldInfo = NULL
23);
24</pre>
25    </div>
26    <h2>List of Overloaded Member Functions</h2>
27    <div class="section">
28      <table class="members">
29        <tr>
30          <td>
31            <a href="./HoldSound(0).html">HoldSound ( SoundHandle *, SoundArchive::ItemId, const StartInfo * ) </a>
32          </td>
33          <td>Plays or continues the sound with the specified ID.</td>
34        </tr>
35        <tr>
36          <td>
37            <a href="./HoldSound(1).html">HoldSound ( SoundHandle *, const char *, const StartInfo * ) </a>
38          </td>
39          <td>Plays or holds the sound with the specified label string.</td>
40        </tr> </table>
41    </div>
42    <h2>Description of HoldSound ( SoundHandle *, SoundArchive::ItemId, const StartInfo * )</h2>
43    <div class="section"><p>The sound can be played as long as this function is called each frame with the same ID. The sound stops when calling stops.</p><p>The first argument specifies the sound handle.</p><p>The second argument specifies the ID of the sound to play.</p><p>The value of <span>pHoldInfo</span> 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>
44    <h2>Description of HoldSound ( SoundHandle *, const char *, const StartInfo * )</h2>
45    <div class="section"><p>The sound can be played as long as this function is called each frame with the same ID. The sound stops when calling stops.</p><p>The first argument specifies the sound handle.</p><p>The second argument specifies a label string that identifies the sound to play.</p><p>The value of <span>pHoldInfo</span> 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  <hr><p>CONFIDENTIAL</p></body>
47</html>
48