~n3npq/lsb/t2c-alsa-tests

« back to all changes in this revision

Viewing changes to spec/group___p_c_m___ext_plug.html

  • Committer: Jeff Licquia
  • Date: 2009-12-01 02:17:33 UTC
  • Revision ID: jeff@licquia.org-20091201021733-3wwc7cdytdzz7hwo
Initial version.

This contains the spec, as mirrored from the ALSA site, and as run
through KompoZer (so its gratuitous format changes are already there).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head>
 
3
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>ALSA project - the C library reference: External Filter plugin SDK</title>
 
4
 
 
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"></head><body>
 
7
<!-- Generated by Doxygen 1.5.0 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li><a href="modules.html"><span>Modules</span></a></li>
 
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
13
    <li><a href="files.html"><span>Files</span></a></li>
 
14
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
15
    <li><a href="examples.html"><span>Examples</span></a></li>
 
16
  </ul></div>
 
17
<h1>External Filter plugin SDK<br>
 
18
<small>
 
19
[<a class="el" href="group___plugin___s_d_k.html">External PCM plugin SDK</a>]</small>
 
20
</h1><table border="0" cellpadding="0" cellspacing="0">
 
21
<tbody><tr><td><br>
 
22
</td></tr>
 
23
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
 
24
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug</a></td></tr>
 
25
 
 
26
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsnd__pcm__extplug__callback.html">snd_pcm_extplug_callback</a></td></tr>
 
27
 
 
28
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
 
29
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g4854f28f6805a788cd2a117e82224946">SND_PCM_EXTPLUG_VERSION_MAJOR</a>&nbsp;&nbsp;&nbsp;1</td></tr>
 
30
 
 
31
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g5030132784eea83ffe1a58b21efc5934">SND_PCM_EXTPLUG_VERSION_MINOR</a>&nbsp;&nbsp;&nbsp;0</td></tr>
 
32
 
 
33
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#gd003584c8ec5dd20e79cd1c565c1d117">SND_PCM_EXTPLUG_VERSION_TINY</a>&nbsp;&nbsp;&nbsp;1</td></tr>
 
34
 
 
35
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#gde3e571a17c909eac1e58a1bdb4603a3">SND_PCM_EXTPLUG_VERSION</a></td></tr>
 
36
 
 
37
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
 
38
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">typedef <a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g1aefaedf9d1cba412f1ebfb884f05b45">snd_pcm_extplug_t</a></td></tr>
 
39
 
 
40
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">typedef <a class="el" href="structsnd__pcm__extplug__callback.html">snd_pcm_extplug_callback</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g9d8340212da6e371e00be36403bf6071">snd_pcm_extplug_callback_t</a></td></tr>
 
41
 
 
42
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
 
43
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="group___p_c_m___ext_plug.html#gg1af138ee919beeb88a50aa27b42124b71d5379b0579703933f070b7c3cb845f5">SND_PCM_EXTPLUG_HW_FORMAT</a>, 
 
44
<a class="el" href="group___p_c_m___ext_plug.html#gg1af138ee919beeb88a50aa27b42124b711867774d63675bb1fe3ecd1933ebed0">SND_PCM_EXTPLUG_HW_CHANNELS</a>, 
 
45
<a class="el" href="group___p_c_m___ext_plug.html#gg1af138ee919beeb88a50aa27b42124b79c1195746498d1a75a6476950d147213">SND_PCM_EXTPLUG_HW_PARAMS</a>
 
46
 }</td></tr>
 
47
 
 
48
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 
49
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g57892d908bc602543ad645fcf278d4bc">snd_pcm_extplug_create</a> (<a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *ext, const char *name, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *root, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *slave_conf, <a class="el" href="group___p_c_m.html#g854f0966bd0d7248ed3d9e5c293136ed">snd_pcm_stream_t</a> stream, int mode)</td></tr>
 
50
 
 
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an extplug instance.  <a href="#g57892d908bc602543ad645fcf278d4bc"></a><br></td></tr>
 
52
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g73cde6bb5aafcbdc89a79897c9d9535c">snd_pcm_extplug_delete</a> (<a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *ext)</td></tr>
 
53
 
 
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delete the extplug instance.  <a href="#g73cde6bb5aafcbdc89a79897c9d9535c"></a><br></td></tr>
 
