-
Notifications
You must be signed in to change notification settings - Fork 81
Expand file tree
/
Copy pathgroup__Metadata.html
More file actions
808 lines (764 loc) · 41.7 KB
/
group__Metadata.html
File metadata and controls
808 lines (764 loc) · 41.7 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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
<!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: Metadata API.</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="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Metadata API.</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structjack__property__t.html">jack_property_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structjack__description__t.html">jack_description_t</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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga315d1ca0c26292346f8bdb81c3983a89"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga315d1ca0c26292346f8bdb81c3983a89">JackPropertyChangeCallback</a>) (<a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> subject, const char *key, <a class="el" href="group__Metadata.html#ga5119741a63b2fc47c8f8f7a5cb84143c">jack_property_change_t</a> change, void *arg)</td></tr>
<tr class="separator:ga315d1ca0c26292346f8bdb81c3983a89"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga5119741a63b2fc47c8f8f7a5cb84143c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga5119741a63b2fc47c8f8f7a5cb84143c">jack_property_change_t</a> { <a class="el" href="group__Metadata.html#gga5119741a63b2fc47c8f8f7a5cb84143cab8a113452379ad11983da18cbd3076c9">PropertyCreated</a>
, <a class="el" href="group__Metadata.html#gga5119741a63b2fc47c8f8f7a5cb84143ca4a3ad982c9a1efbb233dcb2a2b5bdeec">PropertyChanged</a>
, <a class="el" href="group__Metadata.html#gga5119741a63b2fc47c8f8f7a5cb84143ca3b086390e7598359893b32c6cc3f9a90">PropertyDeleted</a>
}</td></tr>
<tr class="separator:ga5119741a63b2fc47c8f8f7a5cb84143c"><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:gae93daaae3727ad7b38d1156261889652"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#gae93daaae3727ad7b38d1156261889652">jack_set_property</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, <a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> subject, const char *key, const char *value, const char *type)</td></tr>
<tr class="separator:gae93daaae3727ad7b38d1156261889652"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b7b25ad3e29266e056d7bc3e647b39e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga1b7b25ad3e29266e056d7bc3e647b39e">jack_get_property</a> (<a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> subject, const char *key, char **value, char **type)</td></tr>
<tr class="separator:ga1b7b25ad3e29266e056d7bc3e647b39e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaafd9f68baaa56ff0ace13ba300db614b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#gaafd9f68baaa56ff0ace13ba300db614b">jack_free_description</a> (<a class="el" href="structjack__description__t.html">jack_description_t</a> *desc, int free_description_itself)</td></tr>
<tr class="separator:gaafd9f68baaa56ff0ace13ba300db614b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga63fd5c78f1185a2c0063323576350cc0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga63fd5c78f1185a2c0063323576350cc0">jack_get_properties</a> (<a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> subject, <a class="el" href="structjack__description__t.html">jack_description_t</a> *desc)</td></tr>
<tr class="separator:ga63fd5c78f1185a2c0063323576350cc0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga539718c59d8a1fe68ed006e2699221df"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga539718c59d8a1fe68ed006e2699221df">jack_get_all_properties</a> (<a class="el" href="structjack__description__t.html">jack_description_t</a> **descs)</td></tr>
<tr class="separator:ga539718c59d8a1fe68ed006e2699221df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac17ed2c94fb09de5573e3cb7d08f88de"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#gac17ed2c94fb09de5573e3cb7d08f88de">jack_remove_property</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> subject, const char *key)</td></tr>
<tr class="separator:gac17ed2c94fb09de5573e3cb7d08f88de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80327b9c49b533d726fbf97705dbd874"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga80327b9c49b533d726fbf97705dbd874">jack_remove_properties</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> subject)</td></tr>
<tr class="separator:ga80327b9c49b533d726fbf97705dbd874"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4fde77863c71057a8e8c8daa369f7a60"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga4fde77863c71057a8e8c8daa369f7a60">jack_remove_all_properties</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client)</td></tr>
<tr class="separator:ga4fde77863c71057a8e8c8daa369f7a60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaed0164bd6b54be3296a49bf988817477"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#gaed0164bd6b54be3296a49bf988817477">jack_set_property_change_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="group__Metadata.html#ga315d1ca0c26292346f8bdb81c3983a89">JackPropertyChangeCallback</a> callback, void *arg)</td></tr>
<tr class="separator:gaed0164bd6b54be3296a49bf988817477"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga955872b1404ac109f59180d1b33520d6"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga955872b1404ac109f59180d1b33520d6">JACK_METADATA_CONNECTED</a></td></tr>
<tr class="separator:ga955872b1404ac109f59180d1b33520d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga820305a689612f5157fd1550f5591ec0"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga820305a689612f5157fd1550f5591ec0">JACK_METADATA_EVENT_TYPES</a></td></tr>
<tr class="separator:ga820305a689612f5157fd1550f5591ec0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga77f61dc9ed7711379e43a354d6ae08e0"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga77f61dc9ed7711379e43a354d6ae08e0">JACK_METADATA_HARDWARE</a></td></tr>
<tr class="separator:ga77f61dc9ed7711379e43a354d6ae08e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad6554216287cf3fe5d9d829b89512b2c"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#gad6554216287cf3fe5d9d829b89512b2c">JACK_METADATA_ICON_LARGE</a></td></tr>
<tr class="separator:gad6554216287cf3fe5d9d829b89512b2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabeaa8cf2f2310088d825f7c657536a4a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#gabeaa8cf2f2310088d825f7c657536a4a">JACK_METADATA_ICON_NAME</a></td></tr>
<tr class="separator:gabeaa8cf2f2310088d825f7c657536a4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8c0a77842c83a6dcafa6b9a86f70e6fc"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga8c0a77842c83a6dcafa6b9a86f70e6fc">JACK_METADATA_ICON_SMALL</a></td></tr>
<tr class="separator:ga8c0a77842c83a6dcafa6b9a86f70e6fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8dd67511ec55a200a946f8c3394a915d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga8dd67511ec55a200a946f8c3394a915d">JACK_METADATA_ORDER</a></td></tr>
<tr class="separator:ga8dd67511ec55a200a946f8c3394a915d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b8ad999c6f498f939c1f55226c4e3c4"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga7b8ad999c6f498f939c1f55226c4e3c4">JACK_METADATA_PRETTY_NAME</a></td></tr>
<tr class="separator:ga7b8ad999c6f498f939c1f55226c4e3c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga68ad11f571b1382c971f1d73851d11bb"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga68ad11f571b1382c971f1d73851d11bb">JACK_METADATA_PORT_GROUP</a></td></tr>
<tr class="separator:ga68ad11f571b1382c971f1d73851d11bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4b1f5530a7142bf5751250c6ab6e1d29"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Metadata.html#ga4b1f5530a7142bf5751250c6ab6e1d29">JACK_METADATA_SIGNAL_TYPE</a></td></tr>
<tr class="separator:ga4b1f5530a7142bf5751250c6ab6e1d29"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga315d1ca0c26292346f8bdb81c3983a89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga315d1ca0c26292346f8bdb81c3983a89">◆ </a></span>JackPropertyChangeCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* JackPropertyChangeCallback) (<a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> subject, const char *key, <a class="el" href="group__Metadata.html#ga5119741a63b2fc47c8f8f7a5cb84143c">jack_property_change_t</a> change, void *arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype for the client supplied function that is called by the engine anytime a property or properties have been modified.</p>
<p>Note that when the key is empty, it means all properties have been modified. This is often used to indicate that the removal of all keys.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">subject</td><td>The subject the change relates to, this can be either a client or port </td></tr>
<tr><td class="paramname">key</td><td>The key of the modified property (URI string) </td></tr>
<tr><td class="paramname">change</td><td>Wherever the key has been created, changed or deleted </td></tr>
<tr><td class="paramname">arg</td><td>pointer to a client supplied structure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga5119741a63b2fc47c8f8f7a5cb84143c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5119741a63b2fc47c8f8f7a5cb84143c">◆ </a></span>jack_property_change_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Metadata.html#ga5119741a63b2fc47c8f8f7a5cb84143c">jack_property_change_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5119741a63b2fc47c8f8f7a5cb84143cab8a113452379ad11983da18cbd3076c9"></a>PropertyCreated </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga5119741a63b2fc47c8f8f7a5cb84143ca4a3ad982c9a1efbb233dcb2a2b5bdeec"></a>PropertyChanged </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga5119741a63b2fc47c8f8f7a5cb84143ca3b086390e7598359893b32c6cc3f9a90"></a>PropertyDeleted </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaafd9f68baaa56ff0ace13ba300db614b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaafd9f68baaa56ff0ace13ba300db614b">◆ </a></span>jack_free_description()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_free_description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__description__t.html">jack_description_t</a> * </td>
<td class="paramname"><em>desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>free_description_itself</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a description.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">desc</td><td>a <a class="el" href="structjack__description__t.html">jack_description_t</a> whose associated memory will all be released </td></tr>
<tr><td class="paramname">free_description_itself</td><td>if non-zero, then</td></tr>
<tr><td class="paramname">desc</td><td>will also be passed to free() </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga539718c59d8a1fe68ed006e2699221df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga539718c59d8a1fe68ed006e2699221df">◆ </a></span>jack_get_all_properties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_get_all_properties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__description__t.html">jack_description_t</a> ** </td>
<td class="paramname"><em>descs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get descriptions for all subjects with metadata. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">descs</td><td>Set to an array of descriptions. The caller must free each of these with <a class="el" href="group__Metadata.html#gaafd9f68baaa56ff0ace13ba300db614b">jack_free_description()</a>, and the array itself with <a class="el" href="group__TimeFunctions.html#ga437010097629ac8124a56c752c02f299">jack_free()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of descriptions, or -1 on error. </dd></dl>
</div>
</div>
<a id="ga63fd5c78f1185a2c0063323576350cc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga63fd5c78f1185a2c0063323576350cc0">◆ </a></span>jack_get_properties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_get_properties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> </td>
<td class="paramname"><em>subject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structjack__description__t.html">jack_description_t</a> * </td>
<td class="paramname"><em>desc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a description of <code>subject</code>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">subject</td><td>The subject to get all properties of. </td></tr>
<tr><td class="paramname">desc</td><td>Set to the description of subject if found, or NULL otherwise. The caller must free this value with <a class="el" href="group__Metadata.html#gaafd9f68baaa56ff0ace13ba300db614b">jack_free_description()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of properties, -1 if no <code>subject</code> with any properties exists. </dd></dl>
</div>
</div>
<a id="ga1b7b25ad3e29266e056d7bc3e647b39e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b7b25ad3e29266e056d7bc3e647b39e">◆ </a></span>jack_get_property()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_get_property </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> </td>
<td class="paramname"><em>subject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a property on <code>subject</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">subject</td><td>The subject to get the property from. </td></tr>
<tr><td class="paramname">key</td><td>The key of the property. </td></tr>
<tr><td class="paramname">value</td><td>Set to the value of the property if found, or NULL otherwise. The caller must free this value with <a class="el" href="group__TimeFunctions.html#ga437010097629ac8124a56c752c02f299">jack_free()</a>. </td></tr>
<tr><td class="paramname">type</td><td>The type of the property if set, or NULL. See the discussion of types in the definition of <a class="el" href="structjack__property__t.html">jack_property_t</a> above. If non-null, the caller must free this value with <a class="el" href="group__TimeFunctions.html#ga437010097629ac8124a56c752c02f299">jack_free()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 if the <code>subject</code> has no <code>key</code> property. </dd></dl>
</div>
</div>
<a id="ga4fde77863c71057a8e8c8daa369f7a60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4fde77863c71057a8e8c8daa369f7a60">◆ </a></span>jack_remove_all_properties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_remove_all_properties </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>Remove all properties.</p>
<p>WARNING!! This deletes all metadata managed by a running JACK server. Data lost cannot be recovered (though it can be recreated by new calls to <a class="el" href="group__Metadata.html#gae93daaae3727ad7b38d1156261889652">jack_set_property()</a>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The JACK client making the request to remove all properties</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise </dd></dl>
</div>
</div>
<a id="ga80327b9c49b533d726fbf97705dbd874"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga80327b9c49b533d726fbf97705dbd874">◆ </a></span>jack_remove_properties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_remove_properties </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#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> </td>
<td class="paramname"><em>subject</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove all properties on a subject.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The JACK client making the request to remove some properties. </td></tr>
<tr><td class="paramname">subject</td><td>The subject to remove all properties from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a count of the number of properties removed, or -1 on error. </dd></dl>
</div>
</div>
<a id="gac17ed2c94fb09de5573e3cb7d08f88de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac17ed2c94fb09de5573e3cb7d08f88de">◆ </a></span>jack_remove_property()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_remove_property </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#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> </td>
<td class="paramname"><em>subject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a single property on a subject.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The JACK client making the request to remove the property. </td></tr>
<tr><td class="paramname">subject</td><td>The subject to remove the property from. </td></tr>
<tr><td class="paramname">key</td><td>The key of the property to be removed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise </dd></dl>
</div>
</div>
<a id="gae93daaae3727ad7b38d1156261889652"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae93daaae3727ad7b38d1156261889652">◆ </a></span>jack_set_property()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_property </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#a346b785a201c9eb5a41a106f87829c9f">jack_uuid_t</a> </td>
<td class="paramname"><em>subject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a property on <code>subject</code>.</p>
<p>See the above documentation for rules about <code>subject</code> and <code>key</code>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">subject</td><td>The subject to set the property on. </td></tr>
<tr><td class="paramname">key</td><td>The key of the property. </td></tr>
<tr><td class="paramname">value</td><td>The value of the property. </td></tr>
<tr><td class="paramname">type</td><td>The type of the property. See the discussion of types in the definition of <a class="el" href="structjack__property__t.html">jack_property_t</a> above. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
</div>
</div>
<a id="gaed0164bd6b54be3296a49bf988817477"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed0164bd6b54be3296a49bf988817477">◆ </a></span>jack_set_property_change_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_property_change_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="group__Metadata.html#ga315d1ca0c26292346f8bdb81c3983a89">JackPropertyChangeCallback</a> </td>
<td class="paramname"><em>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>Arrange for <code>client</code> to call <code>callback</code> whenever a property is created, changed or deleted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>the JACK client making the request </td></tr>
<tr><td class="paramname">callback</td><td>the function to be invoked when a property change occurs </td></tr>
<tr><td class="paramname">arg</td><td>the argument to be passed to</td></tr>
<tr><td class="paramname">callback</td><td>when it is invoked</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 success, -1 otherwise. </dd></dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga955872b1404ac109f59180d1b33520d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga955872b1404ac109f59180d1b33520d6">◆ </a></span>JACK_METADATA_CONNECTED</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_CONNECTED</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A value that identifies what the hardware port is connected to (an external device of some kind). Possible values might be "E-Piano" or "Master 2 Track". </p>
</div>
</div>
<a id="ga820305a689612f5157fd1550f5591ec0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga820305a689612f5157fd1550f5591ec0">◆ </a></span>JACK_METADATA_EVENT_TYPES</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_EVENT_TYPES</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The supported event types of an event port.</p>
<p>This is a kludge around Jack only supporting MIDI, particularly for OSC. This property is a comma-separated list of event types, currently "MIDI" or "OSC". If this contains "OSC", the port may carry OSC bundles (first byte '#') or OSC messages (first byte '/'). Note that the "status byte" of both OSC events is not a valid MIDI status byte, so MIDI clients that check the status byte will gracefully ignore OSC messages if the user makes an inappropriate connection. </p>
</div>
</div>
<a id="ga77f61dc9ed7711379e43a354d6ae08e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga77f61dc9ed7711379e43a354d6ae08e0">◆ </a></span>JACK_METADATA_HARDWARE</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_HARDWARE</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A value that should be shown when attempting to identify the specific hardware outputs of a client. Typical values might be "ADAT1", "S/PDIF L" or "MADI 43". </p>
</div>
</div>
<a id="gad6554216287cf3fe5d9d829b89512b2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6554216287cf3fe5d9d829b89512b2c">◆ </a></span>JACK_METADATA_ICON_LARGE</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_ICON_LARGE</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A value with a MIME type of "image/png;base64" that is an encoding of an NxN (with 32 < N <= 128) image to be used when displaying a visual representation of that client or port. </p>
</div>
</div>
<a id="gabeaa8cf2f2310088d825f7c657536a4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabeaa8cf2f2310088d825f7c657536a4a">◆ </a></span>JACK_METADATA_ICON_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_ICON_NAME</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of the icon for the subject (typically client).</p>
<p>This is used for looking up icons on the system, possibly with many sizes or themes. Icons should be searched for according to the freedesktop Icon</p>
<p>Theme Specification: <a href="https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html">https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html</a> </p>
</div>
</div>
<a id="ga8c0a77842c83a6dcafa6b9a86f70e6fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8c0a77842c83a6dcafa6b9a86f70e6fc">◆ </a></span>JACK_METADATA_ICON_SMALL</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_ICON_SMALL</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A value with a MIME type of "image/png;base64" that is an encoding of an NxN (with N <=32) image to be used when displaying a visual representation of that client or port. </p>
</div>
</div>
<a id="ga8dd67511ec55a200a946f8c3394a915d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8dd67511ec55a200a946f8c3394a915d">◆ </a></span>JACK_METADATA_ORDER</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_ORDER</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Order for a port.</p>
<p>This is used to specify the best order to show ports in user interfaces. The value MUST be an integer. There are no other requirements, so there may be gaps in the orders for several ports. Applications should compare the orders of ports to determine their relative order, but must not assign any other relevance to order values.</p>
<p>It is encouraged to use <a href="http://www.w3.org/2001/XMLSchema#int">http://www.w3.org/2001/XMLSchema#int</a> as the type. </p>
</div>
</div>
<a id="ga68ad11f571b1382c971f1d73851d11bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga68ad11f571b1382c971f1d73851d11bb">◆ </a></span>JACK_METADATA_PORT_GROUP</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_PORT_GROUP</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga7b8ad999c6f498f939c1f55226c4e3c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7b8ad999c6f498f939c1f55226c4e3c4">◆ </a></span>JACK_METADATA_PRETTY_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_PRETTY_NAME</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A value that should be shown to the user when displaying a port to the user, unless the user has explicitly overridden that a request to show the port name, or some other key value. </p>
</div>
</div>
<a id="ga4b1f5530a7142bf5751250c6ab6e1d29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4b1f5530a7142bf5751250c6ab6e1d29">◆ </a></span>JACK_METADATA_SIGNAL_TYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* JACK_METADATA_SIGNAL_TYPE</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of an audio signal.</p>
<p>This property allows audio ports to be tagged with a "meaning". The value is a simple string. Currently, the only type is "CV", for "control voltage" ports. Hosts SHOULD be take care to not treat CV ports as audibile and send their output directly to speakers. In particular, CV ports are not necessarily periodic at all and may have very high DC. </p>
</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>