<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Jack2: The API for starting and controlling a JACK server</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Jack2
 <span id="projectnumber">1.9.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">The API for starting and controlling a JACK server</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga428c1a82215cf214573a6d0f46dad661"><td class="memItemLeft" align="right" valign="top"><a class="el" href="control_8h.html#aba06c83231cec2627ce1cfebd0c3dbd3">jackctl_sigmask_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga428c1a82215cf214573a6d0f46dad661">jackctl_setup_signals</a> (unsigned int flags)</td></tr>
<tr class="memitem:ga2d6df048067ab60b1265270405826f07"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga2d6df048067ab60b1265270405826f07">jackctl_wait_signals</a> (<a class="el" href="control_8h.html#aba06c83231cec2627ce1cfebd0c3dbd3">jackctl_sigmask_t</a> *signals)</td></tr>
<tr class="memitem:ga8b8c36f1be47c0d582e36ee2ea21e7bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga8b8c36f1be47c0d582e36ee2ea21e7bb">jackctl_server_create</a> (bool(*on_device_acquire)(const char *device_name), void(*on_device_release)(const char *device_name))</td></tr>
<tr class="memitem:gab6f848f11e9853f49d82f253c1df1121"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gab6f848f11e9853f49d82f253c1df1121">jackctl_server_destroy</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server)</td></tr>
<tr class="memitem:gad2b438d61acdadc96368ff2dd4e9e62f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gad2b438d61acdadc96368ff2dd4e9e62f">jackctl_server_open</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server, <a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> *driver)</td></tr>
<tr class="memitem:gaa573e4c5e35e853d199cf5b7368700b5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gaa573e4c5e35e853d199cf5b7368700b5">jackctl_server_start</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server)</td></tr>
<tr class="memitem:gaf71c3fbc808e15305277e667ca6cfac4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gaf71c3fbc808e15305277e667ca6cfac4">jackctl_server_stop</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server)</td></tr>
<tr class="memitem:gab09dea0a3ffc38e439cbceaa33951a2c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gab09dea0a3ffc38e439cbceaa33951a2c">jackctl_server_close</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server)</td></tr>
<tr class="memitem:ga3edd82a413260dc1f4de2862f0a6a669"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct__JSList.html">JSList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga3edd82a413260dc1f4de2862f0a6a669">jackctl_server_get_drivers_list</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server)</td></tr>
<tr class="memitem:gaeaefa3144a6a9d843467d4951ca71f70"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct__JSList.html">JSList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gaeaefa3144a6a9d843467d4951ca71f70">jackctl_server_get_parameters</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server)</td></tr>
<tr class="memitem:gacf1e2a650fec3f019bb36e49ffacde4f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct__JSList.html">JSList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gacf1e2a650fec3f019bb36e49ffacde4f">jackctl_server_get_internals_list</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server)</td></tr>
<tr class="memitem:ga338effc099ff0cf03648971df51f9086"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga338effc099ff0cf03648971df51f9086">jackctl_server_load_internal</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server, <a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a> *internal)</td></tr>
<tr class="memitem:gac0d0b9b2c5323da9193db9a0aa84bdf9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gac0d0b9b2c5323da9193db9a0aa84bdf9">jackctl_server_unload_internal</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server, <a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a> *internal)</td></tr>
<tr class="memitem:gadacbb19d2f9e614ce33c8aedaa04fda1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gadacbb19d2f9e614ce33c8aedaa04fda1">jackctl_server_add_slave</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server, <a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> *driver)</td></tr>
<tr class="memitem:gac71a7c5d85e891a51a57f2575aea627c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gac71a7c5d85e891a51a57f2575aea627c">jackctl_server_remove_slave</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server, <a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> *driver)</td></tr>
<tr class="memitem:ga3bfe5d4befb9d9bab8f05e13d37ca7b3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga3bfe5d4befb9d9bab8f05e13d37ca7b3">jackctl_server_switch_master</a> (<a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> *server, <a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> *driver)</td></tr>
<tr class="memitem:ga9e28945c015f343e7a82c4e76e9cb1b4"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga9e28945c015f343e7a82c4e76e9cb1b4">jackctl_driver_get_name</a> (<a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> *driver)</td></tr>
<tr class="memitem:ga72cc3f0d732b920a75b6279c76187343"><td class="memItemLeft" align="right" valign="top"><a class="el" href="control_8h.html#a3a160c9609a226c2f769fe27f59ca642">jackctl_driver_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga72cc3f0d732b920a75b6279c76187343">jackctl_driver_get_type</a> (<a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> *driver)</td></tr>
<tr class="memitem:ga0f73cfb0c40a401ca6aa617073303e72"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct__JSList.html">JSList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga0f73cfb0c40a401ca6aa617073303e72">jackctl_driver_get_parameters</a> (<a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> *driver)</td></tr>
<tr class="memitem:ga1d9e5244a6cba6e305279b54416ee385"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga1d9e5244a6cba6e305279b54416ee385">jackctl_driver_params_parse</a> (<a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> *driver, int argc, char *argv[])</td></tr>
<tr class="memitem:ga4d14a6526174de9d085b203a7b7d632a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga4d14a6526174de9d085b203a7b7d632a">jackctl_internal_get_name</a> (<a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a> *internal)</td></tr>
<tr class="memitem:gade591618ee972b92724be7ee87a3943a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct__JSList.html">JSList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gade591618ee972b92724be7ee87a3943a">jackctl_internal_get_parameters</a> (<a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a> *internal)</td></tr>
<tr class="memitem:ga3a123ee66e7605b1f17db88d4f5b8ac8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga3a123ee66e7605b1f17db88d4f5b8ac8">jackctl_parameter_get_name</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:gaac9fe5577753455308a53f5569fe3106"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gaac9fe5577753455308a53f5569fe3106">jackctl_parameter_get_short_description</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:ga97aae5c29e16539b71bc7dc2bddafc4b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga97aae5c29e16539b71bc7dc2bddafc4b">jackctl_parameter_get_long_description</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:ga37fe25ce3d3fdbc631a12cab91c460bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="control_8h.html#ac71832cf5445a694a178d15345d67840">jackctl_param_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga37fe25ce3d3fdbc631a12cab91c460bb">jackctl_parameter_get_type</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:ga864ee9036a98736910f264b1a62f0fe9"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga864ee9036a98736910f264b1a62f0fe9">jackctl_parameter_get_id</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:ga439234cd9c8cb1ff35a8bffef526f04b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga439234cd9c8cb1ff35a8bffef526f04b">jackctl_parameter_is_set</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:gac75904b4d63158841b6f4667a7928788"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gac75904b4d63158841b6f4667a7928788">jackctl_parameter_reset</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:ga9881e66c9c235484e5b8879ce27bc9f2"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga9881e66c9c235484e5b8879ce27bc9f2">jackctl_parameter_get_value</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:gab769622731339e7d35e3b7093db347e6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gab769622731339e7d35e3b7093db347e6">jackctl_parameter_set_value</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter, const union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> *value_ptr)</td></tr>
<tr class="memitem:gaa71bfc637794e50ccd5c39d0449b982a"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gaa71bfc637794e50ccd5c39d0449b982a">jackctl_parameter_get_default_value</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:gae7228c1726b5ecaae6458134bf4ab4d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gae7228c1726b5ecaae6458134bf4ab4d7">jackctl_parameter_has_range_constraint</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:ga823ae164d023267b57002226444fe708"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga823ae164d023267b57002226444fe708">jackctl_parameter_has_enum_constraint</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:ga1578b61842cf7a7cfb0d8fe54cf286ff"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga1578b61842cf7a7cfb0d8fe54cf286ff">jackctl_parameter_get_enum_constraints_count</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:ga12fbe98c92f84dcfbd2de23421181567"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga12fbe98c92f84dcfbd2de23421181567">jackctl_parameter_get_enum_constraint_value</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter, uint32_t index)</td></tr>
<tr class="memitem:gadbaa1566bcd829aa4233aac9234125ed"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gadbaa1566bcd829aa4233aac9234125ed">jackctl_parameter_get_enum_constraint_description</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter, uint32_t index)</td></tr>
<tr class="memitem:ga132d53b3fe319e84baf5a2381bd50fc6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga132d53b3fe319e84baf5a2381bd50fc6">jackctl_parameter_get_range_constraint</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter, union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> *min_ptr, union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> *max_ptr)</td></tr>
<tr class="memitem:gac1d74fdcc7125293b7c2d329c0b09e9a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gac1d74fdcc7125293b7c2d329c0b09e9a">jackctl_parameter_constraint_is_strict</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:gafd1b5bc48305a978135692997abc8996"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gafd1b5bc48305a978135692997abc8996">jackctl_parameter_constraint_is_fake_value</a> (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> *parameter)</td></tr>
<tr class="memitem:gac6448626e0b75fc6d9da1ccbdca0355e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#gac6448626e0b75fc6d9da1ccbdca0355e">jack_error</a> (const char *format,...)</td></tr>
<tr class="memitem:ga21328fd378306e0da7270952196eb717"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga21328fd378306e0da7270952196eb717">jack_info</a> (const char *format,...)</td></tr>
<tr class="memitem:ga35f69faaee3bb9b958ed8c9a5f62246c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ControlAPI.html#ga35f69faaee3bb9b958ed8c9a5f62246c">jack_log</a> (const char *format,...)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<h2>Function Documentation</h2>
<a class="anchor" id="ga428c1a82215cf214573a6d0f46dad661"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="control_8h.html#aba06c83231cec2627ce1cfebd0c3dbd3">jackctl_sigmask_t</a>* jackctl_setup_signals </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to setup process signal handling. As a general rule, it is required for proper operation for the server object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>signals setup flags, use 0 for none. Currently no flags are defined</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the configurated signal set. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2d6df048067ab60b1265270405826f07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jackctl_wait_signals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#aba06c83231cec2627ce1cfebd0c3dbd3">jackctl_sigmask_t</a> * </td>
<td class="paramname"><em>signals</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to wait on a signal set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signals</td><td>signals set to wait on </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8b8c36f1be47c0d582e36ee2ea21e7bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a>* jackctl_server_create </td>
<td>(</td>
<td class="paramtype">bool(*)(const char *device_name) </td>
<td class="paramname"><em>on_device_acquire</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(const char *device_name) </td>
<td class="paramname"><em>on_device_release</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to create server object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">on_device_acquire</td><td>- Optional callback to be called before device is acquired. If false is returned, device usage will fail </td></tr>
<tr><td class="paramname">on_device_release</td><td>- Optional callback to be called after device is released.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>server object handle, NULL if creation of server object failed. Successfully created server object must be destroyed with paired call to <a class="el" href="group__ControlAPI.html#gab6f848f11e9853f49d82f253c1df1121">jackctl_server_destroy</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab6f848f11e9853f49d82f253c1df1121"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jackctl_server_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to destroy server object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle to destroy </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gad2b438d61acdadc96368ff2dd4e9e62f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> * </td>
<td class="paramname"><em>driver</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to open JACK server</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle </td></tr>
<tr><td class="paramname">driver</td><td>driver to use</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="gaa573e4c5e35e853d199cf5b7368700b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to start JACK server</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="gaf71c3fbc808e15305277e667ca6cfac4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to stop JACK server</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="gab09dea0a3ffc38e439cbceaa33951a2c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to close JACK server</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="ga3edd82a413260dc1f4de2862f0a6a669"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct__JSList.html">JSList</a>* jackctl_server_get_drivers_list </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get list of available drivers. List node data pointers is a driver object handle (<a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle to get drivers for</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Single linked list of driver object handles. Must not be modified. Always same for same server object. </dd></dl>
</div>
</div>
<a class="anchor" id="gaeaefa3144a6a9d843467d4951ca71f70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct__JSList.html">JSList</a>* jackctl_server_get_parameters </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get list of server parameters. List node data pointers is a parameter object handle (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle to get parameters for</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Single linked list of parameter object handles. Must not be modified. Always same for same server object. </dd></dl>
</div>
</div>
<a class="anchor" id="gacf1e2a650fec3f019bb36e49ffacde4f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct__JSList.html">JSList</a>* jackctl_server_get_internals_list </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get list of available internal clients. List node data pointers is a internal client object handle (<a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle to get internal clients for</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Single linked list of internal client object handles. Must not be modified. Always same for same server object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga338effc099ff0cf03648971df51f9086"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_load_internal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a> * </td>
<td class="paramname"><em>internal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to load one internal client. (can be used when the server is running)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle </td></tr>
<tr><td class="paramname">internal</td><td>internal to use</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="gac0d0b9b2c5323da9193db9a0aa84bdf9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_unload_internal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a> * </td>
<td class="paramname"><em>internal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to unload one internal client. (can be used when the server is running)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle </td></tr>
<tr><td class="paramname">internal</td><td>internal to unload</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="gadacbb19d2f9e614ce33c8aedaa04fda1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_add_slave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> * </td>
<td class="paramname"><em>driver</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>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)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle </td></tr>
<tr><td class="paramname">driver</td><td>driver to add in the driver slave list.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="gac71a7c5d85e891a51a57f2575aea627c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_remove_slave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> * </td>
<td class="paramname"><em>driver</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>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)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle </td></tr>
<tr><td class="paramname">driver</td><td>driver to remove from the driver slave list.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="ga3bfe5d4befb9d9bab8f05e13d37ca7b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_server_switch_master </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a2e03fca6dadec562d64424718be84c7b">jackctl_server_t</a> * </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> * </td>
<td class="paramname"><em>driver</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to switch master driver.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>server object handle </td></tr>
<tr><td class="paramname">driver</td><td>driver to switch to</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="ga9e28945c015f343e7a82c4e76e9cb1b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* jackctl_driver_get_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> * </td>
<td class="paramname"><em>driver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get name of driver.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">driver</td><td>driver object handle to get name of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>driver name. Must not be modified. Always same for same driver object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga72cc3f0d732b920a75b6279c76187343"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="control_8h.html#a3a160c9609a226c2f769fe27f59ca642">jackctl_driver_type_t</a> jackctl_driver_get_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> * </td>
<td class="paramname"><em>driver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get type of driver.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">driver</td><td>driver object handle to get name of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>driver type. Must not be modified. Always same for same driver object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0f73cfb0c40a401ca6aa617073303e72"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct__JSList.html">JSList</a>* jackctl_driver_get_parameters </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> * </td>
<td class="paramname"><em>driver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get list of driver parameters. List node data pointers is a parameter object handle (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">driver</td><td>driver object handle to get parameters for</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Single linked list of parameter object handles. Must not be modified. Always same for same driver object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1d9e5244a6cba6e305279b54416ee385"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jackctl_driver_params_parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#ae09575159bc77124db69a4588c3b24cb">jackctl_driver_t</a> * </td>
<td class="paramname"><em>driver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>argv</em>[] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to parse parameters for a driver.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">driver</td><td>driver object handle </td></tr>
<tr><td class="paramname">argc</td><td>parameter list len </td></tr>
<tr><td class="paramname">argv</td><td>parameter list, as an array of char*</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="ga4d14a6526174de9d085b203a7b7d632a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* jackctl_internal_get_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a> * </td>
<td class="paramname"><em>internal</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get name of internal client.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">internal</td><td>internal object handle to get name of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>internal name. Must not be modified. Always same for same internal object. </dd></dl>
</div>
</div>
<a class="anchor" id="gade591618ee972b92724be7ee87a3943a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct__JSList.html">JSList</a>* jackctl_internal_get_parameters </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#abf199d364b087e8951cf4fbd2986e3b7">jackctl_internal_t</a> * </td>
<td class="paramname"><em>internal</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get list of internal parameters. List node data pointers is a parameter object handle (<a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">internal</td><td>internal object handle to get parameters for</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Single linked list of parameter object handles. Must not be modified. Always same for same internal object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga3a123ee66e7605b1f17db88d4f5b8ac8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* jackctl_parameter_get_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter name.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to get name of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter name. Must not be modified. Always same for same parameter object. </dd></dl>
</div>
</div>
<a class="anchor" id="gaac9fe5577753455308a53f5569fe3106"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* jackctl_parameter_get_short_description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter short description.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to get short description of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter short description. Must not be modified. Always same for same parameter object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga97aae5c29e16539b71bc7dc2bddafc4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* jackctl_parameter_get_long_description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter long description.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to get long description of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter long description. Must not be modified. Always same for same parameter object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga37fe25ce3d3fdbc631a12cab91c460bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="control_8h.html#ac71832cf5445a694a178d15345d67840">jackctl_param_type_t</a> jackctl_parameter_get_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter type.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to get type of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter type. Always same for same parameter object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga864ee9036a98736910f264b1a62f0fe9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char jackctl_parameter_get_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter character.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to get character of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>character. </dd></dl>
</div>
</div>
<a class="anchor" id="ga439234cd9c8cb1ff35a8bffef526f04b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_parameter_is_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to check whether parameter has been set, or its default value is being used.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true - parameter is set, false - parameter is using default value. </dd></dl>
</div>
</div>
<a class="anchor" id="gac75904b4d63158841b6f4667a7928788"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_parameter_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to reset parameter to its default value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to reset value of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="ga9881e66c9c235484e5b8879ce27bc9f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> jackctl_parameter_get_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">write</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to get value of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter value. </dd></dl>
</div>
</div>
<a class="anchor" id="gab769622731339e7d35e3b7093db347e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_parameter_set_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> * </td>
<td class="paramname"><em>value_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to set parameter value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to get value of </td></tr>
<tr><td class="paramname">value_ptr</td><td>pointer to variable containing parameter value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status: true - success, false - fail </dd></dl>
</div>
</div>
<a class="anchor" id="gaa71bfc637794e50ccd5c39d0449b982a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> jackctl_parameter_get_default_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">write</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter default value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to get default value of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter default value. </dd></dl>
</div>
</div>
<a class="anchor" id="gae7228c1726b5ecaae6458134bf4ab4d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_parameter_has_range_constraint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function check whether parameter has range constraint.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>object handle of parameter to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parameter has range constraint. </dd></dl>
</div>
</div>
<a class="anchor" id="ga823ae164d023267b57002226444fe708"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_parameter_has_enum_constraint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function check whether parameter has enumeration constraint.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>object handle of parameter to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parameter has enumeration constraint. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1578b61842cf7a7cfb0d8fe54cf286ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t jackctl_parameter_get_enum_constraints_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function get how many enumeration values parameter has.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>object handle of parameter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of enumeration values </dd></dl>
</div>
</div>
<a class="anchor" id="ga12fbe98c92f84dcfbd2de23421181567"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> jackctl_parameter_get_enum_constraint_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">write</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter enumeration value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>object handle of parameter </td></tr>
<tr><td class="paramname">index</td><td>index of parameter enumeration value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>enumeration value. </dd></dl>
</div>
</div>
<a class="anchor" id="gadbaa1566bcd829aa4233aac9234125ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* jackctl_parameter_get_enum_constraint_description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter enumeration value description.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>object handle of parameter </td></tr>
<tr><td class="paramname">index</td><td>index of parameter enumeration value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>enumeration value description. </dd></dl>
</div>
</div>
<a class="anchor" id="ga132d53b3fe319e84baf5a2381bd50fc6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jackctl_parameter_get_range_constraint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> * </td>
<td class="paramname"><em>min_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">union <a class="el" href="unionjackctl__parameter__value.html">jackctl_parameter_value</a> * </td>
<td class="paramname"><em>max_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to get parameter range.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>object handle of parameter </td></tr>
<tr><td class="paramname">min_ptr</td><td>pointer to variable receiving parameter minimum value </td></tr>
<tr><td class="paramname">max_ptr</td><td>pointer to variable receiving parameter maximum value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac1d74fdcc7125293b7c2d329c0b09e9a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_parameter_constraint_is_strict </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to check whether parameter constraint is strict, i.e. whether supplying non-matching value will not work for sure.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parameter constraint is strict. </dd></dl>
</div>
</div>
<a class="anchor" id="gafd1b5bc48305a978135692997abc8996"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jackctl_parameter_constraint_is_fake_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="control_8h.html#a94a2a730b099fcbd1576c3ac73c296c4">jackctl_parameter_t</a> * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>parameter object handle to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether parameter constraint is strict. </dd></dl>
</div>
</div>
<a class="anchor" id="gac6448626e0b75fc6d9da1ccbdca0355e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_error </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to log an error message.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga21328fd378306e0da7270952196eb717"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_info </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to log an information message.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga35f69faaee3bb9b958ed8c9a5f62246c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_log </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call this function to log an information message but only when verbose mode is enabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>
Generated for Jack2 by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.8.1.2</small></address>
</body>
</html>
