control.h File Reference

JACK control API. More...

#include <jack/jslist.h>
#include <jack/systemdeps.h>

Go to the source code of this file.

Classes

union  jackctl_parameter_value
 Type for parameter value. More...

Defines

#define JACK_PARAM_MAX   (JackParamBool + 1)
 Max value that jackctl_param_type_t type can have.
#define JACK_PARAM_STRING_MAX   63
 Max length of string parameter value, excluding terminating nul char.

Typedefs

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

Enumerations

enum  jackctl_param_type_t {
  JackParamInt = 1, JackParamUInt, JackParamChar, JackParamString,
  JackParamBool, JackParamInt = 1, JackParamUInt, JackParamChar,
  JackParamString, JackParamBool
}

Functions

sigset_t jackctl_setup_signals (unsigned int flags)
void jackctl_wait_signals (sigset_t signals)
jackctl_server_tjackctl_server_create ()
void jackctl_server_destroy (jackctl_server_t *server)
const JSList * jackctl_server_get_drivers_list (jackctl_server_t *server)
bool jackctl_server_start (jackctl_server_t *server, jackctl_driver_t *driver)
bool jackctl_server_stop (jackctl_server_t *server)
const JSList * jackctl_server_get_parameters (jackctl_server_t *server)
const char * jackctl_driver_get_name (jackctl_driver_t *driver)
const JSList * jackctl_driver_get_parameters (jackctl_driver_t *driver)
const char * jackctl_parameter_get_name (jackctl_parameter_t *parameter)
const char * jackctl_parameter_get_short_description (jackctl_parameter_t *parameter)
const char * jackctl_parameter_get_long_description (jackctl_parameter_t *parameter)
jackctl_param_type_t jackctl_parameter_get_type (jackctl_parameter_t *parameter)
char jackctl_parameter_get_id (jackctl_parameter_t *parameter)
bool jackctl_parameter_is_set (jackctl_parameter_t *parameter)
bool jackctl_parameter_reset (jackctl_parameter_t *parameter)
union jackctl_parameter_value jackctl_parameter_get_value (jackctl_parameter_t *parameter)
bool jackctl_parameter_set_value (jackctl_parameter_t *parameter, const union jackctl_parameter_value *value_ptr)
union jackctl_parameter_value jackctl_parameter_get_default_value (jackctl_parameter_t *parameter)
bool jackctl_parameter_has_range_constraint (jackctl_parameter_t *parameter_ptr)
bool jackctl_parameter_has_enum_constraint (jackctl_parameter_t *parameter_ptr)
uint32_t jackctl_parameter_get_enum_constraints_count (jackctl_parameter_t *parameter_ptr)
union jackctl_parameter_value jackctl_parameter_get_enum_constraint_value (jackctl_parameter_t *parameter_ptr, uint32_t index)
const char * jackctl_parameter_get_enum_constraint_description (jackctl_parameter_t *parameter_ptr, uint32_t index)
void jackctl_parameter_get_range_constraint (jackctl_parameter_t *parameter_ptr, union jackctl_parameter_value *min_ptr, union jackctl_parameter_value *max_ptr)
bool jackctl_parameter_constraint_is_strict (jackctl_parameter_t *parameter_ptr)
bool jackctl_parameter_constraint_is_fake_value (jackctl_parameter_t *parameter_ptr)
const JSList * jackctl_server_get_internals_list (jackctl_server_t *server)
const char * jackctl_internal_get_name (jackctl_internal_t *internal)
const JSList * jackctl_internal_get_parameters (jackctl_internal_t *internal)
bool jackctl_server_load_internal (jackctl_server_t *server, jackctl_internal_t *internal)
bool jackctl_server_unload_internal (jackctl_server_t *server, jackctl_internal_t *internal)
void jack_error (const char *format,...)
void jack_info (const char *format,...)
void jack_log (const char *format,...)


Detailed Description

JACK control API.

Definition in file control.h.


Typedef Documentation

typedef struct jackctl_server jackctl_server_t

opaque type for server object

Definition at line 63 of file control.h.

typedef struct jackctl_driver jackctl_driver_t

opaque type for driver object

Definition at line 66 of file control.h.

typedef struct jackctl_internal jackctl_internal_t

opaque type for internal client object

Definition at line 69 of file control.h.

typedef struct jackctl_parameter jackctl_parameter_t

opaque type for parameter object

Definition at line 72 of file control.h.


Enumeration Type Documentation

Parameter types, intentionally similar to jack_driver_param_type_t

Enumerator:
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

Definition at line 36 of file control.h.


