This package provides the header files, static archive, shared object
linker reference, and reference documentation for BrlAPI (the
Application Programming Interface to BRLTTY). It enables the
implementation of applications which take direct advantage of a
refreshable braille display in order to present information in ways
which are more appropriate for blind users and/or to provide user
interfaces which are more specifically attuned to their needs.
Install this package if you are developing or maintaining an application
which directly accesses a refreshable braille display.
brlapi_connection Before calling any other function of the library, calling brlapi_openConnection() is needed to establish a connection to BrlAPI 's server. When the connection... brlapi_connectionSettings_t This structure holds every parameter needed to connect to BrlAPI: which file the authorization key can be found in and which computer to connect to. brlapi_constants.h Macros#define BRLAPI_KEY_CMD_NOOP (BRLAPI_KEY_CMD(0) + 0) #define BRLAPI_KEY_CMD_LNUP (BRLAPI_KEY_CMD(0) + 1) #define BRLAPI_KEY_CMD_LNDN (BRLAPI_KEY_CMD(0) +... brlapi_deprecated With version 0.5.0, BrlAPI is now provided through including <brlapi.h> and got a big renaming pass. Old names are still available through macros, but they are... brlapi_driverspecific If the application wants to directly talk to the braille terminal, it should use Raw Mode. In this special mode, the driver gives the whole control of the... brlapi_error When a function fails, brlapi_errno will hold an error code to explain why it failed. It should always be reported somehow. Although most errors are reported... brlapi_error_t All information that is needed to describe brlapi errors brlapi_handles Each function provided by BrlAPI comes in two versions. brlapi_info Before using Raw mode or key codes, the application should always check the type of the connected terminal, to be sure it is really the one it expects. One... brlapi_keycodes.h #include 'brlapi_constants.h'Macros#define BRLAPI_PRIxKEYCODE PRIx64 #define BRLAPI_PRIuKEYCODE PRIu64 #define BRLAPI_KEY_MAX UINT64_C(0XFFFFFFFFFFFFFFFF)... brlapi_keys Once brlapi_enterTtyMode() has been called, the application can call brlapi_readKey() to read key presses. Either key codes (see Types and Defines fore BrlAPI... brlapi_packet_t Type for packets. Should be used instead of a mere char, since it has correct alignment requirements. brlapi_protocol These are defines for the protocol between BrlAPI 's server and clients. Understanding is not needed to use the BrlAPI library, so reading this is not needed... brlapi_protocol.h #include 'brlapi.h' #include <inttypes.h> #include <unistd.h> #include <pthread.h>Data Structuresstruct brlapi_header_t struct brlapi_versionPacket_t struct... brlapi_range_t Type for raw keycode ranges Denotes the set of keycodes between first and last (inclusive) brlapi_tty Before being able to write on the braille display, the application must tell the server which tty it will handle. The application must also specify how braille... brlapi_version #define BRLAPI_RELEASE '0.6.5' #define BRLAPI_MAJOR 0 #define BRLAPI_MINOR 6 #define BRLAPI_REVISION 5 brlapi_write After brlapi_enterTtyMode() has been called, the application can call one of these functions to write things on the braille display.