---
name: "brlapi_param.h"
section: "3"
platform: "linux"
package: "libbrlapi-dev"
version: "6.7-3.1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/brlapi_param.h"
---

# brlapi\_param.h(3)

## NAME

brlapi\_param.h

## SYNOPSIS

`#include 'brlapi_keycodes.h'`\

### Data Structures

struct **brlapi\_param\_displaySize\_t**\
 struct **brlapi\_param\_computerBrailleRowCells\_t**\
 struct **brlapi\_param\_properties\_t**\

## Macro Definition Documentation

### #define BRLAPI\_PARAM\_BOUND\_COMMAND\_CODES BRLAPI\_PARAM\_BOUND\_COMMAND\_KEYCODES

Deprecated in BRLTTY-6.2 - use BRLAPI\_PARAM\_BOUND\_COMMAND\_KEYCODES

### #define BRLAPI\_PARAM\_CLIENT\_PRIORITY\_DEFAULT 50

Default value for BRLAPI\_PARAM\_CLIENT\_PRIORITY

### #define BRLAPI\_PARAM\_CLIENT\_PRIORITY\_DISABLE 0

Value for BRLAPI\_PARAM\_CLIENT\_PRIORITY which actually disables input and output

### #define BRLAPI\_PARAM\_COMMAND\_LONG\_NAME BRLAPI\_PARAM\_COMMAND\_KEYCODE\_SUMMARY

Deprecated in BRLTTY-6.2 - use BRLAPI\_PARAM\_COMMAND\_KEYCODE\_SUMMARY

### #define BRLAPI\_PARAM\_COMMAND\_SHORT\_NAME BRLAPI\_PARAM\_COMMAND\_KEYCODE\_NAME

Deprecated in BRLTTY-6.2 - use BRLAPI\_PARAM\_COMMAND\_KEYCODE\_NAME

### #define BRLAPI\_PARAM\_DEVICE\_KEY\_CODES BRLAPI\_PARAM\_DEFINED\_DRIVER\_KEYCODES

Deprecated in BRLTTY-6.2 - use BRLAPI\_PARAM\_DEFINED\_DRIVER\_KEYCODES

### #define BRLAPI\_PARAM\_KEY\_LONG\_NAME BRLAPI\_PARAM\_DRIVER\_KEYCODE\_SUMMARY

Deprecated in BRLTTY-6.2 - use BRLAPI\_PARAM\_DRIVER\_KEYCODE\_SUMMARY

### #define BRLAPI\_PARAM\_KEY\_SHORT\_NAME BRLAPI\_PARAM\_DRIVER\_KEYCODE\_NAME

Deprecated in BRLTTY-6.2 - use BRLAPI\_PARAM\_DRIVER\_KEYCODE\_NAME

## Typedef Documentation

### typedef brlapi\_param\_bool\_t brlapi\_param\_audibleAlerts\_t

Type to be used for BRLAPI\_PARAM\_AUDIBLE\_ALERTS

### typedef uint8\_t brlapi\_param\_bool\_t

Type to be used for boolean parameters

### typedef uint32\_t brlapi\_param\_clientPriority\_t

Type to be used for BRLAPI\_PARAM\_CLIENT\_PRIORITY

### typedef char\* brlapi\_param\_clipboardContent\_t

Type to be used for BRLAPI\_PARAM\_CLIPBOARD\_CONTENT

### typedef brlapi\_param\_commandKeycode\_t brlapi\_param\_commandCode\_t

Deprecated in BRLTTY-6.2 - use brlapi\_param\_commandKeycode\_t

### typedef brlapi\_keyCode\_t brlapi\_param\_commandKeycode\_t

Type to be used for BRLAPI\_PARAM\_BOUND\_COMMAND\_KEYCODES

### typedef char\* brlapi\_param\_commandKeycodeName\_t

Type to be used for BRLAPI\_PARAM\_COMMAND\_KEYCODE\_NAME

### typedef char\* brlapi\_param\_commandKeycodeSummary\_t

Type to be used for BRLAPI\_PARAM\_COMMAND\_KEYCODE\_SUMMARY

### typedef brlapi\_param\_commandKeycodeSummary\_t brlapi\_param\_commandLongName\_t

Deprecated in BRLTTY-6.2 - use brlapi\_param\_commandKeycodeSummary\_t

### typedef brlapi\_param\_commandKeycodeName\_t brlapi\_param\_commandShortName\_t

Deprecated in BRLTTY-6.2 - use brlapi\_param\_commandKeycodeName\_t

### typedef uint8\_t brlapi\_param\_computerBrailleCellSize\_t

Type to be used for BRLAPI\_PARAM\_COMPUTER\_BRAILLE\_CELL\_SIZE

### typedef uint8\_t brlapi\_param\_computerBrailleRowsMask\_t\[544\]

Type to be used for BRLAPI\_PARAM\_COMPUTER\_BRAILLE\_ROWS\_MASK

### typedef char\* brlapi\_param\_computerBrailleTable\_t

Type to be used for BRLAPI\_PARAM\_COMPUTER\_BRAILLE\_TABLE

### typedef uint8\_t brlapi\_param\_cursorBlinkPercentage\_t

Type to be used for BRLAPI\_PARAM\_CURSOR\_BLINK\_PERCENTAGE

### typedef uint32\_t brlapi\_param\_cursorBlinkPeriod\_t

Type to be used for BRLAPI\_PARAM\_CURSOR\_BLINK\_PERIOD

