jack.c.control

@file jack/control.h @ingroup publicheader @brief JACK control API

Public Imports

jack.c.systemdeps
public import jack.c.systemdeps;
Undocumented in source.
jack.c.jslist
public import jack.c.jslist;
Undocumented in source.

Members

Enums

jackctl_driver_type_t
enum jackctl_driver_type_t

Driver types

jackctl_param_type_t
enum jackctl_param_type_t

Parameter types, intentionally similar to jack_driver_param_type_t

Functions

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

Call this function to log an error message.

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

Call this function to log an information message.

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

Call this function to log an information message but only when verbose mode is enabled.

jackctl_driver_get_name
const(char)* jackctl_driver_get_name(jackctl_driver_t* driver)

Call this function to get name of driver.

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

jackctl_driver_get_type
jackctl_driver_type_t jackctl_driver_get_type(jackctl_driver_t* driver)

Call this function to get type of driver.

jackctl_driver_params_parse
int jackctl_driver_params_parse(jackctl_driver_t* driver, int argc, char*[] argv)

Call this function to parse parameters for a driver.

jackctl_internal_get_name
const(char)* jackctl_internal_get_name(jackctl_internal_t* internal)

Call this function to get name of internal client.

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

jackctl_parameter_constraint_is_fake_value
bool jackctl_parameter_constraint_is_fake_value(jackctl_parameter_t* parameter)

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.

jackctl_parameter_constraint_is_strict
bool jackctl_parameter_constraint_is_strict(jackctl_parameter_t* parameter)

Call this function to check whether parameter constraint is strict, i.e. whether supplying non-matching value will not work for sure.

jackctl_parameter_get_default_value
jackctl_parameter_value jackctl_parameter_get_default_value(jackctl_parameter_t* parameter)

Call this function to get parameter default value.

jackctl_parameter_get_enum_constraint_description
const(char)* jackctl_parameter_get_enum_constraint_description(jackctl_parameter_t* parameter, uint32_t index)

Call this function to get parameter enumeration value description.

jackctl_parameter_get_enum_constraint_value
jackctl_parameter_value jackctl_parameter_get_enum_constraint_value(jackctl_parameter_t* parameter, uint32_t index)

Call this function to get parameter enumeration value.

jackctl_parameter_get_enum_constraints_count
uint32_t jackctl_parameter_get_enum_constraints_count(jackctl_parameter_t* parameter)

Call this function get how many enumeration values parameter has.

jackctl_parameter_get_id
char jackctl_parameter_get_id(jackctl_parameter_t* parameter)

Call this function to get parameter character.

jackctl_parameter_get_long_description
const(char)* jackctl_parameter_get_long_description(jackctl_parameter_t* parameter)

Call this function to get parameter long description.

jackctl_parameter_get_name
const(char)* jackctl_parameter_get_name(jackctl_parameter_t* parameter)

Call this function to get parameter name.

jackctl_parameter_get_range_constraint
void jackctl_parameter_get_range_constraint(jackctl_parameter_t* parameter, jackctl_parameter_value* min_ptr, jackctl_parameter_value* max_ptr)

Call this function to get parameter range.

jackctl_parameter_get_short_description
const(char)* jackctl_parameter_get_short_description(jackctl_parameter_t* parameter)

Call this function to get parameter short description.

jackctl_parameter_get_type
jackctl_param_type_t jackctl_parameter_get_type(jackctl_parameter_t* parameter)

Call this function to get parameter type.

jackctl_parameter_get_value
jackctl_parameter_value jackctl_parameter_get_value(jackctl_parameter_t* parameter)

Call this function to get parameter value.

jackctl_parameter_has_enum_constraint
bool jackctl_parameter_has_enum_constraint(jackctl_parameter_t* parameter)

Call this function check whether parameter has enumeration constraint.

jackctl_parameter_has_range_constraint
bool jackctl_parameter_has_range_constraint(jackctl_parameter_t* parameter)

Call this function check whether parameter has range constraint.

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

jackctl_parameter_reset
bool jackctl_parameter_reset(jackctl_parameter_t* parameter)

Call this function to reset parameter to its default value.

jackctl_parameter_set_value
bool jackctl_parameter_set_value(jackctl_parameter_t* parameter, const(jackctl_parameter_value)* value_ptr)

Call this function to set parameter value.

jackctl_server_add_slave
bool jackctl_server_add_slave(jackctl_server_t* server, jackctl_driver_t* driver)

Call this function to add a slave in the driver slave list. (cannot be used when the server is running that is between jackctl_server_start and jackctl_server_stop)

jackctl_server_close
bool jackctl_server_close(jackctl_server_t* server)

Call this function to close JACK server

jackctl_server_create
jackctl_server_t* jackctl_server_create(bool function(const(char)* device_name) on_device_acquire, void function(const(char)* device_name) on_device_release)

Call this function to create server object.

jackctl_server_destroy
void jackctl_server_destroy(jackctl_server_t* server)

Call this function to destroy server object.

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

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

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

jackctl_server_load_internal
bool jackctl_server_load_internal(jackctl_server_t* server, jackctl_internal_t* internal)

Call this function to load one internal client. (can be used when the server is running)

jackctl_server_open
bool jackctl_server_open(jackctl_server_t* server, jackctl_driver_t* driver)

Call this function to open JACK server

jackctl_server_remove_slave
bool jackctl_server_remove_slave(jackctl_server_t* server, jackctl_driver_t* driver)

Call this function to remove a slave from the driver slave list. (cannot be used when the server is running that is between jackctl_server_start and jackctl_server_stop)

jackctl_server_start
bool jackctl_server_start(jackctl_server_t* server)

Call this function to start JACK server

jackctl_server_stop
bool jackctl_server_stop(jackctl_server_t* server)

Call this function to stop JACK server

jackctl_server_switch_master
bool jackctl_server_switch_master(jackctl_server_t* server, jackctl_driver_t* driver)

Call this function to switch master driver.

jackctl_server_unload_internal
bool jackctl_server_unload_internal(jackctl_server_t* server, jackctl_internal_t* internal)

Call this function to unload one internal client. (can be used when the server is running)

jackctl_setup_signals
jackctl_sigmask_t* jackctl_setup_signals(uint flags)

Call this function to setup process signal handling. As a general rule, it is required for proper operation for the server object.

jackctl_wait_signals
void jackctl_wait_signals(jackctl_sigmask_t* signals)

Call this function to wait on a signal set.

Manifest constants

JACK_PARAM_MAX
enum JACK_PARAM_MAX;

@brief Max value that jackctl_param_type_t type can have

JACK_PARAM_STRING_MAX
enum JACK_PARAM_STRING_MAX;

@brief Max length of string parameter value, excluding terminating null char

Structs

jackctl_driver_t
struct jackctl_driver_t

opaque type for driver object

jackctl_internal_t
struct jackctl_internal_t

opaque type for internal client object

jackctl_parameter_t
struct jackctl_parameter_t

opaque type for parameter object

jackctl_server_t
struct jackctl_server_t

opaque type for server object

jackctl_sigmask_t
struct jackctl_sigmask_t

opaque type for sigmask object

Unions

jackctl_parameter_value
union jackctl_parameter_value

@brief Type for parameter value

Meta