55
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#ga658989357015fadc3776038f9186afc">snd_pcm_extplug_params_reset</a> (<a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *ext)</td></tr>
 
56
 
 
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset extplug parameters.  <a href="#ga658989357015fadc3776038f9186afc"></a><br></td></tr>
 
58
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#gcb52f3c06dc627450d69c7aa05f8508e">snd_pcm_extplug_set_param_list</a> (<a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *extplug, int type, unsigned int num_list, const unsigned int *list)</td></tr>
 
59
 
 
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set master parameter as the list.  <a href="#gcb52f3c06dc627450d69c7aa05f8508e"></a><br></td></tr>
 
61
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g687a2749106b0be206e9b4ec62df009d">snd_pcm_extplug_set_param_minmax</a> (<a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *extplug, int type, unsigned int min, unsigned int max)</td></tr>
 
62
 
 
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set master parameter as the min/max values.  <a href="#g687a2749106b0be206e9b4ec62df009d"></a><br></td></tr>
 
64
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g84a3f300cf1193988f416fafb7c88258">snd_pcm_extplug_set_slave_param_list</a> (<a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *extplug, int type, unsigned int num_list, const unsigned int *list)</td></tr>
 
65
 
 
66
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set slave parameter as the list.  <a href="#g84a3f300cf1193988f416fafb7c88258"></a><br></td></tr>
 
67
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___ext_plug.html#g92adb0c7061c59fb1034ba57a2cb08f9">snd_pcm_extplug_set_slave_param_minmax</a> (<a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *extplug, int type, unsigned int min, unsigned int max)</td></tr>
 
68
 
 
69
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set slave parameter as the min/max values.  <a href="#g92adb0c7061c59fb1034ba57a2cb08f9"></a><br></td></tr>
 
70
</tbody></table>
 
71
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
72
See the <a class="el" href="pcm.html">PCM (digital audio) interface</a> page for more details. <hr><h2>Define Documentation</h2>
 
73
<a class="anchor" name="gde3e571a17c909eac1e58a1bdb4603a3"></a><!-- doxytag: member="pcm_extplug.h::SND_PCM_EXTPLUG_VERSION" ref="gde3e571a17c909eac1e58a1bdb4603a3" args="" -->
 
74
<div class="memitem">
 
75
<div class="memproto">
 
76
      <table class="memname">
 
77
        <tbody><tr>
 
78
          <td class="memname">#define SND_PCM_EXTPLUG_VERSION          </td>
 
79
        </tr>
 
80
      </tbody></table>
 
81
</div>
 
82
<div class="memdoc">
 
83
 
 
84
<p>
 
85
<b>Value:</b></p><div class="fragment"><pre class="fragment">((<a class="code" href="group___p_c_m___ext_plug.html#g4854f28f6805a788cd2a117e82224946">SND_PCM_EXTPLUG_VERSION_MAJOR</a>&lt;&lt;16) |\<br>                                         (<a class="code" href="group___p_c_m___ext_plug.html#g5030132784eea83ffe1a58b21efc5934">SND_PCM_EXTPLUG_VERSION_MINOR</a>&lt;&lt;8) |\<br>                                         (<a class="code" href="group___p_c_m___ext_plug.html#gd003584c8ec5dd20e79cd1c565c1d117">SND_PCM_EXTPLUG_VERSION_TINY</a>))<br></pre></div>Filter-plugin protocol version 
 
86
</div>
 
87
</div><p>
 
88
<a class="anchor" name="g4854f28f6805a788cd2a117e82224946"></a><!-- doxytag: member="pcm_extplug.h::SND_PCM_EXTPLUG_VERSION_MAJOR" ref="g4854f28f6805a788cd2a117e82224946" args="" -->
 
89
</p><div class="memitem">
 
90
<div class="memproto">
 
91
      <table class="memname">
 
92
        <tbody><tr>
 
93
          <td class="memname">#define SND_PCM_EXTPLUG_VERSION_MAJOR&nbsp;&nbsp;&nbsp;1          </td>
 
94
        </tr>
 
95
      </tbody></table>
 
96
</div>
 
97
<div class="memdoc">
 
98
 
 
99
<p>
 
100
Protocol major version 
 
