Qt TextToSpeech

The module enables a Qt application to support accessibility features such as text-to-speech, which is useful for end-users who are visually challenged or cannot access the application for whatever reason. The most common use case where text-to-speech comes in handy is when the end-user is driving and cannot attend the incoming messages on the phone. In such a scenario, the messaging application can read out the incoming message.

The module depends on Speech Dispatcher (libspeechd) on the Linux platform. On other platforms, it uses the native APIs to access the platform-specific text-to-speech engines.

Using the Module

QML API

The QML types of the module are available through the QtTextToSpeech import. To use the types, add the following import statement to your .qml file:

 import QtTextToSpeech

C++ API

Using a Qt module requires linking against the module library, either directly or through other dependencies. Several build tools have dedicated support for this, including CMake and qmake.

Building with CMake

Use the find_package() command to locate the needed module component in the Qt6 package:

 find_package(Qt6 REQUIRED COMPONENTS TextToSpeech)
 target_link_libraries(mytarget PRIVATE Qt6::TextToSpeech)

For more details, see the Build with CMake overview.

Building with qmake

To configure the module for building with qmake, add the module as a value of the QT variable in the project's .pro file:

 QT += texttospeech

Overviews and Important Topics

QML Types

The following lists some important QML types.

TextToSpeech

Type provides access to text-to-speech engines

C++ Classes

The following lists some important C++ Classes.

Reference and Examples