jackaudio.github.com/api/struct__jack__session__event.html at master · jackaudio/jackaudio.github.com · GitHub

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
<!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: _jack_session_event Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">_jack_session_event Struct Reference<div class="ingroups"><a class="el" href="group__SessionClientFunctions.html">Session API for clients.</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="session_8h_source.html">session.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a1eebbe3f51ef97967c58afb627535dda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__SessionClientFunctions.html#gadaa6c819c4e14eb162b5d3f462866dfc">jack_session_event_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__jack__session__event.html#a1eebbe3f51ef97967c58afb627535dda">type</a></td></tr>
<tr class="separator:a1eebbe3f51ef97967c58afb627535dda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9424115009f29d9d7d2ff6033494a386"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__jack__session__event.html#a9424115009f29d9d7d2ff6033494a386">session_dir</a></td></tr>
<tr class="separator:a9424115009f29d9d7d2ff6033494a386"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9d90a3380e30df4b517e7df2a25465"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__jack__session__event.html#a6d9d90a3380e30df4b517e7df2a25465">client_uuid</a></td></tr>
<tr class="separator:a6d9d90a3380e30df4b517e7df2a25465"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae68736b4fb28f802baf3181bc2a0a617"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__jack__session__event.html#ae68736b4fb28f802baf3181bc2a0a617">command_line</a></td></tr>
<tr class="separator:ae68736b4fb28f802baf3181bc2a0a617"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae25a1730b6afe5268855eb21d0cfe536"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__SessionClientFunctions.html#gaff8d9b1766409d50565aabd2a5b9ab4f">jack_session_flags_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__jack__session__event.html#ae25a1730b6afe5268855eb21d0cfe536">flags</a></td></tr>
<tr class="separator:ae25a1730b6afe5268855eb21d0cfe536"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f1b04a6fdf2e0c0c8e80f2fa053f55c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__jack__session__event.html#a5f1b04a6fdf2e0c0c8e80f2fa053f55c">future</a></td></tr>
<tr class="separator:a5f1b04a6fdf2e0c0c8e80f2fa053f55c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a6d9d90a3380e30df4b517e7df2a25465"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d9d90a3380e30df4b517e7df2a25465">&#9670;&nbsp;</a></span>client_uuid</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* _jack_session_event::client_uuid</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Client UUID which must be passed to jack_client_open on session load.</p>
<p>The client can specify this in the returned command line, or save it in a state file within the session directory. </p>

</div>
</div>
<a id="ae68736b4fb28f802baf3181bc2a0a617"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae68736b4fb28f802baf3181bc2a0a617">&#9670;&nbsp;</a></span>command_line</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* _jack_session_event::command_line</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reply (set by client): the command line needed to restore the client.</p>
<p>This is a platform dependent command line. It must contain ${SESSION_DIR} instead of the actual session directory path. More generally, just as in session files, clients should not include any paths outside the session directory here as this makes archival/distribution impossible.</p>
<p>This field is set to NULL by Jack when the event is delivered to the client. The client must set to allocated memory that is safe to free(). This memory will be freed by jack_session_event_free. </p>

</div>
</div>
<a id="ae25a1730b6afe5268855eb21d0cfe536"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae25a1730b6afe5268855eb21d0cfe536">&#9670;&nbsp;</a></span>flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__SessionClientFunctions.html#gaff8d9b1766409d50565aabd2a5b9ab4f">jack_session_flags_t</a> _jack_session_event::flags</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reply (set by client): Session flags. </p>

</div>
</div>
<a id="a5f1b04a6fdf2e0c0c8e80f2fa053f55c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f1b04a6fdf2e0c0c8e80f2fa053f55c">&#9670;&nbsp;</a></span>future</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t _jack_session_event::future</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Future flags. Set to zero for now. </p>

</div>
</div>
<a id="a9424115009f29d9d7d2ff6033494a386"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9424115009f29d9d7d2ff6033494a386">&#9670;&nbsp;</a></span>session_dir</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* _jack_session_event::session_dir</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Session directory path, with trailing separator.</p>
<p>This directory is exclusive to the client; when saving the client may create any files it likes in this directory. </p>

</div>
</div>
<a id="a1eebbe3f51ef97967c58afb627535dda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eebbe3f51ef97967c58afb627535dda">&#9670;&nbsp;</a></span>type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__SessionClientFunctions.html#gadaa6c819c4e14eb162b5d3f462866dfc">jack_session_event_type_t</a> _jack_session_event::type</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The type of this session event. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="session_8h_source.html">session.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>