Jack2  1.9.9
session.h
1 /*
2  Copyright (C) 2001 Paul Davis
3  Copyright (C) 2004 Jack O'Quin
4  Copyright (C) 2010 Torben Hohn
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation; either version 2.1 of the License, or
9  (at your option) any later version.
10 
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with this program; if not, write to the Free Software
18  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20 
21 #ifndef __jack_session_h__
22 #define __jack_session_h__
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 #include <jack/types.h>
29 #include <jack/weakmacros.h>
30 
46 enum JackSessionEventType {
58 
65 
76 };
77 
78 typedef enum JackSessionEventType jack_session_event_type_t;
79 
83 enum JackSessionFlags {
88 
93 };
94 
98 typedef enum JackSessionFlags jack_session_flags_t;
99 
100 struct _jack_session_event {
104  jack_session_event_type_t type;
105 
112  const char *session_dir;
113 
120  const char *client_uuid;
121 
135  char *command_line;
136 
140  jack_session_flags_t flags;
141 
145  uint32_t future;
146 };
147 
149 
163  void *arg);
164 
175 int jack_set_session_callback (jack_client_t *client,
176  JackSessionCallback session_callback,
177  void *arg) JACK_WEAK_EXPORT;
178 
188 int jack_session_reply (jack_client_t *client,
189  jack_session_event_t *event) JACK_WEAK_EXPORT;
190 
191 
197 void jack_session_event_free (jack_session_event_t *event) JACK_WEAK_EXPORT;
198 
199 
207 char *jack_client_get_uuid (jack_client_t *client) JACK_WEAK_EXPORT;
208 
219 typedef struct {
220  const char *uuid;
221  const char *client_name;
222  const char *command;
223  jack_session_flags_t flags;
225 
234  jack_client_t* client,
235  const char *target,
236  jack_session_event_type_t type,
237  const char *path) JACK_WEAK_EXPORT;
238 
242 void jack_session_commands_free (jack_session_command_t *cmds) JACK_WEAK_EXPORT;
243 
252 char *jack_get_uuid_for_client_name (jack_client_t *client,
253  const char *client_name) JACK_WEAK_EXPORT;
254 
264 char *jack_get_client_name_by_uuid (jack_client_t *client,
265  const char *client_uuid ) JACK_WEAK_EXPORT;
266 
276 int
277 jack_reserve_client_name (jack_client_t *client,
278  const char *name,
279  const char *uuid) JACK_WEAK_EXPORT;
280 
287 int
288 jack_client_has_session_callback (jack_client_t *client, const char *client_name) JACK_WEAK_EXPORT;
289 
290 #ifdef __cplusplus
291 }
292 #endif
293 #endif
LIB_EXPORT int jack_set_session_callback(jack_client_t *ext_client, JackSessionCallback session_callback, void *arg)
Definition: JackAPI.cpp:1881
const char * client_uuid
Definition: JackSession.h:48
jack_session_flags_t flags
Definition: JackSession.h:50
const char * session_dir
Definition: JackSession.h:47
LIB_EXPORT char * jack_client_get_uuid(jack_client_t *client)
Definition: JackAPI.cpp:1938
LIB_EXPORT char * jack_get_uuid_for_client_name(jack_client_t *ext_client, const char *client_name)
Definition: JackAPI.cpp:1953
LIB_EXPORT int jack_client_has_session_callback(jack_client_t *client, const char *client_name)
Definition: JackAPI.cpp:2024
LIB_EXPORT void jack_session_commands_free(jack_session_command_t *cmds)
Definition: JackAPI.cpp:1995
LIB_EXPORT jack_session_command_t * jack_session_notify(jack_client_t *ext_client, const char *target, jack_session_event_type_t ev_type, const char *path)
Definition: JackAPI.cpp:1895
LIB_EXPORT int jack_reserve_client_name(jack_client_t *ext_client, const char *name, const char *uuid)
Definition: JackAPI.cpp:1981
enum JackSessionFlags jack_session_flags_t
Definition: session.h:98
jack_session_event_type_t type
Definition: JackSession.h:46
LIB_EXPORT int jack_session_reply(jack_client_t *ext_client, jack_session_event_t *event)
Definition: JackAPI.cpp:1909
LIB_EXPORT char * jack_get_client_name_by_uuid(jack_client_t *ext_client, const char *client_uuid)
Definition: JackAPI.cpp:1967
void(* JackSessionCallback)(jack_session_event_t *event, void *arg)
Definition: session.h:162
LIB_EXPORT void jack_session_event_free(jack_session_event_t *ev)
Definition: JackAPI.cpp:1923