101
</p></div>
 
102
</div><p>
 
103
<a class="anchor" name="g5030132784eea83ffe1a58b21efc5934"></a><!-- doxytag: member="pcm_extplug.h::SND_PCM_EXTPLUG_VERSION_MINOR" ref="g5030132784eea83ffe1a58b21efc5934" args="" -->
 
104
</p><div class="memitem">
 
105
<div class="memproto">
 
106
      <table class="memname">
 
107
        <tbody><tr>
 
108
          <td class="memname">#define SND_PCM_EXTPLUG_VERSION_MINOR&nbsp;&nbsp;&nbsp;0          </td>
 
109
        </tr>
 
110
      </tbody></table>
 
111
</div>
 
112
<div class="memdoc">
 
113
 
 
114
<p>
 
115
Protocol minor version 
 
116
</p></div>
 
117
</div><p>
 
118
<a class="anchor" name="gd003584c8ec5dd20e79cd1c565c1d117"></a><!-- doxytag: member="pcm_extplug.h::SND_PCM_EXTPLUG_VERSION_TINY" ref="gd003584c8ec5dd20e79cd1c565c1d117" args="" -->
 
119
</p><div class="memitem">
 
120
<div class="memproto">
 
121
      <table class="memname">
 
122
        <tbody><tr>
 
123
          <td class="memname">#define SND_PCM_EXTPLUG_VERSION_TINY&nbsp;&nbsp;&nbsp;1          </td>
 
124
        </tr>
 
125
      </tbody></table>
 
126
</div>
 
127
<div class="memdoc">
 
128
 
 
129
<p>
 
130
Protocol tiny version 
 
131
</p></div>
 
132
</div><p>
 
133
</p><hr><h2>Typedef Documentation</h2>
 
134
<a class="anchor" name="g9d8340212da6e371e00be36403bf6071"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_callback_t" ref="g9d8340212da6e371e00be36403bf6071" args="" -->
 
135
<div class="memitem">
 
136
<div class="memproto">
 
137
      <table class="memname">
 
138
        <tbody><tr>
 
139
          <td class="memname">typedef struct <a class="el" href="structsnd__pcm__extplug__callback.html">snd_pcm_extplug_callback</a> <a class="el" href="structsnd__pcm__extplug__callback.html">snd_pcm_extplug_callback_t</a>          </td>
 
140
        </tr>
 
141
      </tbody></table>
 
142
</div>
 
143
<div class="memdoc">
 
144
 
 
145
<p>
 
146
Callback table of extplug 
 
147
</p></div>
 
148
</div><p>
 
149
<a class="anchor" name="g1aefaedf9d1cba412f1ebfb884f05b45"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_t" ref="g1aefaedf9d1cba412f1ebfb884f05b45" args="" -->
 
150
</p><div class="memitem">
 
151
<div class="memproto">
 
152
      <table class="memname">
 
153
        <tbody><tr>
 
154
          <td class="memname">typedef struct <a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug</a> <a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a>          </td>
 
155
        </tr>
 
156
      </tbody></table>
 
157
</div>
 
158
<div class="memdoc">
 
159
 
 
160
<p>
 
161
Handle of external filter plugin 
 
162
</p></div>
 
163
</div><p>
 
164
</p><hr><h2>Enumeration Type Documentation</h2>
 
165
<a class="anchor" name="g1af138ee919beeb88a50aa27b42124b7"></a><!-- doxytag: member="pcm_extplug.h::@5" ref="g1af138ee919beeb88a50aa27b42124b7" args="" -->
 
166
<div class="memitem">
 
167
<div class="memproto">
 
168
      <table class="memname">
 
169
        <tbody><tr>
 
170
          <td class="memname">anonymous enum          </td>
 
171
        </tr>
 
172
      </tbody></table>
 
173
</div>
 
174
<div class="memdoc">
 
175
 
 
176
<p>
 
177
hw constraints for extplug </p><dl compact="compact"><dt><b>Enumerator: </b></dt><dd>
 
178
<table border="0" cellpadding="0" cellspacing="2">
 
