-
Notifications
You must be signed in to change notification settings - Fork 82
Expand file tree
/
Copy pathgroup__SessionClientFunctions.html
More file actions
372 lines (350 loc) · 23.8 KB
/
group__SessionClientFunctions.html
File metadata and controls
372 lines (350 loc) · 23.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
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
<!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: Session API for 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="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Session API for clients.</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="struct__jack__session__event.html">_jack_session_event</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:gadaa6c819c4e14eb162b5d3f462866dfc"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__SessionClientFunctions.html#ga5616b829095cc341cee4610aba992a4d">JackSessionEventType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#gadaa6c819c4e14eb162b5d3f462866dfc">jack_session_event_type_t</a></td></tr>
<tr class="separator:gadaa6c819c4e14eb162b5d3f462866dfc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaff8d9b1766409d50565aabd2a5b9ab4f"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__SessionClientFunctions.html#ga596a05b8e9be60e04ee3f8d434c5d8f8">JackSessionFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#gaff8d9b1766409d50565aabd2a5b9ab4f">jack_session_flags_t</a></td></tr>
<tr class="separator:gaff8d9b1766409d50565aabd2a5b9ab4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafbf49270fbcf5cfce2abd26d7ee212b9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__jack__session__event.html">_jack_session_event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#gafbf49270fbcf5cfce2abd26d7ee212b9">jack_session_event_t</a></td></tr>
<tr class="separator:gafbf49270fbcf5cfce2abd26d7ee212b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2c0dc123dd2c1a2d0e8c9ce90d25b89c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#ga2c0dc123dd2c1a2d0e8c9ce90d25b89c">JackSessionCallback</a>) (<a class="el" href="group__SessionClientFunctions.html#gafbf49270fbcf5cfce2abd26d7ee212b9">jack_session_event_t</a> *event, void *arg)</td></tr>
<tr class="separator:ga2c0dc123dd2c1a2d0e8c9ce90d25b89c"><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:ga5616b829095cc341cee4610aba992a4d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#ga5616b829095cc341cee4610aba992a4d">JackSessionEventType</a> { <a class="el" href="group__SessionClientFunctions.html#gga5616b829095cc341cee4610aba992a4da01d1ac5a741784533361414c7c7cdbfc">JackSessionSave</a> = 1
, <a class="el" href="group__SessionClientFunctions.html#gga5616b829095cc341cee4610aba992a4da67c5f9e521e4448ba3d4b5f24e91e129">JackSessionSaveAndQuit</a> = 2
, <a class="el" href="group__SessionClientFunctions.html#gga5616b829095cc341cee4610aba992a4da8137dfcdaf5969bf1032117157d4015f">JackSessionSaveTemplate</a> = 3
}</td></tr>
<tr class="separator:ga5616b829095cc341cee4610aba992a4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga596a05b8e9be60e04ee3f8d434c5d8f8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#ga596a05b8e9be60e04ee3f8d434c5d8f8">JackSessionFlags</a> { <a class="el" href="group__SessionClientFunctions.html#gga596a05b8e9be60e04ee3f8d434c5d8f8aa7888ab24ad3a832b7314a366f543bbd">JackSessionSaveError</a> = 0x01
, <a class="el" href="group__SessionClientFunctions.html#gga596a05b8e9be60e04ee3f8d434c5d8f8a5364c2667fc5fa44cf84dfde4786d775">JackSessionNeedTerminal</a> = 0x02
}</td></tr>
<tr class="separator:ga596a05b8e9be60e04ee3f8d434c5d8f8"><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:ga27846b86d11b2a8682b5d5220c87baa9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#ga27846b86d11b2a8682b5d5220c87baa9">jack_set_session_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="group__SessionClientFunctions.html#ga2c0dc123dd2c1a2d0e8c9ce90d25b89c">JackSessionCallback</a> session_callback, void *arg) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</td></tr>
<tr class="separator:ga27846b86d11b2a8682b5d5220c87baa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga288d501f11a7c857a956a5a885a9855f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#ga288d501f11a7c857a956a5a885a9855f">jack_session_reply</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="group__SessionClientFunctions.html#gafbf49270fbcf5cfce2abd26d7ee212b9">jack_session_event_t</a> *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</td></tr>
<tr class="separator:ga288d501f11a7c857a956a5a885a9855f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeb90c4653b8f6ef713b9e19238d28c13"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#gaeb90c4653b8f6ef713b9e19238d28c13">jack_session_event_free</a> (<a class="el" href="group__SessionClientFunctions.html#gafbf49270fbcf5cfce2abd26d7ee212b9">jack_session_event_t</a> *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</td></tr>
<tr class="separator:gaeb90c4653b8f6ef713b9e19238d28c13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac45ae7c26843f51d27be729b902c7dbe"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#gac45ae7c26843f51d27be729b902c7dbe">jack_client_get_uuid</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client) JACK_WEAK_EXPORT</td></tr>
<tr class="separator:gac45ae7c26843f51d27be729b902c7dbe"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>Use of JACK-Session is currently deprecated and unsupported. JACK developers recommend the use of NSM instead. See <a href="https://new-session-manager.jackaudio.org/">https://new-session-manager.jackaudio.org/</a></dd></dl>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gafbf49270fbcf5cfce2abd26d7ee212b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafbf49270fbcf5cfce2abd26d7ee212b9">◆ </a></span>jack_session_event_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct__jack__session__event.html">_jack_session_event</a> <a class="el" href="group__SessionClientFunctions.html#gafbf49270fbcf5cfce2abd26d7ee212b9">jack_session_event_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gadaa6c819c4e14eb162b5d3f462866dfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadaa6c819c4e14eb162b5d3f462866dfc">◆ </a></span>jack_session_event_type_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__SessionClientFunctions.html#ga5616b829095cc341cee4610aba992a4d">JackSessionEventType</a> <a class="el" href="group__SessionClientFunctions.html#gadaa6c819c4e14eb162b5d3f462866dfc">jack_session_event_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaff8d9b1766409d50565aabd2a5b9ab4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaff8d9b1766409d50565aabd2a5b9ab4f">◆ </a></span>jack_session_flags_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__SessionClientFunctions.html#ga596a05b8e9be60e04ee3f8d434c5d8f8">JackSessionFlags</a> <a class="el" href="group__SessionClientFunctions.html#gaff8d9b1766409d50565aabd2a5b9ab4f">jack_session_flags_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Session flags. </p>
</div>
</div>
<a id="ga2c0dc123dd2c1a2d0e8c9ce90d25b89c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c0dc123dd2c1a2d0e8c9ce90d25b89c">◆ </a></span>JackSessionCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* JackSessionCallback) (<a class="el" href="group__SessionClientFunctions.html#gafbf49270fbcf5cfce2abd26d7ee212b9">jack_session_event_t</a> *event, void *arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype for the client supplied function that is called whenever a session notification is sent via <a class="el" href="group__JackSessionManagerAPI.html#gad5683da5880fc248ba87cdf2cc3c1887">jack_session_notify()</a>.</p>
<p>Ownership of the memory of <em>event</em> is passed to the application. It must be freed using jack_session_event_free when its not used anymore.</p>
<p>The client must promptly call jack_session_reply for this event.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>Use of JACK-Session is currently deprecated and unsupported. JACK developers recommend the use of NSM instead. See <a href="https://github.com/linuxaudio/new-session-manager">https://github.com/linuxaudio/new-session-manager</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>The event structure. </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="ga5616b829095cc341cee4610aba992a4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5616b829095cc341cee4610aba992a4d">◆ </a></span>JackSessionEventType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__SessionClientFunctions.html#ga5616b829095cc341cee4610aba992a4d">JackSessionEventType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Session event type.</p>
<p>If a client can't save templates, i might just do a normal save.</p>
<p>There is no "quit without saving" event because a client might refuse to quit when it has unsaved data, but other clients may have already quit. This results in too much confusion, so it is unsupported. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5616b829095cc341cee4610aba992a4da01d1ac5a741784533361414c7c7cdbfc"></a>JackSessionSave </td><td class="fielddoc"><p>Save the session completely.</p>
<p>The client may save references to data outside the provided directory, but it must do so by creating a link inside the provided directory and referring to that in any save files. The client must not refer to data files outside the provided directory directly in save files, because this makes it impossible for the session manager to create a session archive for distribution or archival. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga5616b829095cc341cee4610aba992a4da67c5f9e521e4448ba3d4b5f24e91e129"></a>JackSessionSaveAndQuit </td><td class="fielddoc"><p>Save the session completely, then quit.</p>
<p>The rules for saving are exactly the same as for JackSessionSave. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga5616b829095cc341cee4610aba992a4da8137dfcdaf5969bf1032117157d4015f"></a>JackSessionSaveTemplate </td><td class="fielddoc"><p>Save a session template.</p>
<p>A session template is a "skeleton" of the session, but without any data. Clients must save a session that, when restored, will create the same ports as a full save would have. However, the actual data contained in the session may not be saved (e.g. a DAW would create the necessary tracks, but not save the actual recorded data). </p>
</td></tr>
</table>
</div>
</div>
<a id="ga596a05b8e9be60e04ee3f8d434c5d8f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga596a05b8e9be60e04ee3f8d434c5d8f8">◆ </a></span>JackSessionFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__SessionClientFunctions.html#ga596a05b8e9be60e04ee3f8d434c5d8f8">JackSessionFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="group__SessionClientFunctions.html#gaff8d9b1766409d50565aabd2a5b9ab4f">jack_session_flags_t</a> bits </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga596a05b8e9be60e04ee3f8d434c5d8f8aa7888ab24ad3a832b7314a366f543bbd"></a>JackSessionSaveError </td><td class="fielddoc"><p>An error occurred while saving. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga596a05b8e9be60e04ee3f8d434c5d8f8a5364c2667fc5fa44cf84dfde4786d775"></a>JackSessionNeedTerminal </td><td class="fielddoc"><p>Client needs to be run in a terminal. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac45ae7c26843f51d27be729b902c7dbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac45ae7c26843f51d27be729b902c7dbe">◆ </a></span>jack_client_get_uuid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* jack_client_get_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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the assigned uuid for client. Safe to call from callback and all other threads.</p>
<p>The caller is responsible for calling jack_free(3) on any non-NULL returned value. </p>
</div>
</div>
<a id="gaeb90c4653b8f6ef713b9e19238d28c13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb90c4653b8f6ef713b9e19238d28c13">◆ </a></span>jack_session_event_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_session_event_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__SessionClientFunctions.html#gafbf49270fbcf5cfce2abd26d7ee212b9">jack_session_event_t</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free memory used by a jack_session_event_t.</p>
<p>This also frees the memory used by the command_line pointer, if its non NULL.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>Use of JACK-Session is currently deprecated and unsupported. JACK developers recommend the use of NSM instead. See <a href="https://github.com/linuxaudio/new-session-manager">https://github.com/linuxaudio/new-session-manager</a> </dd></dl>
</div>
</div>
<a id="ga288d501f11a7c857a956a5a885a9855f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga288d501f11a7c857a956a5a885a9855f">◆ </a></span>jack_session_reply()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_session_reply </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__SessionClientFunctions.html#gafbf49270fbcf5cfce2abd26d7ee212b9">jack_session_event_t</a> * </td>
<td class="paramname"><em>event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reply to a session event.</p>
<p>This can either be called directly from the callback, or later from a different thread. For example, it is possible to push the event through a queue and execute the save code from the GUI thread.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>Use of JACK-Session is currently deprecated and unsupported. JACK developers recommend the use of NSM instead. See <a href="https://github.com/linuxaudio/new-session-manager">https://github.com/linuxaudio/new-session-manager</a></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="ga27846b86d11b2a8682b5d5220c87baa9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga27846b86d11b2a8682b5d5220c87baa9">◆ </a></span>jack_set_session_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_session_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__SessionClientFunctions.html#ga2c0dc123dd2c1a2d0e8c9ce90d25b89c">JackSessionCallback</a> </td>
<td class="paramname"><em>session_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>session_callback</em> when a session event is to be delivered.</p>
<p>setting more than one session_callback per process is probably a design error. if you have a multiclient application its more sensible to create a jack_client with only a session callback set.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>Use of JACK-Session is currently deprecated and unsupported. JACK developers recommend the use of NSM instead. See <a href="https://github.com/linuxaudio/new-session-manager">https://github.com/linuxaudio/new-session-manager</a></dd></dl>
<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>