-
Notifications
You must be signed in to change notification settings - Fork 81
Expand file tree
/
Copy pathintclient_8h.html
More file actions
319 lines (309 loc) · 18.8 KB
/
intclient_8h.html
File metadata and controls
319 lines (309 loc) · 18.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JACK-AUDIO-CONNECTION-KIT: intclient.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JACK-AUDIO-CONNECTION-KIT
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3e6ff996e0a05d442d13220a8cf7408f.html">jack</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">intclient.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">jack/types.h</a>></code><br />
</div>
<p><a href="intclient_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a06135991a92b175802b441cb07d2cc46"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="intclient_8h.html#a06135991a92b175802b441cb07d2cc46">jack_get_internal_client_name</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a> intclient)</td></tr>
<tr class="separator:a06135991a92b175802b441cb07d2cc46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a176a2daf66c8777eb1a845068fd7a822"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="intclient_8h.html#a176a2daf66c8777eb1a845068fd7a822">jack_internal_client_handle</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, const char *client_name, <a class="el" href="types_8h.html#a49053418570427a7a99d1bb45fb43f38">jack_status_t</a> *status, <a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a> *handle)</td></tr>
<tr class="separator:a176a2daf66c8777eb1a845068fd7a822"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff038e9c251a2cdf4a5ce94d9d0ea88c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="intclient_8h.html#aff038e9c251a2cdf4a5ce94d9d0ea88c">jack_internal_client_load</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, const char *client_name, <a class="el" href="types_8h.html#a0ef5011e5aab7655ad0d64babf7d91f0">jack_options_t</a> options, <a class="el" href="types_8h.html#a49053418570427a7a99d1bb45fb43f38">jack_status_t</a> *status, <a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a>,...)</td></tr>
<tr class="separator:aff038e9c251a2cdf4a5ce94d9d0ea88c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cb5e85d41c1d0fd0163a64859ba3672"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a49053418570427a7a99d1bb45fb43f38">jack_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="intclient_8h.html#a0cb5e85d41c1d0fd0163a64859ba3672">jack_internal_client_unload</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a> intclient)</td></tr>
<tr class="separator:a0cb5e85d41c1d0fd0163a64859ba3672"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a06135991a92b175802b441cb07d2cc46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06135991a92b175802b441cb07d2cc46">◆ </a></span>jack_get_internal_client_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* jack_get_internal_client_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a> </td>
<td class="paramname"><em>intclient</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an internal client's name. This is useful when <a class="el" href="types_8h.html#a396617de2ef101891c51346f408a375ea352b176ffa092ec946a06b707f6aa21b">JackUseExactName</a> was not specified on <a class="el" href="intclient_8h.html#aff038e9c251a2cdf4a5ce94d9d0ea88c">jack_internal_client_load()</a> and <a class="el" href="types_8h.html#aaf80297bce18297403b99e3d320ac8a8a09a73b951f3601ae9436bd3429ac0691">JackNameNotUnique</a> status was returned. In that case, the actual name will differ from the <em>client_name</em> requested.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>requesting JACK client's handle.</td></tr>
<tr><td class="paramname">intclient</td><td>handle returned from <a class="el" href="intclient_8h.html#aff038e9c251a2cdf4a5ce94d9d0ea88c">jack_internal_client_load()</a> or <a class="el" href="intclient_8h.html#a176a2daf66c8777eb1a845068fd7a822">jack_internal_client_handle()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NULL if unsuccessful, otherwise pointer to the internal client name obtained from the heap via malloc(). The caller should free() this storage when no longer needed. </dd></dl>
</div>
</div>
<a id="a176a2daf66c8777eb1a845068fd7a822"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a176a2daf66c8777eb1a845068fd7a822">◆ </a></span>jack_internal_client_handle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_internal_client_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>client_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a49053418570427a7a99d1bb45fb43f38">jack_status_t</a> * </td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a> * </td>
<td class="paramname"><em>handle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the <a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a> handle for an internal client running in the JACK server.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>requesting JACK client's handle.</td></tr>
<tr><td class="paramname">client_name</td><td>for the internal client of no more than <a class="el" href="group__ClientFunctions.html#gab8b16ee616207532d0585d04a0bd1d60">jack_client_name_size()</a> characters. The name scope is local to the current server.</td></tr>
<tr><td class="paramname">status</td><td>(if non-NULL) an address for JACK to return information from this operation. This status word is formed by OR-ing together the relevant <a class="el" href="types_8h.html#aaf80297bce18297403b99e3d320ac8a8">JackStatus</a> bits.</td></tr>
<tr><td class="paramname">handle</td><td>the client handle will be returned here (passed by reference because of the type.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successfullm non-zero otherwise. If non-zero, the internal client was not found, and <em>*status</em> includes the <a class="el" href="types_8h.html#aaf80297bce18297403b99e3d320ac8a8adc1e6e138037ea0bda450abbb61d814a">JackNoSuchClient</a> and <a class="el" href="types_8h.html#aaf80297bce18297403b99e3d320ac8a8a354fbb027d989173f50921d239f3812b">JackFailure</a> bits. </dd></dl>
</div>
</div>
<a id="aff038e9c251a2cdf4a5ce94d9d0ea88c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff038e9c251a2cdf4a5ce94d9d0ea88c">◆ </a></span>jack_internal_client_load()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_internal_client_load </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>client_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a0ef5011e5aab7655ad0d64babf7d91f0">jack_options_t</a> </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a49053418570427a7a99d1bb45fb43f38">jack_status_t</a> * </td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load an internal client into the JACK server.</p>
<p>Internal clients run inside the JACK server process. They can use most of the same functions as external clients. Each internal client is built as a shared object module, which must declare jack_initialize() and jack_finish() entry points called at load and unload times. See inprocess.c for an example.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>loading JACK client's handle.</td></tr>
<tr><td class="paramname">client_name</td><td>of at most <a class="el" href="group__ClientFunctions.html#gab8b16ee616207532d0585d04a0bd1d60">jack_client_name_size()</a> characters for the internal client to load. The name scope is local to the current server.</td></tr>
<tr><td class="paramname">options</td><td>formed by OR-ing together <a class="el" href="types_8h.html#a396617de2ef101891c51346f408a375e">JackOptions</a> bits. Only the <a class="el" href="types_8h.html#ac4e472a37c86a53ccbf35e903196501d">JackLoadOptions</a> bits are valid.</td></tr>
<tr><td class="paramname">status</td><td>(if non-NULL) an address for JACK to return information from the load operation. This status word is formed by OR-ing together the relevant <a class="el" href="types_8h.html#aaf80297bce18297403b99e3d320ac8a8">JackStatus</a> bits.</td></tr>
<tr><td class="paramname">handle</td><td>the client handle will be returned here (passed by reference because of the type.</td></tr>
</table>
</dd>
</dl>
<p><b>Optional parameters:</b> depending on corresponding [<em>options</em> bits] additional parameters may follow <em>status</em> (in this order).</p>
<ul>
<li>[<a class="el" href="types_8h.html#a396617de2ef101891c51346f408a375ea82905c7e1c615d183fffac16c0267e18">JackLoadName</a>] <em>(char *) load_name</em> is the shared object file from which to load the new internal client (otherwise use the <em>client_name</em>).</li>
</ul>
<ul>
<li>[<a class="el" href="types_8h.html#a396617de2ef101891c51346f408a375ea1cd6cb23e61406309871a644d1a5d3c7">JackLoadInit</a>] <em>(char *) load_init</em> an arbitary string passed to the internal client's jack_initialize() routine (otherwise NULL), of no more than <a class="el" href="types_8h.html#ab3686dbff70b81ae1165fe6401f70921">JACK_LOAD_INIT_LIMIT</a> bytes.</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>zero if successful, non-zero otherwise. If this is non-zero, the load operation failed, the internal client was not loaded, and <em>*status</em> includes the <a class="el" href="types_8h.html#aaf80297bce18297403b99e3d320ac8a8a354fbb027d989173f50921d239f3812b">JackFailure</a> bit. </dd></dl>
</div>
</div>
<a id="a0cb5e85d41c1d0fd0163a64859ba3672"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cb5e85d41c1d0fd0163a64859ba3672">◆ </a></span>jack_internal_client_unload()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a49053418570427a7a99d1bb45fb43f38">jack_status_t</a> jack_internal_client_unload </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a847a4a1bbd37cc5e2bca50eb7972b677">jack_intclient_t</a> </td>
<td class="paramname"><em>intclient</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unload an internal client from a JACK server. This calls the intclient's jack_finish() entry point then removes it. See inprocess.c for an example.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>unloading JACK client's handle.</td></tr>
<tr><td class="paramname">intclient</td><td>handle returned from <a class="el" href="intclient_8h.html#aff038e9c251a2cdf4a5ce94d9d0ea88c">jack_internal_client_load()</a> or <a class="el" href="intclient_8h.html#a176a2daf66c8777eb1a845068fd7a822">jack_internal_client_handle()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, otherwise <a class="el" href="types_8h.html#aaf80297bce18297403b99e3d320ac8a8">JackStatus</a> bits. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>