This client API allows an application to communicate to NVDA, in order to do such things as speak text or braille a message. Specifically in this repository, the Fibonacci program allows NVDA to speak and braille messages about numbers in the Fibonacci sequence.
The client API is implemented as a dll (dynamic link library). The functions in this dll can be called from any programming language that supports looking up and calling of any symbol in a dll (such as ctypes in Python), or by linking to it, for languages like C and C++.
Note: The header and library files are built along with nvdaHelper. If you want to build them yourself, please see source\nvdaHelper\building.txt in the NVDA source distribution for instructions. Alternatively, you can find a pre-built package at http://www.nvda-project.org/nvdaControllerClient/.
- nvdaControllerClient32.dll: the dll that contains all the functions. This is for use in 32 bit applications. You can distribute this dll with your application.
- nvdaControllerClient32.lib and nvdaControllerClient32.exp: The import and export libraries for nvdaControllerClient32.dll (used when linking with C/C++ code).
- nvdaControllerClient64.dll, nvdaControllerClient64.lib and nvdaControllerClient64.exp: same as above except for use in 64 bit applications.
- nvdaController.h: a C header file containing declarations for all the provided functions.
- fibonacci.py: a Python program that uses the NVDA controller client API to speak and braille messages for Fibonacci numbers.
All functions in this dll return 0 on success and a non-0 code on failier. Failier could be due to not being able to communicate with NVDA, or perhaps an incorrect usage of the function. The error codes that these functions return are always standard Windows error codes.
For definitions of all the functions available, please look at nvdaController.h. The functions are documented with comments.
- NVDA
- Python 32-bit, since fibonacci.py references nvdaControllerClient32.dll
- If using Python 64-bit, you can change './nvdaControllerClient32.dll' in fibonacci.py to './nvdaControllerClient64.dll'
- Clone this repository
- Start NVDA if it is not already running
- Open a command prompt to the root directory of this repository
- Run the following command to launch the Fibonacci program:
py fibonacci.py- NOTE: Python Launcher for Windows might be helpful if using different versions of Python
- The program will prompt for a number, which will be the size of the list of numbers from the Fibonacci sequence to speak/braille/print
The NVDA Controller Client API is licensed under the GNU Lesser General Public License (LGPL) version 2.1. In simple terms, this means you can use this library in any application, however if you modify the library in any way you must contribute the changes back to the community under the same license.
Please see license.txt in this directory for more details.