QVoice Class | Qt TextToSpeech | Qt 6.12.0
Description: The QVoice class represents a particular voice.
Keywords: class

- Qt 6.12
- Qt TextToSpeech
- C++ Classes
- QVoice
- Qt 6.12.0 Reference Documentation

# QVoice Class

The QVoice class represents a particular voice. More...

Header: | `#include <QVoice>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS TextToSpeech)` `target_link_libraries(mytarget PRIVATE Qt6::TextToSpeech)`
qmake: | `QT += texttospeech`

- List of all members, including inherited members

## Public Types

enum | Age { Child, Teenager, Adult, Senior, Other }
enum | Gender { Male, Female, Unknown }

## Properties

age : const Age gender : const Gender `(since 6.6)` language : QLocale::Language | `(since 6.4)` locale : const QLocale name : const QString

## Public Functions

| QVoice()
| QVoice(const QVoice &other)
| QVoice(QVoice &&other)
| ~QVoice()
QVoice::Age | age() const
QVoice::Gender | gender() const
QLocale::Language | language() const
QLocale | locale() const
QString | name() const
`(since 6.4)` void | swap(QVoice &other)
QVoice & | operator=(QVoice &&other)
QVoice & | operator=(const QVoice &other)

## Static Public Members

QString | ageName(QVoice::Age age)
QString | genderName(QVoice::Gender gender)

## Related Non-Members

bool | operator!=(const QVoice &lhs, const QVoice &rhs)
`(since 6.4)` QDataStream & | operator<<(QDataStream &stream, const QVoice &voice)
`(since 6.4)` QDebug | operator<<(QDebug debug, const QVoice &voice)
bool | operator==(const QVoice &lhs, const QVoice &rhs)
`(since 6.4)` QDataStream & | operator>>(QDataStream &stream, QVoice &voice)

## Detailed Description

To get a voice that is supported by the current text-to-speech engine, use QTextToSpeech::availableVoices() or QTextToSpeech::findVoices().

## Member Type Documentation

### enum QVoice::Age

The age of a voice.

Constant | Value | Description
--- | --- | ---
`QVoice::Child` | `0` | Voice of a child
`QVoice::Teenager` | `1` | Voice of a teenager
`QVoice::Adult` | `2` | Voice of an adult
`QVoice::Senior` | `3` | Voice of a senior
`QVoice::Other` | `4` | Voice of unknown age

### enum QVoice::Gender

The gender of a voice.

Constant | Value | Description
--- | --- | ---
`QVoice::Male` | `0` | Voice of a male
`QVoice::Female` | `1` | Voice of a female
`QVoice::Unknown` | `2` | Voice of unknown gender

## Property Documentation

### `[read-only]` age : const Age

This property holds the age of a voice

Access functions:

QVoice::Age | age() const

### `[read-only]` gender : const Gender

This property holds the gender of a voice

Access functions:

QVoice::Gender | gender() const

### `[read-only, since 6.6]` language : QLocale::Language

This property holds the language of the voice

This is the language attribute of the voice's locale.

This enumeration was introduced in Qt 6.6.

Access functions:

QLocale::Language | language() const

### `[read-only, since 6.4]` locale : const QLocale

This property holds the locale of the voice

The locale includes the language and the territory (i.e. accent or dialect) of the voice.

This enumeration was introduced in Qt 6.4.

Access functions:

QLocale | locale() const

### `[read-only]` name : const QString

This property holds the name of a voice

Access functions:

QString | name() const

## Member Function Documentation

### QVoice::QVoice()

Constructs an empty QVoice.

Application code cannot construct arbitrary voice instances. Use QTextToSpeech::availableVoices() or QTextToSpeech::findVoices() instead to select a supported voice.

### `[noexcept]` QVoice::QVoice(const QVoice &other)

Copy-constructs a QVoice from other.

### `[constexpr noexcept default]` QVoice::QVoice(QVoice &&other)

Constructs a QVoice object by moving from other.

### `[noexcept]` QVoice::~QVoice()

Destroys the QVoice instance.

### `[static]` QString QVoice::ageName(QVoice::Age age)

Returns a string representing the age class of a voice.

### `[static]` QString QVoice::genderName(QVoice::Gender gender)

̈́ Returns the gender name of a voice.

### `[noexcept, since 6.4]` void QVoice::swap(QVoice &other)

Swaps other with this voice. This operation is very fast and never fails.

This function was introduced in Qt 6.4.

### `[noexcept]` QVoice &QVoice::operator=(QVoice &&other)

Moves other into this QVoice object.

### `[noexcept]` QVoice &QVoice::operator=(const QVoice &other)

Assigns other to this QVoice object.

## Related Non-Members

### `[noexcept]` bool operator!=(const QVoice &lhs, const QVoice &rhs)

Returns whether the lhs voice and the rhs voice are different.

### `[since 6.4]` QDataStream &operator<<(QDataStream &stream, const QVoice &voice)

Serializes voice to data stream stream.

This function was introduced in Qt 6.4.

See also Serializing Qt Data Types.

### `[since 6.4]` QDebug operator<<(QDebug debug, const QVoice &voice)

Writes information about voice to the debug stream.

This function was introduced in Qt 6.4.

See also QDebug.

### `[noexcept]` bool operator==(const QVoice &lhs, const QVoice &rhs)

Returns whether the lhs voice and the rhs voice are identical.

Two voices are identical if name, locale, gender, and age are identical, and if they belong to the same text-to-speech engine.

### `[since 6.4]` QDataStream &operator>>(QDataStream &stream, QVoice &voice)

Deserializes voice from data stream stream.

This function was introduced in Qt 6.4.

See also Serializing Qt Data Types.