|
Jack2
1.9.12
|
Classes | |
| struct | _jack_session_event |
Typedefs | |
| typedef enum JackSessionEventType | jack_session_event_type_t |
| typedef enum JackSessionFlags | jack_session_flags_t |
| typedef struct _jack_session_event | jack_session_event_t |
| typedef void(* | JackSessionCallback) (jack_session_event_t *event, void *arg) |
Enumerations | |
| enum | JackSessionEventType { JackSessionSave = 1, JackSessionSaveAndQuit = 2, JackSessionSaveTemplate = 3, JackSessionSave = 1, JackSessionSaveAndQuit = 2, JackSessionSaveTemplate = 3 } |
| enum | JackSessionFlags { JackSessionSaveError = 0x01, JackSessionNeedTerminal = 0x02, JackSessionSaveError = 0x01, JackSessionNeedTerminal = 0x02 } |
Functions | |
| int | jack_set_session_callback (jack_client_t *client, JackSessionCallback session_callback, void *arg) JACK_WEAK_EXPORT |
| int | jack_session_reply (jack_client_t *client, jack_session_event_t *event) JACK_WEAK_EXPORT |
| void | jack_session_event_free (jack_session_event_t *event) JACK_WEAK_EXPORT |
| char * | jack_client_get_uuid (jack_client_t *client) JACK_WEAK_EXPORT |
| typedef enum JackSessionFlags jack_session_flags_t |
| typedef void(* JackSessionCallback) (jack_session_event_t *event, void *arg) |
Prototype for the client supplied function that is called whenever a session notification is sent via jack_session_notify().
Ownership of the memory of event is passed to the application. It must be freed using jack_session_event_free when its not used anymore.
The client must promptly call jack_session_reply for this event.
| event | The event structure. |
| arg | Pointer to a client supplied structure. |
| enum JackSessionEventType |
Session event type.
If a client cant save templates, i might just do a normal save.
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.
| enum JackSessionFlags |
jack_session_flags_t bits
| Enumerator | |
|---|---|
| JackSessionSaveError | An error occured while saving. |
| JackSessionNeedTerminal | Client needs to be run in a terminal. |
| int jack_set_session_callback | ( | jack_client_t * | client, |
| JackSessionCallback | session_callback, | ||
| void * | arg | ||
| ) |
Tell the JACK server to call session_callback when a session event is to be delivered.
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.
Definition at line 1926 of file JackAPI.cpp.
| int jack_session_reply | ( | jack_client_t * | client, |
| jack_session_event_t * | event | ||
| ) |
Reply to a session event.
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.
Definition at line 1954 of file JackAPI.cpp.
| void jack_session_event_free | ( | jack_session_event_t * | event | ) |
Free memory used by a jack_session_event_t.
This also frees the memory used by the command_line pointer, if its non NULL.
Definition at line 1968 of file JackAPI.cpp.
| char* jack_client_get_uuid | ( | jack_client_t * | client | ) |
Get the assigned uuid for client. Safe to call from callback and all other threads.
The caller is responsible for calling jack_free(3) on any non-NULL returned value.
Definition at line 1983 of file JackAPI.cpp.
1.8.13