Function Documentation

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.

Parameters:
flags signals setup flags, use 0 for none. Currently no flags are defined
Returns:
the configurated signal set.

Definition at line 482 of file JackControlAPI.cpp.

void jackctl_wait_signals ( sigset_t  signals  ) 

Call this function to wait on a signal set.

Parameters:
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.

Returns:
server object handle, NULL if creation of server object failed. Successfully created server object must be destroyed with paired call to jackctl_server_destroy

Definition at line 617 of file JackControlAPI.cpp.

void jackctl_server_destroy ( jackctl_server_t server  ) 

Call this function to destroy server object.

Parameters:
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).

Parameters:
server server object handle to get drivers for
Returns:
Single linked list of driver object handles. Must not be modified. Always same for same server object.

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

Parameters:
server server object handle
driver driver to use
Returns:
success status: true - success, false - fail

Definition at line 823 of file JackControlAPI.cpp.

bool jackctl_server_stop ( jackctl_server_t server  ) 

Call this function to stop JACK server

Parameters:
server server object handle
Returns:
success status: true - success, false - fail

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).

Parameters:
server server object handle to get parameters for
Returns:
Single linked list of parameter object handles. Must not be modified. Always same for same server object.

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.

Parameters:
driver driver object handle to get name of
Returns:
driver name. Must not be modified. Always same for same driver object.

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).

Parameters:
driver driver object handle to get parameters for
Returns:
Single linked list of parameter object handles. Must not be modified. Always same for same driver object.

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.

Parameters:
parameter parameter object handle to get name of
Returns:
parameter name. Must not be modified. Always same for same parameter object.

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.

Parameters:
parameter parameter object handle to get short description of
Returns:
parameter short description. Must not be modified. Always same for same parameter object.

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.

Parameters:
parameter parameter object handle to get long description of
Returns:
parameter long description. Must not be modified. Always same for same parameter object.

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.

Parameters:
parameter parameter object handle to get type of
Returns:
parameter type. Always same for same parameter object.

Definition at line 1022 of file JackControlAPI.cpp.

char jackctl_parameter_get_id ( jackctl_parameter_t parameter  ) 

Call this function to get parameter character.

Parameters:
parameter parameter object handle to get character of
Returns:
character.

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.

Parameters:
parameter parameter object handle to check
Returns:
true - parameter is set, false - parameter is using default value.

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.

Parameters:
parameter parameter object handle to reset value of
Returns:
success status: true - success, false - fail

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.

Parameters:
parameter parameter object handle to get value of
Returns:
parameter value.

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.

Parameters:
parameter parameter object handle to get value of
value_ptr pointer to variable containing parameter value
Returns:
success status: true - success, false - fail

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.

Parameters:
parameter parameter object handle to get default value of
Returns:
parameter default value.

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.

Parameters:
parameter object handle of parameter to check
Returns:
whether parameter has range constraint.

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.

Parameters:
parameter object handle of parameter to check
Returns:
whether parameter has enumeration constraint.

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.

Parameters:
parameter object handle of parameter
Returns:
number of enumeration values

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.

Parameters:
parameter object handle of parameter
index index of parameter enumeration value
Returns:
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.

Parameters:
parameter object handle of parameter
index index of parameter enumeration value
Returns:
enumeration value description.

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.

Parameters:
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.

Parameters:
parameter parameter object handle to check
Returns:
whether parameter constraint is strict.

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.

Parameters:
parameter parameter object handle to check
Returns:
whether parameter constraint is strict.

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).

Parameters:
server server object handle to get internal clients for
Returns:
Single linked list of internal client object handles. Must not be modified. Always same for same server object.

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.

Parameters:
internal internal object handle to get name of
Returns:
internal name. Must not be modified. Always same for same internal object.

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).

Parameters:
internal internal object handle to get parameters for
Returns:
Single linked list of parameter object handles. Must not be modified. Always same for same internal object.

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.

Parameters:
server server object handle
internal internal to use
Returns:
success status: true - success, false - fail

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.

Parameters:
server server object handle
internal internal to unload
Returns:
success status: true - success, false - fail

Definition at line 1150 of file JackControlAPI.cpp.

void jack_error ( const char *  format,
  ... 
)

Call this function to log an error message.

Parameters:
format string

Definition at line 93 of file JackError.cpp.

void jack_info ( const char *  format,
  ... 
)

Call this function to log an information message.

Parameters:
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.

Parameters:
format string

Definition at line 109 of file JackError.cpp.


Generated on Tue Dec 2 14:05:22 2008 for Jackdmp by  doxygen 1.5.7.1