BrlAPI
0.8
|
Version of the BrlAPI library | |
BrlAPI handles | Each function provided by BrlAPI comes in two versions |
Connecting to BrlAPI | Before calling any other function of the library, calling brlapi_openConnection() is needed to establish a connection to BrlAPI 's server. When the connection is not needed any more, brlapi_closeConnection() must be called to close the connection |
Setting and getting client data | Clients can register a pointer to data that can then be used e.g. in exception handlers |
Getting Terminal information | How to get information about the connected Terminal |
Entering & leaving tty mode | How to take control of ttys for direct braille display / read |
Writing on the braille display | Write text to the braille display |
Reading key presses | How to read key presses from the braille terminal |
Driver-Specific modes | Raw and Suspend Modes mechanism |
Parameter management | How to manage BrlAPI parameters |
Miscellaneous functions | |
Error handling | How to handle errors |
Deprecated names | 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 deprecated since they will get dropped in the next release. This documentation is for you to know the new names |
Types and Defines for\e BrlAPI Key Codes | Key codes are unsigned 64 bit integers. This 64-bit space is split into 3 parts: |
BrlAPI's protocol | Instructions and constants for BrlAPI 's protocol |