179
<tbody><tr><td valign="top"><em><a class="anchor" name="gg1af138ee919beeb88a50aa27b42124b71d5379b0579703933f070b7c3cb845f5"></a><!-- doxytag: member="SND_PCM_EXTPLUG_HW_FORMAT" ref="gg1af138ee919beeb88a50aa27b42124b71d5379b0579703933f070b7c3cb845f5" args="" -->SND_PCM_EXTPLUG_HW_FORMAT</em>&nbsp;</td><td>
 
180
format </td></tr>
 
181
<tr><td valign="top"><em><a class="anchor" name="gg1af138ee919beeb88a50aa27b42124b711867774d63675bb1fe3ecd1933ebed0"></a><!-- doxytag: member="SND_PCM_EXTPLUG_HW_CHANNELS" ref="gg1af138ee919beeb88a50aa27b42124b711867774d63675bb1fe3ecd1933ebed0" args="" -->SND_PCM_EXTPLUG_HW_CHANNELS</em>&nbsp;</td><td>
 
182
channels </td></tr>
 
183
<tr><td valign="top"><em><a class="anchor" name="gg1af138ee919beeb88a50aa27b42124b79c1195746498d1a75a6476950d147213"></a><!-- doxytag: member="SND_PCM_EXTPLUG_HW_PARAMS" ref="gg1af138ee919beeb88a50aa27b42124b79c1195746498d1a75a6476950d147213" args="" -->SND_PCM_EXTPLUG_HW_PARAMS</em>&nbsp;</td><td>
 
184
max number of hw constraints </td></tr>
 
185
</tbody></table>
 
186
</dd></dl>
 
187
 
 
188
</div>
 
189
</div><p>
 
190
</p><hr><h2>Function Documentation</h2>
 
191
<a class="anchor" name="g57892d908bc602543ad645fcf278d4bc"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_create" ref="g57892d908bc602543ad645fcf278d4bc" args="(snd_pcm_extplug_t *ext, const char *name, snd_config_t *root, snd_config_t *slave_conf, snd_pcm_stream_t stream, int mode)" -->
 
192
<div class="memitem">
 
193
<div class="memproto">
 
194
      <table class="memname">
 
195
        <tbody><tr>
 
196
          <td class="memname">int snd_pcm_extplug_create           </td>
 
197
          <td>(</td>
 
198
          <td class="paramtype"><a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *&nbsp;</td>
 
199
          <td class="paramname"> <em>extplug</em>, </td>
 
200
        </tr>
 
201
        <tr>
 
202
          <td class="paramkey"><br>
 
203
</td>
 
204
          <td><br>
 
205
</td>
 
206
          <td class="paramtype">const char *&nbsp;</td>
 
207
          <td class="paramname"> <em>name</em>, </td>
 
208
        </tr>
 
209
        <tr>
 
210
          <td class="paramkey"><br>
 
211
</td>
 
212
          <td><br>
 
213
</td>
 
214
          <td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *&nbsp;</td>
 
215
          <td class="paramname"> <em>root</em>, </td>
 
216
        </tr>
 
217
        <tr>
 
218
          <td class="paramkey"><br>
 
219
</td>
 
220
          <td><br>
 
221
</td>
 
222
          <td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *&nbsp;</td>
 
223
          <td class="paramname"> <em>slave_conf</em>, </td>
 
224
        </tr>
 
225
        <tr>
 
226
          <td class="paramkey"><br>
 
227
</td>
 
228
          <td><br>
 
229
</td>
 
230
          <td class="paramtype"><a class="el" href="group___p_c_m.html#g854f0966bd0d7248ed3d9e5c293136ed">snd_pcm_stream_t</a>&nbsp;</td>
 
231
          <td class="paramname"> <em>stream</em>, </td>
 
232
        </tr>
 
233
        <tr>
 
234
          <td class="paramkey"><br>
 
235
</td>
 
236
          <td><br>
 
237
</td>
 
238
          <td class="paramtype">int&nbsp;</td>
 
239
          <td class="paramname"> <em>mode</em></td><td>&nbsp;</td>
 
240
        </tr>
 
241
        <tr>
 
242
          <td><br>
 
243
</td>
 
244
          <td>)</td>
 
245
          <td><br>
 
246
</td><td><br>
 
247
</td><td width="100%"><br>
 
248
</td>
 
249
        </tr>
 
250
      </tbody></table>
 
251
</div>
 
