The Qt TextToSpeech module enables a Qt application to read out text by using speech synthesis. This is especially useful in scenarios where the end-user cannot access the application's visual interface, for example, when driving or operating machinery. In such setups, the module can be used to read out incoming notifications or to provide turn-by-turn navigation instructions.
The module does not provide a text-to-speech engine itself. Instead, it uses engines native to the operating system. See Qt TextToSpeech Engines for more details about this.
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:
find_package() command to locate the needed module component in the
find_package(Qt6 REQUIRED COMPONENTS TextToSpeech) target_link_libraries(mytarget PRIVATE Qt6::TextToSpeech)
For more details, see the Build with CMake overview.
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
The following lists some important QML types.
Type provides access to text-to-speech engines
Provides attached properties for selecting the voice of a TextToSpeech element
Type represents a particular voice
The following lists some important C++ Classes.
Qt TextToSpeech is available under commercial licenses from The Qt Company. In addition, it is available under free software licenses: The GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.
Furthermore, Qt TextToSpeech in Qt 6.6.2 may contain third party modules under the following permissive licenses:
© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.