### typedef uint8\_t brlapi\_param\_cursorDots\_t

Type to be used for BRLAPI\_PARAM\_CURSOR\_DOTS

### typedef uint8\_t brlapi\_param\_deviceCellSize\_t

Type to be used for BRLAPI\_PARAM\_DEVICE\_CELL\_SIZE

### typedef char\* brlapi\_param\_deviceIdentifier\_t

Type to be used for BRLAPI\_PARAM\_DEVICE\_IDENTIFIER

### typedef char\* brlapi\_param\_deviceModel\_t

Type to be used for BRLAPI\_PARAM\_DEVICE\_MODEL

### typedef brlapi\_param\_bool\_t brlapi\_param\_deviceOnline\_t

Type to be used for BRLAPI\_PARAM\_DEVICE\_ONLINE

### typedef uint32\_t brlapi\_param\_deviceSpeed\_t

Type to be used for BRLAPI\_PARAM\_DEVICE\_SPEED

### typedef char\* brlapi\_param\_driverCode\_t

Type to be used for BRLAPI\_PARAM\_DRIVER\_CODE

### typedef brlapi\_keyCode\_t brlapi\_param\_driverKeycode\_t

Type to be used for BRLAPI\_PARAM\_DEFINED\_DRIVER\_KEYCODES

### typedef char\* brlapi\_param\_driverKeycodeName\_t

Type to be used for BRLAPI\_PARAM\_DRIVER\_KEYCODE\_NAME

### typedef char\* brlapi\_param\_driverKeycodeSummary\_t

Type to be used for BRLAPI\_PARAM\_DRIVER\_KEYCODE\_SUMMARY

### typedef char\* brlapi\_param\_driverName\_t

Type to be used for BRLAPI\_PARAM\_DRIVER\_NAME

### typedef uint64\_t brlapi\_param\_driverPropertyValue\_t

Type to be used for BRLAPI\_PARAM\_DRIVER\_PROPERTY\_VALUE

### typedef char\* brlapi\_param\_driverVersion\_t

Type to be used for BRLAPI\_PARAM\_DRIVER\_VERSION

### typedef brlapi\_param\_driverKeycode\_t brlapi\_param\_keyCode\_t

Deprecated in BRLTTY-6.2 - use brlapi\_param\_driverKeycode\_t

### typedef brlapi\_param\_driverKeycodeSummary\_t brlapi\_param\_keyLongName\_t

Deprecated in BRLTTY-6.2 - use brlapi\_param\_driverKeycodeSummary\_t

### typedef brlapi\_param\_driverKeycodeName\_t brlapi\_param\_keyShortName\_t

Deprecated in BRLTTY-6.2 - use brlapi\_param\_driverKeycodeName\_t

### typedef brlapi\_param\_bool\_t brlapi\_param\_literaryBraille\_t

Type to be used for BRLAPI\_PARAM\_LITERARY\_BRAILLE

### typedef char\* brlapi\_param\_literaryBrailleTable\_t

Type to be used for BRLAPI\_PARAM\_LITERARY\_BRAILLE\_TABLE

### typedef char\* brlapi\_param\_messageLocale\_t

Type to be used for BRLAPI\_PARAM\_MESSAGE\_LOCALE \

### typedef uint8\_t\* brlapi\_param\_renderedCells\_t

Type to be used for BRLAPI\_PARAM\_RENDERED\_CELLS

### typedef brlapi\_param\_bool\_t brlapi\_param\_retainDots\_t

Type to be used for BRLAPI\_PARAM\_RETAIN\_DOTS

### typedef uint32\_t brlapi\_param\_serverVersion\_t

Type to be used for BRLAPI\_PARAM\_SERVER\_VERSION

### typedef brlapi\_param\_bool\_t brlapi\_param\_skipIdenticalLines\_t

Type to be used for BRLAPI\_PARAM\_SKIP\_IDENTICAL\_LINES

### typedef uint64\_t brlapi\_param\_subparam\_t

Type to be used for specifying a sub-parameter

## Enumeration Type Documentation

### enum brlapi\_param\_type\_t

Enumeration of parameter value types

**Enumerator**

- *BRLAPI\_PARAM\_TYPE\_STRING*

  *Parameter is a string of UTF-8 characters*

- *BRLAPI\_PARAM\_TYPE\_BOOLEAN*

  *Parameter is one or more booleans represented by a uint8\_t*

- *BRLAPI\_PARAM\_TYPE\_UINT8*

  *Parameter is one or more 8-bit unsigned integers*

- *BRLAPI\_PARAM\_TYPE\_UINT16*

  *Parameter is one or more 16-bit unsigned integers*

- *BRLAPI\_PARAM\_TYPE\_UINT32*

  *Parameter is one or more 32-bit unsigned integers*

- *BRLAPI\_PARAM\_TYPE\_UINT64*

  *Parameter is one or more 64-bit unsigned integers*

- *BRLAPI\_PARAM\_TYPE\_KEYCODE*

  *Parameter is one or more key codes*

## Function Documentation

### const brlapi\_param\_properties\_t \* brlapi\_getParameterProperties (brlapi\_param\_t parameter)` [extern]`

*Enumeration of parameter types Return a description of the properties of a parameter*

**Parameters**

*parameter is the parameter whose properties describion shall be returned.*

**Returns**

*a pointer to the description of the properties of the parameter.*

## Author

*Generated automatically by Doxygen for BrlAPI from the source code.*