252
<div class="memdoc">
 
253
 
 
254
<p>
 
255
Create an extplug instance. 
 
256
</p><p>
 
257
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
258
  <table border="0" cellpadding="0" cellspacing="2">
 
259
    <tbody><tr><td valign="top"><br>
 
260
</td><td valign="top"><em>extplug</em>&nbsp;</td><td>the extplug handle </td></tr>
 
261
    <tr><td valign="top"><br>
 
262
</td><td valign="top"><em>name</em>&nbsp;</td><td>name of the PCM </td></tr>
 
263
    <tr><td valign="top"><br>
 
264
</td><td valign="top"><em>root</em>&nbsp;</td><td>configuration tree root </td></tr>
 
265
    <tr><td valign="top"><br>
 
266
</td><td valign="top"><em>slave_conf</em>&nbsp;</td><td>slave configuration root </td></tr>
 
267
    <tr><td valign="top"><br>
 
268
</td><td valign="top"><em>stream</em>&nbsp;</td><td>stream direction </td></tr>
 
269
    <tr><td valign="top"><br>
 
270
</td><td valign="top"><em>mode</em>&nbsp;</td><td>PCM open mode </td></tr>
 
271
  </tbody></table>
 
272
</dd></dl>
 
273
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>Creates
 
274
the extplug instance based on the given handle. The slave_conf argument
 
275
is mandatory, and usually taken from the config tree of the PCM plugin
 
276
as "slave" config value. name, root, stream and mode arguments are the
 
277
values used for opening the PCM.<p>
 
278
The callback is the mandatory field of extplug handle. At least, start,
 
279
stop and pointer callbacks must be set before calling this function. </p></div>
 
280
</div><p>
 
281
<a class="anchor" name="g73cde6bb5aafcbdc89a79897c9d9535c"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_delete" ref="g73cde6bb5aafcbdc89a79897c9d9535c" args="(snd_pcm_extplug_t *ext)" -->
 
282
</p><div class="memitem">
 
283
<div class="memproto">
 
284
      <table class="memname">
 
285
        <tbody><tr>
 
286
          <td class="memname">int snd_pcm_extplug_delete           </td>
 
287
          <td>(</td>
 
288
          <td class="paramtype"><a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *&nbsp;</td>
 
289
          <td class="paramname"> <em>extplug</em>          </td>
 
290
          <td>&nbsp;)&nbsp;</td>
 
291
          <td width="100%"><br>
 
292
</td>
 
293
        </tr>
 
294
      </tbody></table>
 
295
</div>
 
296
<div class="memdoc">
 
297
 
 
298
<p>
 
299
Delete the extplug instance. 
 
300
</p><p>
 
301
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
302
  <table border="0" cellpadding="0" cellspacing="2">
 
303
    <tbody><tr><td valign="top"><br>
 
304
</td><td valign="top"><em>extplug</em>&nbsp;</td><td>the extplug handle to delete </td></tr>
 
305
  </tbody></table>
 
306
</dd></dl>
 
307
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>
 
308
The destructor of extplug instance. Closes the PCM and deletes the associated resources. 
 
309
</div>
 
310
</div><p>
 
311
<a class="anchor" name="ga658989357015fadc3776038f9186afc"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_params_reset" ref="ga658989357015fadc3776038f9186afc" args="(snd_pcm_extplug_t *ext)" -->
 
312
</p><div class="memitem">
 
313
<div class="memproto">
 
314
      <table class="memname">
 
315
        <tbody><tr>
 
316
          <td class="memname">void snd_pcm_extplug_params_reset           </td>
 
317
          <td>(</td>
 
318
          <td class="paramtype"><a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *&nbsp;</td>
 
319
          <td class="paramname"> <em>extplug</em>          </td>
 
320
          <td>&nbsp;)&nbsp;</td>
 
321
          <td width="100%"><br>
 
322
</td>
 
323
        </tr>
 
324
      </tbody></table>
 
325
</div>
 
326
<div class="memdoc">
 
327
 
 
328
<p>
 
329
Reset extplug parameters. 
 
330
</p><p>
 
331
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
332
  <table border="0" cellpadding="0" cellspacing="2">
 
333
    <tbody><tr><td valign="top"><br>
 
