- Qt 6.8
- Qt TextToSpeech
- Qt 6.8.3 Reference Documentation

# Qt TextToSpeech

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.

## 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's C++ API 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

- Changes in Qt 6

## QML Types

The following lists some important QML types.

TextToSpeech | Type provides access to text-to-speech engines
VoiceSelector | Provides attached properties for selecting the voice of a TextToSpeech element
voice | Type represents a particular voice

## C++ Classes

The following lists some important C++ Classes.

QTextToSpeech | Convenient access to text-to-speech engines
QVoice | Represents a particular voice

## Reference and Examples

- QML Types
- C++ Classes
- Examples
- Engine Documentation

## Licenses and Attributions

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.8.3 may contain third party modules under the following permissive licenses: