.TH "brlapi_param.h" 3 "Thu Sep 07 2023" "Version 0.8" "BrlAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
brlapi_param.h
.SH SYNOPSIS
.br
.PP
\fC#include 'brlapi_keycodes\&.h'\fP
.br

.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBbrlapi_param_displaySize_t\fP"
.br
.ti -1c
.RI "struct \fBbrlapi_param_computerBrailleRowCells_t\fP"
.br
.ti -1c
.RI "struct \fBbrlapi_param_properties_t\fP"
.br
.in -1c
.in +1c
.ti -1c
.RI "#define \fBBRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT\fP   50"
.br
.ti -1c
.RI "#define \fBBRLAPI_PARAM_CLIENT_PRIORITY_DISABLE\fP   0"
.br
.ti -1c
.RI "#define \fBBRLAPI_PARAM_BOUND_COMMAND_CODES\fP   \fBBRLAPI_PARAM_BOUND_COMMAND_KEYCODES\fP"
.br
.ti -1c
.RI "#define \fBBRLAPI_PARAM_COMMAND_SHORT_NAME\fP   \fBBRLAPI_PARAM_COMMAND_KEYCODE_NAME\fP"
.br
.ti -1c
.RI "#define \fBBRLAPI_PARAM_COMMAND_LONG_NAME\fP   \fBBRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY\fP"
.br
.ti -1c
.RI "#define \fBBRLAPI_PARAM_DEVICE_KEY_CODES\fP   \fBBRLAPI_PARAM_DEFINED_DRIVER_KEYCODES\fP"
.br
.ti -1c
.RI "#define \fBBRLAPI_PARAM_KEY_SHORT_NAME\fP   \fBBRLAPI_PARAM_DRIVER_KEYCODE_NAME\fP"
.br
.ti -1c
.RI "#define \fBBRLAPI_PARAM_KEY_LONG_NAME\fP   \fBBRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY\fP"
.br
.ti -1c
.RI "enum \fBbrlapi_param_t\fP { \fBBRLAPI_PARAM_SERVER_VERSION\fP = 0, \fBBRLAPI_PARAM_CLIENT_PRIORITY\fP = 1, \fBBRLAPI_PARAM_DRIVER_NAME\fP = 2, \fBBRLAPI_PARAM_DRIVER_CODE\fP = 3, \fBBRLAPI_PARAM_DRIVER_VERSION\fP = 4, \fBBRLAPI_PARAM_DEVICE_MODEL\fP = 5, \fBBRLAPI_PARAM_DEVICE_CELL_SIZE\fP = 31, \fBBRLAPI_PARAM_DISPLAY_SIZE\fP = 6, \fBBRLAPI_PARAM_DEVICE_IDENTIFIER\fP = 7, \fBBRLAPI_PARAM_DEVICE_SPEED\fP = 8, \fBBRLAPI_PARAM_DEVICE_ONLINE\fP = 9, \fBBRLAPI_PARAM_RETAIN_DOTS\fP = 10, \fBBRLAPI_PARAM_COMPUTER_BRAILLE_CELL_SIZE\fP = 11, \fBBRLAPI_PARAM_LITERARY_BRAILLE\fP = 12, \fBBRLAPI_PARAM_CURSOR_DOTS\fP = 13, \fBBRLAPI_PARAM_CURSOR_BLINK_PERIOD\fP = 14, \fBBRLAPI_PARAM_CURSOR_BLINK_PERCENTAGE\fP = 15, \fBBRLAPI_PARAM_RENDERED_CELLS\fP = 16, \fBBRLAPI_PARAM_SKIP_IDENTICAL_LINES\fP = 17, \fBBRLAPI_PARAM_AUDIBLE_ALERTS\fP = 18, \fBBRLAPI_PARAM_CLIPBOARD_CONTENT\fP = 19, \fBBRLAPI_PARAM_BOUND_COMMAND_KEYCODES\fP = 20, \fBBRLAPI_PARAM_COMMAND_KEYCODE_NAME\fP = 21, \fBBRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY\fP = 22, \fBBRLAPI_PARAM_DEFINED_DRIVER_KEYCODES\fP = 23, \fBBRLAPI_PARAM_DRIVER_KEYCODE_NAME\fP = 24, \fBBRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY\fP = 25, \fBBRLAPI_PARAM_COMPUTER_BRAILLE_ROWS_MASK\fP = 26, \fBBRLAPI_PARAM_COMPUTER_BRAILLE_ROW_CELLS\fP = 27, \fBBRLAPI_PARAM_COMPUTER_BRAILLE_TABLE\fP = 28, \fBBRLAPI_PARAM_LITERARY_BRAILLE_TABLE\fP = 29, \fBBRLAPI_PARAM_MESSAGE_LOCALE\fP = 30, \fBBRLAPI_PARAM_COUNT\fP = 32 }"
.br
.ti -1c
.RI "enum \fBbrlapi_param_type_t\fP { \fBBRLAPI_PARAM_TYPE_STRING\fP, \fBBRLAPI_PARAM_TYPE_BOOLEAN\fP, \fBBRLAPI_PARAM_TYPE_UINT8\fP, \fBBRLAPI_PARAM_TYPE_UINT16\fP, \fBBRLAPI_PARAM_TYPE_UINT32\fP, \fBBRLAPI_PARAM_TYPE_UINT64\fP, \fBBRLAPI_PARAM_TYPE_KEYCODE\fP = BRLAPI_PARAM_TYPE_UINT64 }"
.br
.ti -1c
.RI "typedef uint64_t \fBbrlapi_param_subparam_t\fP"
.br
.ti -1c
.RI "typedef uint8_t \fBbrlapi_param_bool_t\fP"
.br
.ti -1c
.RI "typedef uint32_t \fBbrlapi_param_serverVersion_t\fP"
.br
.ti -1c
.RI "typedef uint32_t \fBbrlapi_param_clientPriority_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_driverName_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_driverCode_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_driverVersion_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_deviceModel_t\fP"
.br
.ti -1c
.RI "typedef uint8_t \fBbrlapi_param_deviceCellSize_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_deviceIdentifier_t\fP"
.br
.ti -1c
.RI "typedef uint32_t \fBbrlapi_param_deviceSpeed_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_deviceOnline_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_retainDots_t\fP"
.br
.ti -1c
.RI "typedef uint8_t \fBbrlapi_param_computerBrailleCellSize_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_literaryBraille_t\fP"
.br
.ti -1c
.RI "typedef uint8_t \fBbrlapi_param_cursorDots_t\fP"
.br
.ti -1c
.RI "typedef uint32_t \fBbrlapi_param_cursorBlinkPeriod_t\fP"
.br
.ti -1c
.RI "typedef uint8_t \fBbrlapi_param_cursorBlinkPercentage_t\fP"
.br
.ti -1c
.RI "typedef uint8_t * \fBbrlapi_param_renderedCells_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_skipIdenticalLines_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_audibleAlerts_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_clipboardContent_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_keyCode_t\fP \fBbrlapi_param_commandKeycode_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_commandKeycodeName_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_commandKeycodeSummary_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_keyCode_t\fP \fBbrlapi_param_driverKeycode_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_driverKeycodeName_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_driverKeycodeSummary_t\fP"
.br
.ti -1c
.RI "typedef uint8_t \fBbrlapi_param_computerBrailleRowsMask_t\fP[544]"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_computerBrailleTable_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_literaryBrailleTable_t\fP"
.br
.ti -1c
.RI "typedef char * \fBbrlapi_param_messageLocale_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_commandKeycode_t\fP \fBbrlapi_param_commandCode_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_commandKeycodeName_t\fP \fBbrlapi_param_commandShortName_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_commandKeycodeSummary_t\fP \fBbrlapi_param_commandLongName_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_driverKeycode_t\fP \fBbrlapi_param_keyCode_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_driverKeycodeName_t\fP \fBbrlapi_param_keyShortName_t\fP"
.br
.ti -1c
.RI "typedef \fBbrlapi_param_driverKeycodeSummary_t\fP \fBbrlapi_param_keyLongName_t\fP"
.br
.ti -1c
.RI "const \fBbrlapi_param_properties_t\fP * \fBbrlapi_getParameterProperties\fP (\fBbrlapi_param_t\fP parameter)"
.br
.in -1c
.SH "Macro Definition Documentation"
.PP 
.SS "#define BRLAPI_PARAM_BOUND_COMMAND_CODES   \fBBRLAPI_PARAM_BOUND_COMMAND_KEYCODES\fP"
Deprecated in BRLTTY-6\&.2 - use BRLAPI_PARAM_BOUND_COMMAND_KEYCODES 
.SS "#define BRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT   50"
Default value for BRLAPI_PARAM_CLIENT_PRIORITY 
.SS "#define BRLAPI_PARAM_CLIENT_PRIORITY_DISABLE   0"
Value for BRLAPI_PARAM_CLIENT_PRIORITY which actually disables input and output 
.SS "#define BRLAPI_PARAM_COMMAND_LONG_NAME   \fBBRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY\fP"
Deprecated in BRLTTY-6\&.2 - use BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY 
.SS "#define BRLAPI_PARAM_COMMAND_SHORT_NAME   \fBBRLAPI_PARAM_COMMAND_KEYCODE_NAME\fP"
Deprecated in BRLTTY-6\&.2 - use BRLAPI_PARAM_COMMAND_KEYCODE_NAME 
.SS "#define BRLAPI_PARAM_DEVICE_KEY_CODES   \fBBRLAPI_PARAM_DEFINED_DRIVER_KEYCODES\fP"
Deprecated in BRLTTY-6\&.2 - use BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES 
.SS "#define BRLAPI_PARAM_KEY_LONG_NAME   \fBBRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY\fP"
Deprecated in BRLTTY-6\&.2 - use BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY 
.SS "#define BRLAPI_PARAM_KEY_SHORT_NAME   \fBBRLAPI_PARAM_DRIVER_KEYCODE_NAME\fP"
Deprecated in BRLTTY-6\&.2 - use BRLAPI_PARAM_DRIVER_KEYCODE_NAME 
.SH "Typedef Documentation"
.PP 
.SS "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_audibleAlerts_t\fP"
Type to be used for BRLAPI_PARAM_AUDIBLE_ALERTS 
.SS "typedef uint8_t \fBbrlapi_param_bool_t\fP"
Type to be used for boolean parameters 
.SS "typedef uint32_t \fBbrlapi_param_clientPriority_t\fP"
Type to be used for BRLAPI_PARAM_CLIENT_PRIORITY 
.SS "typedef char* \fBbrlapi_param_clipboardContent_t\fP"
Type to be used for BRLAPI_PARAM_CLIPBOARD_CONTENT 
.SS "typedef \fBbrlapi_param_commandKeycode_t\fP \fBbrlapi_param_commandCode_t\fP"
Deprecated in BRLTTY-6\&.2 - use brlapi_param_commandKeycode_t 
.SS "typedef \fBbrlapi_keyCode_t\fP \fBbrlapi_param_commandKeycode_t\fP"
Type to be used for BRLAPI_PARAM_BOUND_COMMAND_KEYCODES 
.SS "typedef char* \fBbrlapi_param_commandKeycodeName_t\fP"
Type to be used for BRLAPI_PARAM_COMMAND_KEYCODE_NAME 
.SS "typedef char* \fBbrlapi_param_commandKeycodeSummary_t\fP"
Type to be used for BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY 
.SS "typedef \fBbrlapi_param_commandKeycodeSummary_t\fP \fBbrlapi_param_commandLongName_t\fP"
Deprecated in BRLTTY-6\&.2 - use brlapi_param_commandKeycodeSummary_t 
.SS "typedef \fBbrlapi_param_commandKeycodeName_t\fP \fBbrlapi_param_commandShortName_t\fP"
Deprecated in BRLTTY-6\&.2 - use brlapi_param_commandKeycodeName_t 
.SS "typedef uint8_t \fBbrlapi_param_computerBrailleCellSize_t\fP"
Type to be used for BRLAPI_PARAM_COMPUTER_BRAILLE_CELL_SIZE 
.SS "typedef uint8_t brlapi_param_computerBrailleRowsMask_t[544]"
Type to be used for BRLAPI_PARAM_COMPUTER_BRAILLE_ROWS_MASK 
.SS "typedef char* \fBbrlapi_param_computerBrailleTable_t\fP"
Type to be used for BRLAPI_PARAM_COMPUTER_BRAILLE_TABLE 
.SS "typedef uint8_t \fBbrlapi_param_cursorBlinkPercentage_t\fP"
Type to be used for BRLAPI_PARAM_CURSOR_BLINK_PERCENTAGE 
.SS "typedef uint32_t \fBbrlapi_param_cursorBlinkPeriod_t\fP"
Type to be used for BRLAPI_PARAM_CURSOR_BLINK_PERIOD 
.SS "typedef uint8_t \fBbrlapi_param_cursorDots_t\fP"
Type to be used for BRLAPI_PARAM_CURSOR_DOTS 
.SS "typedef uint8_t \fBbrlapi_param_deviceCellSize_t\fP"
Type to be used for BRLAPI_PARAM_DEVICE_CELL_SIZE 
.SS "typedef char* \fBbrlapi_param_deviceIdentifier_t\fP"
Type to be used for BRLAPI_PARAM_DEVICE_IDENTIFIER 
.SS "typedef char* \fBbrlapi_param_deviceModel_t\fP"
Type to be used for BRLAPI_PARAM_DEVICE_MODEL 
.SS "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_deviceOnline_t\fP"
Type to be used for BRLAPI_PARAM_DEVICE_ONLINE 
.SS "typedef uint32_t \fBbrlapi_param_deviceSpeed_t\fP"
Type to be used for BRLAPI_PARAM_DEVICE_SPEED 
.SS "typedef char* \fBbrlapi_param_driverCode_t\fP"
Type to be used for BRLAPI_PARAM_DRIVER_CODE 
.SS "typedef \fBbrlapi_keyCode_t\fP \fBbrlapi_param_driverKeycode_t\fP"
Type to be used for BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES 
.SS "typedef char* \fBbrlapi_param_driverKeycodeName_t\fP"
Type to be used for BRLAPI_PARAM_DRIVER_KEYCODE_NAME 
.SS "typedef char* \fBbrlapi_param_driverKeycodeSummary_t\fP"
Type to be used for BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY 
.SS "typedef char* \fBbrlapi_param_driverName_t\fP"
Type to be used for BRLAPI_PARAM_DRIVER_NAME 
.SS "typedef char* \fBbrlapi_param_driverVersion_t\fP"
Type to be used for BRLAPI_PARAM_DRIVER_VERSION 
.SS "typedef \fBbrlapi_param_driverKeycode_t\fP \fBbrlapi_param_keyCode_t\fP"
Deprecated in BRLTTY-6\&.2 - use brlapi_param_driverKeycode_t 
.SS "typedef \fBbrlapi_param_driverKeycodeSummary_t\fP \fBbrlapi_param_keyLongName_t\fP"
Deprecated in BRLTTY-6\&.2 - use brlapi_param_driverKeycodeSummary_t 
.SS "typedef \fBbrlapi_param_driverKeycodeName_t\fP \fBbrlapi_param_keyShortName_t\fP"
Deprecated in BRLTTY-6\&.2 - use brlapi_param_driverKeycodeName_t 
.SS "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_literaryBraille_t\fP"
Type to be used for BRLAPI_PARAM_LITERARY_BRAILLE 
.SS "typedef char* \fBbrlapi_param_literaryBrailleTable_t\fP"
Type to be used for BRLAPI_PARAM_LITERARY_BRAILLE_TABLE 
.SS "typedef char* \fBbrlapi_param_messageLocale_t\fP"
Type to be used for BRLAPI_PARAM_MESSAGE_LOCALE 
.br
 
.SS "typedef uint8_t* \fBbrlapi_param_renderedCells_t\fP"
Type to be used for BRLAPI_PARAM_RENDERED_CELLS 
.SS "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_retainDots_t\fP"
Type to be used for BRLAPI_PARAM_RETAIN_DOTS 
.SS "typedef uint32_t \fBbrlapi_param_serverVersion_t\fP"
Type to be used for BRLAPI_PARAM_SERVER_VERSION 
.SS "typedef \fBbrlapi_param_bool_t\fP \fBbrlapi_param_skipIdenticalLines_t\fP"
Type to be used for BRLAPI_PARAM_SKIP_IDENTICAL_LINES 
.SS "typedef uint64_t \fBbrlapi_param_subparam_t\fP"
Type to be used for specifying a sub-parameter 
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBbrlapi_param_type_t\fP"
Enumeration of parameter value types 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIBRLAPI_PARAM_TYPE_STRING \fP\fP
Parameter is a string of UTF-8 characters 
.TP
\fB\fIBRLAPI_PARAM_TYPE_BOOLEAN \fP\fP
Parameter is one or more booleans represented by a uint8_t 
.TP
\fB\fIBRLAPI_PARAM_TYPE_UINT8 \fP\fP
Parameter is one or more 8-bit unsigned integers 
.TP
\fB\fIBRLAPI_PARAM_TYPE_UINT16 \fP\fP
Parameter is one or more 16-bit unsigned integers 
.TP
\fB\fIBRLAPI_PARAM_TYPE_UINT32 \fP\fP
Parameter is one or more 32-bit unsigned integers 
.TP
\fB\fIBRLAPI_PARAM_TYPE_UINT64 \fP\fP
Parameter is one or more 64-bit unsigned integers 
.TP
\fB\fIBRLAPI_PARAM_TYPE_KEYCODE \fP\fP
Parameter is one or more key codes 
.SH "Function Documentation"
.PP 
.SS "const \fBbrlapi_param_properties_t\fP * brlapi_getParameterProperties (\fBbrlapi_param_t\fP parameter)"
Enumeration of parameter types Return a description of the properties of a parameter
.PP
\fBParameters\fP
.RS 4
\fIparameter\fP is the parameter whose properties describion shall be returned\&.
.RE
.PP
\fBReturns\fP
.RS 4
a pointer to the description of the properties of the parameter\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for BrlAPI from the source code\&.