334
</td><td valign="top"><em>extplug</em>&nbsp;</td><td>the extplug handle</td></tr>
 
335
  </tbody></table>
 
336
</dd></dl>
 
337
Resets the all parameters for the given extplug handle. 
 
338
</div>
 
339
</div><p>
 
340
<a class="anchor" name="gcb52f3c06dc627450d69c7aa05f8508e"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_set_param_list" ref="gcb52f3c06dc627450d69c7aa05f8508e" args="(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list)" -->
 
341
</p><div class="memitem">
 
342
<div class="memproto">
 
343
      <table class="memname">
 
344
        <tbody><tr>
 
345
          <td class="memname">int snd_pcm_extplug_set_param_list           </td>
 
346
          <td>(</td>
 
347
          <td class="paramtype"><a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *&nbsp;</td>
 
348
          <td class="paramname"> <em>extplug</em>, </td>
 
349
        </tr>
 
350
        <tr>
 
351
          <td class="paramkey"><br>
 
352
</td>
 
353
          <td><br>
 
354
</td>
 
355
          <td class="paramtype">int&nbsp;</td>
 
356
          <td class="paramname"> <em>type</em>, </td>
 
357
        </tr>
 
358
        <tr>
 
359
          <td class="paramkey"><br>
 
360
</td>
 
361
          <td><br>
 
362
</td>
 
363
          <td class="paramtype">unsigned int&nbsp;</td>
 
364
          <td class="paramname"> <em>num_list</em>, </td>
 
365
        </tr>
 
366
        <tr>
 
367
          <td class="paramkey"><br>
 
368
</td>
 
369
          <td><br>
 
370
</td>
 
371
          <td class="paramtype">const unsigned int *&nbsp;</td>
 
372
          <td class="paramname"> <em>list</em></td><td>&nbsp;</td>
 
373
        </tr>
 
374
        <tr>
 
375
          <td><br>
 
376
</td>
 
377
          <td>)</td>
 
378
          <td><br>
 
379
</td><td><br>
 
380
</td><td width="100%"><br>
 
381
</td>
 
382
        </tr>
 
383
      </tbody></table>
 
384
</div>
 
385
<div class="memdoc">
 
386
 
 
387
<p>
 
388
Set master parameter as the list. 
 
389
</p><p>
 
390
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
391
  <table border="0" cellpadding="0" cellspacing="2">
 
392
    <tbody><tr><td valign="top"><br>
 
393
</td><td valign="top"><em>extplug</em>&nbsp;</td><td>the extplug handle </td></tr>
 
394
    <tr><td valign="top"><br>
 
395
</td><td valign="top"><em>type</em>&nbsp;</td><td>parameter type </td></tr>
 
396
    <tr><td valign="top"><br>
 
397
</td><td valign="top"><em>num_list</em>&nbsp;</td><td>number of available values </td></tr>
 
398
    <tr><td valign="top"><br>
 
399
</td><td valign="top"><em>list</em>&nbsp;</td><td>the list of available values </td></tr>
 
400
  </tbody></table>
 
401
</dd></dl>
 
402
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>Sets
 
403
the master parameter as the list. The available values of the given
 
404
parameter type of this PCM (as input) is restricted to the ones of the
 
405
given list. </div>
 
406
</div><p>
 
407
<a class="anchor" name="g687a2749106b0be206e9b4ec62df009d"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_set_param_minmax" ref="g687a2749106b0be206e9b4ec62df009d" args="(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max)" -->
 
408
</p><div class="memitem">
 
409
<div class="memproto">
 
410
      <table class="memname">
 
411
        <tbody><tr>
 
412
          <td class="memname">int snd_pcm_extplug_set_param_minmax           </td>
 
