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>SetSequenceUserprocCallback</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/SoundArchivePlayer/Overview.html">SoundArchivePlayer</a>::SetSequenceUserprocCallback </CODE>Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundArchivePlayer.h&gt;
14
15void SetSequenceUserprocCallback(
16     <a href="../../../nw/snd/SequenceUserprocCallback.html">SequenceUserprocCallback</a> callback,
17     void* callbackArg
18);
19</pre>
20    </div>
21    <h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27            <th>Name</th>
28            <td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td>in</td>
33          <th>callback</th>
34          <td>The callback function to be registered.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>callbackArg</th>
39          <td>User argument passed to the callback function.</td>
40        </tr> </table>
41    </div>
42    <h2>Return Values</h2>
43    <div class="section">
44                None.
45               </div>
46    <h2>Description</h2>
47    <div class="section">
48      <p>Registers the callback function invoked by the <span>userproc</span> sequence command.</p><p>The callback registered here is invoked for frames in which the sequence data's <span>userproc</span> sequence command is processed. The callback function is called from the sound thread.</p><p>For details on the <span>userproc</span> command, see the Sequence Data Manual.</p><p>The callback function set here is called from the sound thread. If exclusive control is required, you will need to use the <CODE>SoundThreadScopedLock</CODE> class or the <CODE>LockSoundThread</CODE> / <CODE>UnlockSoundThread</CODE> functions.</p><p>The callback function must quickly finish processing.  If processing is prolonged, there is a high probability of noise being generated.  It may take time for processing to complete if an API function that might block (a critical section, for example) is called inside the callback function.</p><p><a href="../../../nw/snd/SequenceUserprocCallback.html"><CODE>SequenceUserprocCallback</CODE></a></p></div>
49    <h2>Revision History</h2>
50    <div class="section">
51      <dl class="history">
52        <dt>2011/01/11</dt>
53        <dd>Added mention that callback function is called from sound thread.<br />
54        </dd>
55        <dt>2010/01/15</dt>
56        <dd>Initial version.<br />
57        </dd>
58      </dl>
59    </div>
60  <hr><p>CONFIDENTIAL</p></body>
61</html>