#include <jack/jslist.h>
#include <jack/systemdeps.h>
Go to the source code of this file.
Definition in file control.h.
typedef struct jackctl_server jackctl_server_t |
typedef struct jackctl_driver jackctl_driver_t |
typedef struct jackctl_internal jackctl_internal_t |
typedef struct jackctl_parameter jackctl_parameter_t |
enum jackctl_param_type_t |
Parameter types, intentionally similar to jack_driver_param_type_t
JackParamInt | value type is a signed integer |
JackParamUInt | value type is an unsigned integer |
JackParamChar | value type is a char |
JackParamString | value type is a string with max size of JACK_PARAM_STRING_MAX+1 chars |
JackParamBool | value type is a boolean |
sigset_t jackctl_setup_signals | ( | unsigned int | flags | ) |
Call this function to setup process signal handling. As a general rule, it is required for proper operation for the server object.
flags | signals setup flags, use 0 for none. Currently no flags are defined |
Definition at line 482 of file JackControlAPI.cpp.
void jackctl_wait_signals | ( | sigset_t | signals | ) |
Call this function to wait on a signal set.
signals | signals set to wait on |
Definition at line 560 of file JackControlAPI.cpp.
jackctl_server_t* jackctl_server_create | ( | ) |
Call this function to create server object.
Definition at line 617 of file JackControlAPI.cpp.
void jackctl_server_destroy | ( | jackctl_server_t * | server | ) |
Call this function to destroy server object.
server | server object handle to destroy |
Definition at line 780 of file JackControlAPI.cpp.
const JSList* jackctl_server_get_drivers_list | ( | jackctl_server_t * | server | ) |
Call this function to get list of available drivers. List node data pointers is a driver object handle (jackctl_driver_t).
server | server object handle to get drivers for |
Definition at line 788 of file JackControlAPI.cpp.
bool jackctl_server_start | ( | jackctl_server_t * | server, | |
jackctl_driver_t * | driver | |||
) |
Call this function to start JACK server
server | server object handle | |
driver | driver to use |
Definition at line 823 of file JackControlAPI.cpp.
bool jackctl_server_stop | ( | jackctl_server_t * | server | ) |
Call this function to stop JACK server
server | server object handle |
Definition at line 793 of file JackControlAPI.cpp.
const JSList* jackctl_server_get_parameters | ( | jackctl_server_t * | server | ) |
Call this function to get list of server parameters. List node data pointers is a parameter object handle (jackctl_parameter_t).
server | server object handle to get parameters for |
Definition at line 817 of file JackControlAPI.cpp.
const char* jackctl_driver_get_name | ( | jackctl_driver_t * | driver | ) |
Call this function to get name of driver.
driver | driver object handle to get name of |
Definition at line 910 of file JackControlAPI.cpp.
const JSList* jackctl_driver_get_parameters | ( | jackctl_driver_t * | driver | ) |
Call this function to get list of driver parameters. List node data pointers is a parameter object handle (jackctl_parameter_t).
driver | driver object handle to get parameters for |
Definition at line 915 of file JackControlAPI.cpp.
const char* jackctl_parameter_get_name | ( | jackctl_parameter_t * | parameter | ) |
Call this function to get parameter name.
parameter | parameter object handle to get name of |
Definition at line 925 of file JackControlAPI.cpp.
const char* jackctl_parameter_get_short_description | ( | jackctl_parameter_t * | parameter | ) |
Call this function to get parameter short description.
parameter | parameter object handle to get short description of |
Definition at line 930 of file JackControlAPI.cpp.
const char* jackctl_parameter_get_long_description | ( | jackctl_parameter_t * | parameter | ) |
Call this function to get parameter long description.
parameter | parameter object handle to get long description of |
Definition at line 935 of file JackControlAPI.cpp.
jackctl_param_type_t jackctl_parameter_get_type | ( | jackctl_parameter_t * | parameter | ) |
Call this function to get parameter type.
parameter | parameter object handle to get type of |
Definition at line 1022 of file JackControlAPI.cpp.
char jackctl_parameter_get_id | ( | jackctl_parameter_t * | parameter | ) |
Call this function to get parameter character.
parameter | parameter object handle to get character of |
Definition at line 1027 of file JackControlAPI.cpp.
bool jackctl_parameter_is_set | ( | jackctl_parameter_t * | parameter | ) |
Call this function to check whether parameter has been set, or its default value is being used.
parameter | parameter object handle to check |
Definition at line 1032 of file JackControlAPI.cpp.
bool jackctl_parameter_reset | ( | jackctl_parameter_t * | parameter | ) |
Call this function to reset parameter to its default value.
parameter | parameter object handle to reset value of |
Definition at line 1042 of file JackControlAPI.cpp.
union jackctl_parameter_value jackctl_parameter_get_value | ( | jackctl_parameter_t * | parameter | ) | [write] |
Call this function to get parameter value.
parameter | parameter object handle to get value of |
Definition at line 1037 of file JackControlAPI.cpp.
bool jackctl_parameter_set_value | ( | jackctl_parameter_t * | parameter, | |
const union jackctl_parameter_value * | value_ptr | |||
) |
Call this function to set parameter value.
parameter | parameter object handle to get value of | |
value_ptr | pointer to variable containing parameter value |
Definition at line 1056 of file JackControlAPI.cpp.
union jackctl_parameter_value jackctl_parameter_get_default_value | ( | jackctl_parameter_t * | parameter | ) | [write] |
Call this function to get parameter default value.
parameter | parameter object handle to get default value of |
Definition at line 1115 of file JackControlAPI.cpp.
bool jackctl_parameter_has_range_constraint | ( | jackctl_parameter_t * | parameter_ptr | ) |
Call this function check whether parameter has range constraint.
parameter | object handle of parameter to check |
Definition at line 940 of file JackControlAPI.cpp.
bool jackctl_parameter_has_enum_constraint | ( | jackctl_parameter_t * | parameter_ptr | ) |
Call this function check whether parameter has enumeration constraint.
parameter | object handle of parameter to check |
Definition at line 945 of file JackControlAPI.cpp.
uint32_t jackctl_parameter_get_enum_constraints_count | ( | jackctl_parameter_t * | parameter_ptr | ) |
Call this function get how many enumeration values parameter has.
parameter | object handle of parameter |
Definition at line 950 of file JackControlAPI.cpp.
union jackctl_parameter_value jackctl_parameter_get_enum_constraint_value | ( | jackctl_parameter_t * | parameter_ptr, | |
uint32_t | index | |||
) | [write] |
Call this function to get parameter enumeration value.
parameter | object handle of parameter | |
index | index of parameter enumeration value |
Definition at line 960 of file JackControlAPI.cpp.
const char* jackctl_parameter_get_enum_constraint_description | ( | jackctl_parameter_t * | parameter_ptr, | |
uint32_t | index | |||
) |
Call this function to get parameter enumeration value description.
parameter | object handle of parameter | |
index | index of parameter enumeration value |
Definition at line 989 of file JackControlAPI.cpp.
void jackctl_parameter_get_range_constraint | ( | jackctl_parameter_t * | parameter_ptr, | |
union jackctl_parameter_value * | min_ptr, | |||
union jackctl_parameter_value * | max_ptr | |||
) |
Call this function to get parameter range.
parameter | object handle of parameter | |
min_ptr | pointer to variable receiving parameter minimum value | |
max_ptr | pointer to variable receiving parameter maximum value |
Definition at line 994 of file JackControlAPI.cpp.
bool jackctl_parameter_constraint_is_strict | ( | jackctl_parameter_t * | parameter_ptr | ) |
Call this function to check whether parameter constraint is strict, i.e. whether supplying non-matching value will not work for sure.
parameter | parameter object handle to check |
Definition at line 1012 of file JackControlAPI.cpp.
bool jackctl_parameter_constraint_is_fake_value | ( | jackctl_parameter_t * | parameter_ptr | ) |
Call this function to check whether parameter has fake values, i.e. values have no user meaningful meaning and only value description is meaningful to user.
parameter | parameter object handle to check |
Definition at line 1017 of file JackControlAPI.cpp.
const JSList* jackctl_server_get_internals_list | ( | jackctl_server_t * | server | ) |
Call this function to get list of available internal clients. List node data pointers is a internal client object handle (jackctl_internal_t).
server | server object handle to get internal clients for |
Definition at line 1122 of file JackControlAPI.cpp.
const char* jackctl_internal_get_name | ( | jackctl_internal_t * | internal | ) |
Call this function to get name of internal client.
internal | internal object handle to get name of |
Definition at line 1127 of file JackControlAPI.cpp.
const JSList* jackctl_internal_get_parameters | ( | jackctl_internal_t * | internal | ) |
Call this function to get list of internal parameters. List node data pointers is a parameter object handle (jackctl_parameter_t).
internal | internal object handle to get parameters for |
Definition at line 1132 of file JackControlAPI.cpp.
bool jackctl_server_load_internal | ( | jackctl_server_t * | server, | |
jackctl_internal_t * | internal | |||
) |
Call this function to load one internal client.
server | server object handle | |
internal | internal to use |
Definition at line 1137 of file JackControlAPI.cpp.
bool jackctl_server_unload_internal | ( | jackctl_server_t * | server, | |
jackctl_internal_t * | internal | |||
) |
Call this function to unload one internal client.
server | server object handle | |
internal | internal to unload |
Definition at line 1150 of file JackControlAPI.cpp.
void jack_error | ( | const char * | format, | |
... | ||||
) |
Call this function to log an error message.
format | string |
Definition at line 93 of file JackError.cpp.
void jack_info | ( | const char * | format, | |
... | ||||
) |
Call this function to log an information message.
format | string |
Definition at line 101 of file JackError.cpp.
void jack_log | ( | const char * | format, | |
... | ||||
) |
Call this function to log an information message but only when verbose mode is enabled.
format | string |
Definition at line 109 of file JackError.cpp.