413
          <td>(</td>
 
414
          <td class="paramtype"><a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *&nbsp;</td>
 
415
          <td class="paramname"> <em>extplug</em>, </td>
 
416
        </tr>
 
417
        <tr>
 
418
          <td class="paramkey"><br>
 
419
</td>
 
420
          <td><br>
 
421
</td>
 
422
          <td class="paramtype">int&nbsp;</td>
 
423
          <td class="paramname"> <em>type</em>, </td>
 
424
        </tr>
 
425
        <tr>
 
426
          <td class="paramkey"><br>
 
427
</td>
 
428
          <td><br>
 
429
</td>
 
430
          <td class="paramtype">unsigned int&nbsp;</td>
 
431
          <td class="paramname"> <em>min</em>, </td>
 
432
        </tr>
 
433
        <tr>
 
434
          <td class="paramkey"><br>
 
435
</td>
 
436
          <td><br>
 
437
</td>
 
438
          <td class="paramtype">unsigned int&nbsp;</td>
 
439
          <td class="paramname"> <em>max</em></td><td>&nbsp;</td>
 
440
        </tr>
 
441
        <tr>
 
442
          <td><br>
 
443
</td>
 
444
          <td>)</td>
 
445
          <td><br>
 
446
</td><td><br>
 
447
</td><td width="100%"><br>
 
448
</td>
 
449
        </tr>
 
450
      </tbody></table>
 
451
</div>
 
452
<div class="memdoc">
 
453
 
 
454
<p>
 
455
Set master parameter as the min/max values. 
 
456
</p><p>
 
457
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
458
  <table border="0" cellpadding="0" cellspacing="2">
 
459
    <tbody><tr><td valign="top"><br>
 
460
</td><td valign="top"><em>extplug</em>&nbsp;</td><td>the extplug handle </td></tr>
 
461
    <tr><td valign="top"><br>
 
462
</td><td valign="top"><em>type</em>&nbsp;</td><td>parameter type </td></tr>
 
463
    <tr><td valign="top"><br>
 
464
</td><td valign="top"><em>min</em>&nbsp;</td><td>the minimum value </td></tr>
 
465
    <tr><td valign="top"><br>
 
466
</td><td valign="top"><em>max</em>&nbsp;</td><td>the maximum value </td></tr>
 
467
  </tbody></table>
 
468
</dd></dl>
 
469
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>Sets
 
470
the master parameter as the min/max values. The available values of the
 
471
given parameter type of this PCM (as input) is restricted between the
 
472
given minimum and maximum values. </div>
 
473
</div><p>
 
474
<a class="anchor" name="g84a3f300cf1193988f416fafb7c88258"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_set_slave_param_list" ref="g84a3f300cf1193988f416fafb7c88258" args="(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list)" -->
 
475
</p><div class="memitem">
 
476
<div class="memproto">
 
477
      <table class="memname">
 
478
        <tbody><tr>
 
479
          <td class="memname">int snd_pcm_extplug_set_slave_param_list           </td>
 
480
          <td>(</td>
 
481
          <td class="paramtype"><a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *&nbsp;</td>
 
482
          <td class="paramname"> <em>extplug</em>, </td>
 
483
        </tr>
 
484
        <tr>
 
485
          <td class="paramkey"><br>
 
486
</td>
 
487
          <td><br>
 
488
</td>
 
489
          <td class="paramtype">int&nbsp;</td>
 
490
          <td class="paramname"> <em>type</em>, </td>
 
491
        </tr>
 
492
        <tr>
 
493
          <td class="paramkey"><br>
 
494
</td>
 
495
          <td><br>
 
496
</td>
 
497
          <td class="paramtype">unsigned int&nbsp;</td>
 
498
          <td class="paramname"> <em>num_list</em>, </td>
 
499
        </tr>
 
500
        <tr>
 
501
          <td class="paramkey"><br>
 
502
</td>
 
503
          <td><br>
 
504
</td>
 
505
          <td class="paramtype">const unsigned int *&nbsp;</td>
 
506
          <td class="paramname"> <em>list</em></td><td>&nbsp;</td>
 
507
        </tr>
 
508
        <tr>
 
509
          <td><br>
 
510
</td>
 
511
          <td>)</td>
 
512
          <td><br>
 
513
</td><td><br>
 
514
</td><td width="100%"><br>
 
515
</td>
 
516
        </tr>
 
517
      </tbody></table>
 
518
</div>
 
519
<div class="memdoc">
 
520
 
 
521
<p>
 
522
Set slave parameter as the list. 
 
523
</p><p>
 
524
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
525
  <table border="0" cellpadding="0" cellspacing="2">
 
526
    <tbody><tr><td valign="top"><br>
 
527
</td><td valign="top"><em>extplug</em>&nbsp;</td><td>the extplug handle </td></tr>
 
