-
Notifications
You must be signed in to change notification settings - Fork 81
Expand file tree
/
Copy pathgroup__ClientFunctions.html
More file actions
492 lines (464 loc) · 28.5 KB
/
group__ClientFunctions.html
File metadata and controls
492 lines (464 loc) · 28.5 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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
<!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: Creating & manipulating clients</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 class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><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><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Creating & manipulating clients</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__NonCallbackAPI"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NonCallbackAPI.html">The non-callback API</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabbd2041bca191943b6ef29a991a131c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#gabbd2041bca191943b6ef29a991a131c5">jack_client_open</a> (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="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:gabbd2041bca191943b6ef29a991a131c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga97482adad8116b76635a63f646a2d2f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga97482adad8116b76635a63f646a2d2f5">jack_client_new</a> (const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</td></tr>
<tr class="separator:ga97482adad8116b76635a63f646a2d2f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga405646705e600d8bf66327bdbab8e363"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga405646705e600d8bf66327bdbab8e363">jack_client_close</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga405646705e600d8bf66327bdbab8e363"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab8b16ee616207532d0585d04a0bd1d60"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#gab8b16ee616207532d0585d04a0bd1d60">jack_client_name_size</a> (void) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:gab8b16ee616207532d0585d04a0bd1d60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga49f7d301475b45a8a3cc0da848d81e2f"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga49f7d301475b45a8a3cc0da848d81e2f">jack_get_client_name</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga49f7d301475b45a8a3cc0da848d81e2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c995eb51f38f3962dea4408122ced88"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga4c995eb51f38f3962dea4408122ced88">jack_get_uuid_for_client_name</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, const char *name) JACK_WEAK_EXPORT</td></tr>
<tr class="separator:ga4c995eb51f38f3962dea4408122ced88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab4cf2516014b436e762907016b5be2b4"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#gab4cf2516014b436e762907016b5be2b4">jack_get_client_name_by_uuid</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, const char *uuid) JACK_WEAK_EXPORT</td></tr>
<tr class="separator:gab4cf2516014b436e762907016b5be2b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga87be6679700acc40a0da17ac9ba3a31e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga87be6679700acc40a0da17ac9ba3a31e">jack_internal_client_new</a> (const char *client_name, const char *load_name, const char *load_init) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</td></tr>
<tr class="separator:ga87be6679700acc40a0da17ac9ba3a31e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ad890884c983c78ba93ed2d9b8ee8cc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga0ad890884c983c78ba93ed2d9b8ee8cc">jack_internal_client_close</a> (const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</td></tr>
<tr class="separator:ga0ad890884c983c78ba93ed2d9b8ee8cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9800d5b29bd7670d9944a15f6ea0ecf8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga9800d5b29bd7670d9944a15f6ea0ecf8">jack_activate</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga9800d5b29bd7670d9944a15f6ea0ecf8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2c6447b766b13d3aa356aba2b48e51fa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga2c6447b766b13d3aa356aba2b48e51fa">jack_deactivate</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga2c6447b766b13d3aa356aba2b48e51fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e78f0a2ca6c837709c7ec641afd9954"><td class="memItemLeft" align="right" valign="top">jack_native_thread_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga4e78f0a2ca6c837709c7ec641afd9954">jack_client_thread_id</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga4e78f0a2ca6c837709c7ec641afd9954"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15719a4abdcc5fa8415167dd6ed6512c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientFunctions.html#ga15719a4abdcc5fa8415167dd6ed6512c">jack_is_realtime</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga15719a4abdcc5fa8415167dd6ed6512c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Note: More documentation can be found in <a class="el" href="types_8h.html">jack/types.h</a>. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9800d5b29bd7670d9944a15f6ea0ecf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9800d5b29bd7670d9944a15f6ea0ecf8">◆ </a></span>jack_activate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_activate </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the Jack server that the program is ready to start processing audio.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="ga405646705e600d8bf66327bdbab8e363"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga405646705e600d8bf66327bdbab8e363">◆ </a></span>jack_client_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_client_close </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnects an external client from a JACK server.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="gab8b16ee616207532d0585d04a0bd1d60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab8b16ee616207532d0585d04a0bd1d60">◆ </a></span>jack_client_name_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_client_name_size </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the maximum number of characters in a JACK client name including the final NULL character. This value is a constant. </dd></dl>
</div>
</div>
<a id="ga97482adad8116b76635a63f646a2d2f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga97482adad8116b76635a63f646a2d2f5">◆ </a></span>jack_client_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a>* jack_client_new </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>client_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>THIS FUNCTION IS DEPRECATED AND SHOULD NOT BE USED IN NEW JACK CLIENTS</b> </p>
</div>
</div>
<a id="gabbd2041bca191943b6ef29a991a131c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabbd2041bca191943b6ef29a991a131c5">◆ </a></span>jack_client_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a>* jack_client_open </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"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open an external client session with a JACK server. This interface is more complex but more powerful than <a class="el" href="group__ClientFunctions.html#ga97482adad8116b76635a63f646a2d2f5">jack_client_new()</a>. With it, clients may choose which of several servers to connect, and control whether and how to start the server automatically, if it was not already running. There is also an option for JACK to generate a unique client name, when necessary.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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. The name scope is local to each server. Unless forbidden by the <a class="el" href="types_8h.html#a396617de2ef101891c51346f408a375ea352b176ffa092ec946a06b707f6aa21b">JackUseExactName</a> option, the server will modify this name to create a unique variant, if needed.</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#ab39e7f78dba631f3c0d34ac4cddcf80f">JackOpenOptions</a> bits are allowed.</td></tr>
<tr><td class="paramname">status</td><td>(if non-NULL) an address for JACK to return information from the open 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>
</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#a396617de2ef101891c51346f408a375ea348557bfdc579daed2e35cc41c4f09c7">JackServerName</a>] <em>(char *) server_name</em> selects from among several possible concurrent server instances. Server names are unique to each user. If unspecified, use "default" unless $JACK_DEFAULT_SERVER is defined in the process environment.</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>Opaque client handle if successful. If this is NULL, the open operation failed, <em>*status</em> includes <a class="el" href="types_8h.html#aaf80297bce18297403b99e3d320ac8a8a354fbb027d989173f50921d239f3812b">JackFailure</a> and the caller is not a JACK client. </dd></dl>
</div>
</div>
<a id="ga4e78f0a2ca6c837709c7ec641afd9954"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e78f0a2ca6c837709c7ec641afd9954">◆ </a></span>jack_client_thread_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">jack_native_thread_t jack_client_thread_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the pthread ID of the thread running the JACK client side code. </dd></dl>
</div>
</div>
<a id="ga2c6447b766b13d3aa356aba2b48e51fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c6447b766b13d3aa356aba2b48e51fa">◆ </a></span>jack_deactivate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_deactivate </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the Jack server to remove this <em>client</em> from the process graph. Also, disconnect all ports belonging to it, since inactive clients have no port connections.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="ga49f7d301475b45a8a3cc0da848d81e2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga49f7d301475b45a8a3cc0da848d81e2f">◆ </a></span>jack_get_client_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* jack_get_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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>pointer to actual client name. This is useful when <a class="el" href="types_8h.html#a396617de2ef101891c51346f408a375ea352b176ffa092ec946a06b707f6aa21b">JackUseExactName</a> is not specified on open 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. </dd></dl>
</div>
</div>
<a id="gab4cf2516014b436e762907016b5be2b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab4cf2516014b436e762907016b5be2b4">◆ </a></span>jack_get_client_name_by_uuid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* jack_get_client_name_by_uuid </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>uuid</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a pointer to the name of the client with the UUID specified by uuid.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>making the request </td></tr>
<tr><td class="paramname">uuid</td><td>the uuid of the client whose name is desired</td></tr>
</table>
</dd>
</dl>
<p>Return NULL if no such client with the given UUID exists </p>
</div>
</div>
<a id="ga4c995eb51f38f3962dea4408122ced88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c995eb51f38f3962dea4408122ced88">◆ </a></span>jack_get_uuid_for_client_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* jack_get_uuid_for_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">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>pointer to a string representation of the UUID for a client named</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>. If no such client exists, return NULL</td></tr>
<tr><td class="paramname">client</td><td>the client making the request </td></tr>
<tr><td class="paramname">name</td><td>the name of the client whose UUID is desired</td></tr>
</table>
</dd>
</dl>
<p>Return NULL if no such client with the given name exists </p>
</div>
</div>
<a id="ga0ad890884c983c78ba93ed2d9b8ee8cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ad890884c983c78ba93ed2d9b8ee8cc">◆ </a></span>jack_internal_client_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_internal_client_close </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>client_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove an internal client from a JACK server.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Please use <a class="el" href="intclient_8h.html#aff038e9c251a2cdf4a5ce94d9d0ea88c">jack_internal_client_load()</a>. </dd></dl>
</div>
</div>
<a id="ga87be6679700acc40a0da17ac9ba3a31e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga87be6679700acc40a0da17ac9ba3a31e">◆ </a></span>jack_internal_client_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_internal_client_new </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">const char * </td>
<td class="paramname"><em>load_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>load_init</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 must declare jack_initialize() and jack_finish() entry points, called at load and unload times. See inprocess.c for an example of how to write an internal client.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Please use <a class="el" href="intclient_8h.html#aff038e9c251a2cdf4a5ce94d9d0ea88c">jack_internal_client_load()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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.</td></tr>
<tr><td class="paramname">load_name</td><td>of a shared object file containing the code for the new client.</td></tr>
<tr><td class="paramname">load_init</td><td>an arbitary string passed to the jack_initialize() routine of the new client (may be NULL).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful. </dd></dl>
</div>
</div>
<a id="ga15719a4abdcc5fa8415167dd6ed6512c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga15719a4abdcc5fa8415167dd6ed6512c">◆ </a></span>jack_is_realtime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_is_realtime </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>pointer to JACK client structure.</td></tr>
</table>
</dd>
</dl>
<p>Check if the JACK subsystem is running with -R (–realtime).</p>
<dl class="section return"><dt>Returns</dt><dd>1 if JACK is running realtime, 0 otherwise </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>