eclair

Embedded Cross-platform Library for Assistive Interface Routing

Eclair is a library used for enabling Blind and Low-Vision support in applications and game engines. It provides a simple API to send text to Screen Readers and Synthesizers, turning that text into audible speech. It is specifically designed to be small, simple, and embeddable into games and game engines.

Example

eclair_init()
eclair_speak("Press Start to begin", true)

Eclair only sends text - developers are responsible for giving clear information to users on what is being shown, what kind of control they are currently selecting, and what options they have.

Eclair is well suited for non-standard applications and interfaces that don't mimic standard buttons or controls. If you are using more standard application interfaces, you may want to look at AccessKit instead.

Supported Platforms

To be filled...

API

// lifecycle functionseclair_erroreclair_init(void);
voideclair_shutdown(void);
// output functioneclair_erroreclair_speak(constchar*utf8, boolinterrupt)
eclair_erroreclair_stop(void)
// settings and introspectionvoideclair_set_route(eclair_routeroute)
voideclair_set_rate(floatrate)
voideclair_set_volume(floatvolume)
eclair_outputeclair_current_output(void)

Inspirations and Alternatives

Eclair is heavily inspired by SRAL (now archived) and Prism.