528
    <tr><td valign="top"><br>
 
529
</td><td valign="top"><em>type</em>&nbsp;</td><td>parameter type </td></tr>
 
530
    <tr><td valign="top"><br>
 
531
</td><td valign="top"><em>num_list</em>&nbsp;</td><td>number of available values </td></tr>
 
532
    <tr><td valign="top"><br>
 
533
</td><td valign="top"><em>list</em>&nbsp;</td><td>the list of available values </td></tr>
 
534
  </tbody></table>
 
535
</dd></dl>
 
536
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>Sets
 
537
the slave parameter as the list. The available values of the given
 
538
parameter type of the slave PCM is restricted to the ones of the given
 
539
list. </div>
 
540
</div><p>
 
541
<a class="anchor" name="g92adb0c7061c59fb1034ba57a2cb08f9"></a><!-- doxytag: member="pcm_extplug.h::snd_pcm_extplug_set_slave_param_minmax" ref="g92adb0c7061c59fb1034ba57a2cb08f9" args="(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max)" -->
 
542
</p><div class="memitem">
 
543
<div class="memproto">
 
544
      <table class="memname">
 
545
        <tbody><tr>
 
546
          <td class="memname">int snd_pcm_extplug_set_slave_param_minmax           </td>
 
547
          <td>(</td>
 
548
          <td class="paramtype"><a class="el" href="structsnd__pcm__extplug.html">snd_pcm_extplug_t</a> *&nbsp;</td>
 
549
          <td class="paramname"> <em>extplug</em>, </td>
 
550
        </tr>
 
551
        <tr>
 
552
          <td class="paramkey"><br>
 
553
</td>
 
554
          <td><br>
 
555
</td>
 
556
          <td class="paramtype">int&nbsp;</td>
 
557
          <td class="paramname"> <em>type</em>, </td>
 
558
        </tr>
 
559
        <tr>
 
560
          <td class="paramkey"><br>
 
561
</td>
 
562
          <td><br>
 
563
</td>
 
564
          <td class="paramtype">unsigned int&nbsp;</td>
 
565
          <td class="paramname"> <em>min</em>, </td>
 
566
        </tr>
 
567
        <tr>
 
568
          <td class="paramkey"><br>
 
569
</td>
 
570
          <td><br>
 
571
</td>
 
572
          <td class="paramtype">unsigned int&nbsp;</td>
 
573
          <td class="paramname"> <em>max</em></td><td>&nbsp;</td>
 
574
        </tr>
 
575
        <tr>
 
576
          <td><br>
 
577
</td>
 
578
          <td>)</td>
 
579
          <td><br>
 
580
</td><td><br>
 
581
</td><td width="100%"><br>
 
582
</td>
 
583
        </tr>
 
584
      </tbody></table>
 
585
</div>
 
586
<div class="memdoc">
 
587
 
 
588
<p>
 
589
Set slave parameter as the min/max values. 
 
590
</p><p>
 
591
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
592
  <table border="0" cellpadding="0" cellspacing="2">
 
593
    <tbody><tr><td valign="top"><br>
 
594
</td><td valign="top"><em>extplug</em>&nbsp;</td><td>the extplug handle </td></tr>
 
595
    <tr><td valign="top"><br>
 
596
</td><td valign="top"><em>type</em>&nbsp;</td><td>parameter type </td></tr>
 
597
    <tr><td valign="top"><br>
 
598
</td><td valign="top"><em>min</em>&nbsp;</td><td>the minimum value </td></tr>
 
599
    <tr><td valign="top"><br>
 
600
</td><td valign="top"><em>max</em>&nbsp;</td><td>the maximum value </td></tr>
 
601
  </tbody></table>
 
602
</dd></dl>
 
603
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>Sets
 
604
the slave parameter as the min/max values. The available values of the
 
605
given parameter type of the slave PCM is restricted between the given
 
606
minimum and maximum values. </div>
 
607
</div><p>
 
608
</p><hr size="1"><address style=""><small>Generated on Wed Sep 9 14:37:09 2009 for ALSA project - the C library reference by&nbsp;
 
609
<a href="http://www.doxygen.org/index.html">
 
610
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
 
611
</body></html>
 
 
b'\\ No newline at end of file'