<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>Jack2: 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="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 style="padding-left: 0.5em;">
<div id="projectname">Jack2
 <span id="projectnumber">1.9.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<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><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</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><a name="nested-classes"></a>
Classes</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>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gadaa6c819c4e14eb162b5d3f462866dfc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadaa6c819c4e14eb162b5d3f462866dfc"></a>
typedef enum <a class="el" href="group__SessionClientFunctions.html#ga5616b829095cc341cee4610aba992a4d">JackSessionEventType</a> </td><td class="memItemRight" valign="bottom"><b>jack_session_event_type_t</b></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="memitem:gafbf49270fbcf5cfce2abd26d7ee212b9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafbf49270fbcf5cfce2abd26d7ee212b9"></a>
typedef struct <a class="el" href="struct__jack__session__event.html">_jack_session_event</a> </td><td class="memItemRight" valign="bottom"><b>jack_session_event_t</b></td></tr>
<tr class="memitem:ga6ce2344eea46f640d8c78c0af1f1edbc"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#ga6ce2344eea46f640d8c78c0af1f1edbc">JackSessionCallback</a> )(<a class="el" href="struct__jack__session__event.html">jack_session_event_t</a> *event, void *arg)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><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="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>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga00a3018cfeb064c94362e913934e6936"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#ga00a3018cfeb064c94362e913934e6936">jack_set_session_callback</a> (jack_client_t *client, <a class="el" href="group__SessionClientFunctions.html#ga6ce2344eea46f640d8c78c0af1f1edbc">JackSessionCallback</a> session_callback, void *arg) JACK_WEAK_EXPORT</td></tr>
<tr class="memitem:gabd998f61f7f36a140fca41384c579e3d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#gabd998f61f7f36a140fca41384c579e3d">jack_session_reply</a> (jack_client_t *client, <a class="el" href="struct__jack__session__event.html">jack_session_event_t</a> *event) JACK_WEAK_EXPORT</td></tr>
<tr class="memitem:gac334b89bf983744f8c7ae4006d18fb58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__SessionClientFunctions.html#gac334b89bf983744f8c7ae4006d18fb58">jack_session_event_free</a> (<a class="el" href="struct__jack__session__event.html">jack_session_event_t</a> *event) JACK_WEAK_EXPORT</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> (jack_client_t *client) JACK_WEAK_EXPORT</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gaff8d9b1766409d50565aabd2a5b9ab4f"></a>
<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>
<p>Definition at line <a class="el" href="session_8h_source.html#l00098">98</a> of file <a class="el" href="session_8h_source.html">session.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga6ce2344eea46f640d8c78c0af1f1edbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* JackSessionCallback)(<a class="el" href="struct__jack__session__event.html">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="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>
<p>Definition at line <a class="el" href="session_8h_source.html#l00162">162</a> of file <a class="el" href="session_8h_source.html">session.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga5616b829095cc341cee4610aba992a4d"></a>
<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 cant 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>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga5616b829095cc341cee4610aba992a4da01d1ac5a741784533361414c7c7cdbfc"></a>JackSessionSave</em> </td><td>
<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 valign="top"><em><a class="anchor" id="gga5616b829095cc341cee4610aba992a4da67c5f9e521e4448ba3d4b5f24e91e129"></a>JackSessionSaveAndQuit</em> </td><td>
<p>Save the session completly, then quit.</p>
<p>The rules for saving are exactly the same as for JackSessionSave. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga5616b829095cc341cee4610aba992a4da8137dfcdaf5969bf1032117157d4015f"></a>JackSessionSaveTemplate</em> </td><td>
<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>
</dd>
</dl>
<p>Definition at line <a class="el" href="session_8h_source.html#l00046">46</a> of file <a class="el" href="session_8h_source.html">session.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga596a05b8e9be60e04ee3f8d434c5d8f8"></a>
<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>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga596a05b8e9be60e04ee3f8d434c5d8f8aa7888ab24ad3a832b7314a366f543bbd"></a>JackSessionSaveError</em> </td><td>
<p>An error occured while saving. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga596a05b8e9be60e04ee3f8d434c5d8f8a5364c2667fc5fa44cf84dfde4786d775"></a>JackSessionNeedTerminal</em> </td><td>
<p>Client needs to be run in a terminal. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="session_8h_source.html#l00083">83</a> of file <a class="el" href="session_8h_source.html">session.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga00a3018cfeb064c94362e913934e6936"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_set_session_callback </td>
<td>(</td>
<td class="paramtype">jack_client_t * </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#ga6ce2344eea46f640d8c78c0af1f1edbc">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="section return"><dt>Returns:</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a class="anchor" id="gabd998f61f7f36a140fca41384c579e3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_session_reply </td>
<td>(</td>
<td class="paramtype">jack_client_t * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct__jack__session__event.html">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="section return"><dt>Returns:</dt><dd>0 on success, otherwise a non-zero error code </dd></dl>
</div>
</div>
<a class="anchor" id="gac334b89bf983744f8c7ae4006d18fb58"></a>
<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="struct__jack__session__event.html">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>
</div>
</div>
<a class="anchor" id="gac45ae7c26843f51d27be729b902c7dbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* jack_client_get_uuid </td>
<td>(</td>
<td class="paramtype">jack_client_t * </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>
</div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>
Generated for Jack2 by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.8.1.1</small></address>
</body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
136c306a350f6a4bd3abd3af7df09a32
>
files
>
73
