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>SetBiquadFilterCallback</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/SoundSystem/Overview.html">SoundSystem</a>::SetBiquadFilterCallback</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundSystem.h&gt;
14
15static void SetBiquadFilterCallback(
16     int type,
17     const <a href="../../../nw/snd/BiquadFilterCallback/Overview.html">BiquadFilterCallback</a> * biquad
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>type</th>
34          <td>The filter type (BIQUAD_FILTER_TYPE_USER_MIN - BIQUAD_FILTER_TYPE_USER_MAX).</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>biquad</th>
39          <td>biquad filter class implemented by the user.</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 an user defined biquad filter.</p><p>Inherits the <a href="../../../nw/snd/BiquadFilterCallback/Overview.html">BiquadFilterCallback</a> class, and registers the biquad filter implemented by the user.</p><p>type is specified by a value between BIQUAD_FILTER_TYPE_USER_MIN and BIQUAD_FILTER_TYPE_USER_MAX, as defined in <a href="../../../nw/snd/BiquadFilterType.html">BiquadFilterType</a>. When a value that is out-of-range is set, operations stop with an assert for the Debug and Development versions. It is ignored in the Release version.</p><p>The callback function set here is called from the sound thread. If exclusive control is required, you will need to use the <a href="../../../nw/snd/SoundSystem/SoundThreadScopedLock/Overview.html">SoundThreadScopedLock</a> class or the <CODE><a href="../../../nw/snd/SoundSystem/LockSoundThread.html">LockSoundThread</a></CODE> / <CODE><a href="../../../nw/snd/SoundSystem/UnlockSoundThread.html">UnlockSoundThread</a></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></div>
49    <h2>See Also</h2>
50    <div class="section">
51      <p class="reference"><a href="../../../nw/snd/BiquadFilterCallback/Overview.html">BiquadFilterCallback</a> class<br /><a href="../../../nw/snd/BiquadFilterType.html">BiquadFilterType</a><br /> </p>
52    </div>
53    <h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2011/01/11</dt>
57        <dd>Added mention that callback function is called from sound thread.<br />
58        </dd>
59        <dt>2010/10/15</dt>
60        <dd>Initial version.<br />
61        </dd>
62      </dl>
63    </div>
64  <hr><p>CONFIDENTIAL</p></body>
65</html>