-
Notifications
You must be signed in to change notification settings - Fork 82
Expand file tree
/
Copy pathgroup__ClientCallbacks.html
More file actions
686 lines (656 loc) · 39.9 KB
/
group__ClientCallbacks.html
File metadata and controls
686 lines (656 loc) · 39.9 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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
<!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: Setting Client Callbacks</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">Setting Client Callbacks<div class="ingroups"><a class="el" href="group__ClientFunctions.html">Creating & manipulating clients</a> » <a class="el" href="group__NonCallbackAPI.html">The non-callback API</a></div></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__ServerControl"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerControl.html">Controlling & querying JACK server operation</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:gad5a6904292f5c9790223c18aeab202bf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#gad5a6904292f5c9790223c18aeab202bf">jack_set_thread_init_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#a36a615301840e4edcfc3f61456c43020">JackThreadInitCallback</a> thread_init_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:gad5a6904292f5c9790223c18aeab202bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga417b907ee02efbe00f5e9a2f4d202599"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#ga417b907ee02efbe00f5e9a2f4d202599">jack_on_shutdown</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#a1f461fe99711af7edcb1b73b1315fbb3">JackShutdownCallback</a> function, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga417b907ee02efbe00f5e9a2f4d202599"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf54d9f133267170ef1e6ce5219d24dd4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#gaf54d9f133267170ef1e6ce5219d24dd4">jack_on_info_shutdown</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#ad30b9f6d5898ba8954bd51c4bc428a9e">JackInfoShutdownCallback</a> function, void *arg) JACK_WEAK_EXPORT</td></tr>
<tr class="separator:gaf54d9f133267170ef1e6ce5219d24dd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafb5ec9fb4b736606d676c135fb97888b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#gafb5ec9fb4b736606d676c135fb97888b">jack_set_process_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#ab94e71df11ce055f9a278f55a6e476bc">JackProcessCallback</a> process_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:gafb5ec9fb4b736606d676c135fb97888b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae797e2cde20faecb9be510c8873fbdd6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#gae797e2cde20faecb9be510c8873fbdd6">jack_set_freewheel_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#a2a9a8af9ac8206a0c67cef6a27e88be7">JackFreewheelCallback</a> freewheel_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:gae797e2cde20faecb9be510c8873fbdd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga030cc371acb19abe52861492acb960ad"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#ga030cc371acb19abe52861492acb960ad">jack_set_buffer_size_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#aae24422729bb05aa0731a2d9545d278c">JackBufferSizeCallback</a> bufsize_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga030cc371acb19abe52861492acb960ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac1b3eb298cfa2869b8773c6cecf7f4b3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#gac1b3eb298cfa2869b8773c6cecf7f4b3">jack_set_sample_rate_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#a0735e21ddb96029d46bf35f14fc7e895">JackSampleRateCallback</a> srate_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:gac1b3eb298cfa2869b8773c6cecf7f4b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga51b01a31e56c92f4e2788a94840f0f37"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#ga51b01a31e56c92f4e2788a94840f0f37">jack_set_client_registration_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, <a class="el" href="types_8h.html#a9221225159a10a6eedaf0d98eff6de84">JackClientRegistrationCallback</a> registration_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga51b01a31e56c92f4e2788a94840f0f37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga30983a0478551a3cd20b71d692b24007"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#ga30983a0478551a3cd20b71d692b24007">jack_set_port_registration_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, <a class="el" href="types_8h.html#ab67ac0b5c60ab9f94eba0c06ab16725c">JackPortRegistrationCallback</a> registration_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga30983a0478551a3cd20b71d692b24007"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0c73095c1d8ebba413de6834bd7757b9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#ga0c73095c1d8ebba413de6834bd7757b9">jack_set_port_rename_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, <a class="el" href="types_8h.html#ab5e21db10d45f938ec0fa688230c2c24">JackPortRenameCallback</a> rename_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga0c73095c1d8ebba413de6834bd7757b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5312576d779c0664a7c703c87a9dba89"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#ga5312576d779c0664a7c703c87a9dba89">jack_set_port_connect_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, <a class="el" href="types_8h.html#a351e09441e88b3013db37d3eb8e0a2b3">JackPortConnectCallback</a> connect_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga5312576d779c0664a7c703c87a9dba89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacd0804ccef7c6891d8265bd88e7429ee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#gacd0804ccef7c6891d8265bd88e7429ee">jack_set_graph_order_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, <a class="el" href="types_8h.html#ac3336628b231d38cfb07a94fd29067b3">JackGraphOrderCallback</a> graph_callback, void *) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:gacd0804ccef7c6891d8265bd88e7429ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga08196c75f06d9e68f9a3570dfcb1e323"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#ga08196c75f06d9e68f9a3570dfcb1e323">jack_set_xrun_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, <a class="el" href="types_8h.html#ac19798b331fa11b864f874408d26a0b0">JackXRunCallback</a> xrun_callback, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>
<tr class="separator:ga08196c75f06d9e68f9a3570dfcb1e323"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga70a38fb1e74c5e9df9f1305c695c58bf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html#ga70a38fb1e74c5e9df9f1305c695c58bf">jack_set_latency_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, <a class="el" href="types_8h.html#abbf969808e55bf3302079c2f57fae8c1">JackLatencyCallback</a> latency_callback, void *) JACK_WEAK_EXPORT</td></tr>
<tr class="separator:ga70a38fb1e74c5e9df9f1305c695c58bf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf54d9f133267170ef1e6ce5219d24dd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf54d9f133267170ef1e6ce5219d24dd4">◆ </a></span>jack_on_info_shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_on_info_shutdown </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#ad30b9f6d5898ba8954bd51c4bc428a9e">JackInfoShutdownCallback</a> </td>
<td class="paramname"><em>function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>
<tr><td class="paramname">function</td><td>The jack_shutdown function pointer. </td></tr>
<tr><td class="paramname">arg</td><td>The arguments for the jack_shutdown function.</td></tr>
</table>
</dd>
</dl>
<p>Register a function (and argument) to be called if and when the JACK server shuts down the client thread. The function must be written as if it were an asynchonrous POSIX signal handler — use only async-safe functions, and remember that it is executed from another thread. A typical function might set a flag or write to a pipe so that the rest of the application knows that the JACK client thread has shut down.</p>
<p>NOTE: clients do not need to call this. It exists only to help more complex clients understand what is going on. It should be called before jack_client_activate().</p>
<p>NOTE: if a client calls this AND <a class="el" href="group__ClientCallbacks.html#ga417b907ee02efbe00f5e9a2f4d202599">jack_on_shutdown()</a>, then in the event of a client thread shutdown, the callback passed to this function will be called, and the one passed to <a class="el" href="group__ClientCallbacks.html#ga417b907ee02efbe00f5e9a2f4d202599">jack_on_shutdown()</a> will not. </p>
</div>
</div>
<a id="ga417b907ee02efbe00f5e9a2f4d202599"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga417b907ee02efbe00f5e9a2f4d202599">◆ </a></span>jack_on_shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_on_shutdown </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#a1f461fe99711af7edcb1b73b1315fbb3">JackShutdownCallback</a> </td>
<td class="paramname"><em>function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>
<tr><td class="paramname">function</td><td>The jack_shutdown function pointer. </td></tr>
<tr><td class="paramname">arg</td><td>The arguments for the jack_shutdown function.</td></tr>
</table>
</dd>
</dl>
<p>Register a function (and argument) to be called if and when the JACK server shuts down the client thread. The function must be written as if it were an asynchonrous POSIX signal handler — use only async-safe functions, and remember that it is executed from another thread. A typical function might set a flag or write to a pipe so that the rest of the application knows that the JACK client thread has shut down.</p>
<p>NOTE: clients do not need to call this. It exists only to help more complex clients understand what is going on. It should be called before jack_client_activate().</p>
<p>NOTE: if a client calls this AND <a class="el" href="group__ClientCallbacks.html#gaf54d9f133267170ef1e6ce5219d24dd4">jack_on_info_shutdown()</a>, then the event of a client thread shutdown, the callback passed to this function will not be called, and the one passed to <a class="el" href="group__ClientCallbacks.html#gaf54d9f133267170ef1e6ce5219d24dd4">jack_on_info_shutdown()</a> will. </p>
</div>
</div>
<a id="ga030cc371acb19abe52861492acb960ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga030cc371acb19abe52861492acb960ad">◆ </a></span>jack_set_buffer_size_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_buffer_size_callback </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#aae24422729bb05aa0731a2d9545d278c">JackBufferSizeCallback</a> </td>
<td class="paramname"><em>bufsize_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell JACK to call <em>bufsize_callback</em> whenever the size of the the buffer that will be passed to the <em>process_callback</em> is about to change. Clients that depend on knowing the buffer size must supply a <em>bufsize_callback</em> before activating themselves.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>pointer to JACK client structure. </td></tr>
<tr><td class="paramname">bufsize_callback</td><td>function to call when the buffer size changes. </td></tr>
<tr><td class="paramname">arg</td><td>argument for <em>bufsize_callback</em>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="ga51b01a31e56c92f4e2788a94840f0f37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga51b01a31e56c92f4e2788a94840f0f37">◆ </a></span>jack_set_client_registration_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_client_registration_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a9221225159a10a6eedaf0d98eff6de84">JackClientRegistrationCallback</a> </td>
<td class="paramname"><em>registration_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the JACK server to call <em>registration_callback</em> whenever a port is registered or unregistered, passing <em>arg</em> as a parameter.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="gae797e2cde20faecb9be510c8873fbdd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae797e2cde20faecb9be510c8873fbdd6">◆ </a></span>jack_set_freewheel_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_freewheel_callback </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#a2a9a8af9ac8206a0c67cef6a27e88be7">JackFreewheelCallback</a> </td>
<td class="paramname"><em>freewheel_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the Jack server to call <em>freewheel_callback</em> whenever we enter or leave "freewheel" mode, passing <em>arg</em> as the second argument. The first argument to the callback will be non-zero if JACK is entering freewheel mode, and zero otherwise.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code. </dd></dl>
</div>
</div>
<a id="gacd0804ccef7c6891d8265bd88e7429ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd0804ccef7c6891d8265bd88e7429ee">◆ </a></span>jack_set_graph_order_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_graph_order_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ac3336628b231d38cfb07a94fd29067b3">JackGraphOrderCallback</a> </td>
<td class="paramname"><em>graph_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the JACK server to call <em>graph_callback</em> whenever the processing graph is reordered, passing <em>arg</em> as a parameter.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="ga70a38fb1e74c5e9df9f1305c695c58bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70a38fb1e74c5e9df9f1305c695c58bf">◆ </a></span>jack_set_latency_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_latency_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#abbf969808e55bf3302079c2f57fae8c1">JackLatencyCallback</a> </td>
<td class="paramname"><em>latency_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the Jack server to call <em>latency_callback</em> whenever it is necessary to recompute the latencies for some or all Jack ports.</p>
<p><em>latency_callback</em> will be called twice each time it is needed, once being passed JackCaptureLatency and once JackPlaybackLatency. See <a class="el" href="group__LatencyFunctions.html">Managing and determining latency</a> for the definition of each type of latency and related functions.</p>
<p><b>IMPORTANT: Most JACK clients do NOT need to register a latency callback.</b></p>
<p>Clients that meet any of the following conditions do NOT need to register a latency callback:</p>
<ul>
<li>have only input ports</li>
<li>have only output ports</li>
<li>their output is totally unrelated to their input</li>
<li>their output is not delayed relative to their input (i.e. data that arrives in a given process() callback is processed and output again in the same callback)</li>
</ul>
<p>Clients NOT registering a latency callback MUST also satisfy this condition:</p>
<ul>
<li>have no multiple distinct internal signal pathways</li>
</ul>
<p>This means that if your client has more than 1 input and output port, and considers them always "correlated" (e.g. as a stereo pair), then there is only 1 (e.g. stereo) signal pathway through the client. This would be true, for example, of a stereo FX rack client that has a left/right input pair and a left/right output pair.</p>
<p>However, this is somewhat a matter of perspective. The same FX rack client could be connected so that its two input ports were connected to entirely separate sources. Under these conditions, the fact that the client does not register a latency callback MAY result in port latency values being incorrect.</p>
<p>Clients that do not meet any of those conditions SHOULD register a latency callback.</p>
<p>Another case is when a client wants to use <a class="el" href="group__LatencyFunctions.html#gaf379bc0e88a6df6c4b7836db4b9382d7">jack_port_get_latency_range()</a>, which only returns meaninful values when ports get connected and latency values change.</p>
<p>See the documentation for <a class="el" href="group__LatencyFunctions.html#ga7a8f181fcec32945db7b8e06ee1ca94b">jack_port_set_latency_range()</a> on how the callback should operate. Remember that the <em>mode</em> argument given to the latency callback will need to be passed into <a class="el" href="group__LatencyFunctions.html#ga7a8f181fcec32945db7b8e06ee1ca94b">jack_port_set_latency_range()</a></p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="ga5312576d779c0664a7c703c87a9dba89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5312576d779c0664a7c703c87a9dba89">◆ </a></span>jack_set_port_connect_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_port_connect_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a351e09441e88b3013db37d3eb8e0a2b3">JackPortConnectCallback</a> </td>
<td class="paramname"><em>connect_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the JACK server to call <em>connect_callback</em> whenever a port is connected or disconnected, passing <em>arg</em> as a parameter.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="ga30983a0478551a3cd20b71d692b24007"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga30983a0478551a3cd20b71d692b24007">◆ </a></span>jack_set_port_registration_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_port_registration_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ab67ac0b5c60ab9f94eba0c06ab16725c">JackPortRegistrationCallback</a> </td>
<td class="paramname"><em>registration_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the JACK server to call <em>registration_callback</em> whenever a port is registered or unregistered, passing <em>arg</em> as a parameter.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="ga0c73095c1d8ebba413de6834bd7757b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0c73095c1d8ebba413de6834bd7757b9">◆ </a></span>jack_set_port_rename_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_port_rename_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ab5e21db10d45f938ec0fa688230c2c24">JackPortRenameCallback</a> </td>
<td class="paramname"><em>rename_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the JACK server to call <em>rename_callback</em> whenever a port is renamed, passing <em>arg</em> as a parameter.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="gafb5ec9fb4b736606d676c135fb97888b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafb5ec9fb4b736606d676c135fb97888b">◆ </a></span>jack_set_process_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_process_callback </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#ab94e71df11ce055f9a278f55a6e476bc">JackProcessCallback</a> </td>
<td class="paramname"><em>process_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the Jack server to call <em>process_callback</em> whenever there is work be done, passing <em>arg</em> as the second argument.</p>
<p>The code in the supplied function must be suitable for real-time execution. That means that it cannot call functions that might block for a long time. This includes all I/O functions (disk, TTY, network), malloc, free, printf, pthread_mutex_lock, sleep, wait, poll, select, pthread_join, pthread_cond_wait, etc, etc.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code, causing JACK to remove that client from the process() graph. </dd></dl>
</div>
</div>
<a id="gac1b3eb298cfa2869b8773c6cecf7f4b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1b3eb298cfa2869b8773c6cecf7f4b3">◆ </a></span>jack_set_sample_rate_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_sample_rate_callback </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#a0735e21ddb96029d46bf35f14fc7e895">JackSampleRateCallback</a> </td>
<td class="paramname"><em>srate_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the Jack server to call <em>srate_callback</em> whenever the system sample rate changes.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a id="gad5a6904292f5c9790223c18aeab202bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad5a6904292f5c9790223c18aeab202bf">◆ </a></span>jack_set_thread_init_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_thread_init_callback </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#a36a615301840e4edcfc3f61456c43020">JackThreadInitCallback</a> </td>
<td class="paramname"><em>thread_init_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell JACK to call <em>thread_init_callback</em> once just after the creation of the thread in which all other callbacks will be handled.</p>
<p>The code in the supplied function does not need to be suitable for real-time execution.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code, causing JACK to remove that client from the process() graph. </dd></dl>
</div>
</div>
<a id="ga08196c75f06d9e68f9a3570dfcb1e323"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga08196c75f06d9e68f9a3570dfcb1e323">◆ </a></span>jack_set_xrun_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_xrun_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ac19798b331fa11b864f874408d26a0b0">JackXRunCallback</a> </td>
<td class="paramname"><em>xrun_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the JACK server to call <em>xrun_callback</em> whenever there is a xrun, passing <em>arg</em> as a parameter.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code </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>