QTextToSpeech Class

Documentation des fonctions membres

[explicit] QTextToSpeech::QTextToSpeech(QObject *parent = nullptr)

Charge un moteur de synthèse vocale à partir d'un plug-in qui utilise le plug-in du moteur par défaut et crée un objet `QTextToSpeech` en tant qu'enfant de ` parent`.

Le moteur par défaut dépend de la plate-forme.

Si le moteur s'initialise correctement, l'state du moteur passe alors à QTextToSpeech::Ready; notez que cela peut se produire de manière asynchrone. Si le chargement du plug-in échoue, state est alors défini sur QTextToSpeech::Error.

Voir également availableEngines().

[explicit] QTextToSpeech::QTextToSpeech(const QString &engine, QObject *parent = nullptr)

Charge un moteur de synthèse vocale à partir d'un plug-in correspondant au paramètre engine et crée un objet QTextToSpeech en tant qu'enfant de parent.

Si engine est vide, le plug-in de moteur par défaut est utilisé. Le moteur par défaut dépend de la plate-forme.

Si le moteur s’initialise correctement, la propriété ` state ` du moteur sera définie sur ` QTextToSpeech::Ready`. Si le chargement du plug-in échoue ou si le moteur ne parvient pas à s’initialiser, la propriété ` state ` du moteur sera définie sur ` QTextToSpeech::Error`.

Voir également availableEngines().

[explicit, since 6.4] QTextToSpeech::QTextToSpeech(const QString &engine, const QVariantMap &params, QObject *parent = nullptr)

Charge un moteur de synthèse vocale à partir d’un plug-in correspondant au paramètre engine et crée un objet QTextToSpeech en tant qu’enfant de parent, en transmettant params au moteur.

Si engine est vide, le plug-in de moteur par défaut est utilisé. Le moteur par défaut dépend de la plateforme. Les paires clé/valeur prises en charge dans params dépendent du moteur. Consultez la documentation du moteur pour plus de détails. Les entrées non prises en charge seront ignorées.

Si le moteur s'initialise correctement, la propriété ` state ` du moteur sera définie sur ` QTextToSpeech::Ready`. Si le chargement du plug-in échoue, ou si le moteur ne parvient pas à s'initialiser, la propriété ` state ` du moteur sera définie sur ` QTextToSpeech::Error`.

Cette fonction a été introduite dans Qt 6.4.

Voir également availableEngines().

[override virtual noexcept] QTextToSpeech::~QTextToSpeech()

Détruit cet objet « QTextToSpeech », mettant ainsi fin à toute prise de parole.

[signal, since 6.6] void QTextToSpeech::aboutToSynthesize(qsizetype id)

Ce signal est émis juste avant que le moteur ne commence à synthétiser le flux audio pour id. L'id correspond à la valeur renvoyée par un appel à enqueue(). Les applications peuvent utiliser ce signal pour apporter des modifications de dernière minute aux attributs de voice, ou pour suivre le traitement du texte mis en file d'attente via enqueue().

Cette fonction a été introduite dans Qt 6.6.

Voir également enqueue(), synthesize() et voice.

[static invokable] QStringList QTextToSpeech::availableEngines()

Récupère la liste des plug-ins de synthèse vocale pris en charge.

Voir également engine.

[invokable] QList<QLocale> QTextToSpeech::availableLocales() const

Renvoie la liste des paramètres régionaux pris en charge par l'engine e actif.

Voir également ` availableVoices()` et ` findVoices()`.

[invokable] QList<QVoice> QTextToSpeech::availableVoices() const

Renvoie la liste des voix disponibles pour l'locale ion en cours.

Voir également ` availableLocales()` et ` findVoices()`.

[slot, since 6.6] qsizetype QTextToSpeech::enqueue(const QString &utterance)

Ajoute utterance à la file d'attente des textes à lire à voix haute, puis lance la lecture. Renvoie l'index du texte dans la file d'attente, ou -1 en cas d'erreur.

Si l'state du moteur est actuellement « Ready », « utterance » sera lu immédiatement. Sinon, le moteur commencera à lire « utterance » une fois qu'il aura fini de lire le texte en cours.

Chaque fois que le moteur passe à l’entrée de texte suivante dans la file d’attente, le signal aboutToSynthesize() est émis. Cela permet aux applications de suivre la progression et d’apporter des modifications de dernière minute aux attributs vocaux.

L'appel de stop() vide la file d'attente. Pour mettre le moteur en pause à la fin d'un texte, utilisez l'indicateur de limite « Utterance ».

Cette fonction a été introduite dans Qt 6.6.

Voir également say(), stop(), aboutToSynthesize() et synthesize().

[signal] void QTextToSpeech::errorOccurred(QTextToSpeech::ErrorReason reason, const QString &errorString)

Ce signal est émis lorsqu'une erreur s'est produite et que l'state a été défini sur QTextToSpeech::Error. Le paramètre reason spécifie le type d'erreur, tandis que le paramètre errorString fournit une description de l'erreur lisible par l'utilisateur.

QTextToSpeech::ErrorReason n'est pas un métatype enregistré ; par conséquent, pour les connexions en file d'attente, vous devrez l'enregistrer à l'aide des fonctions Q_DECLARE_METATYPE() et qRegisterMetaType().

Voir également errorReason(), errorString() et Création de types Qt personnalisés.

[invokable] QTextToSpeech::ErrorReason QTextToSpeech::errorReason() const

Renvoie la raison pour laquelle le moteur a signalé une erreur.

Voir également state et errorOccurred().

[invokable] QString QTextToSpeech::errorString() const

Renvoie le message d'erreur actuel du moteur.

Voir également errorOccurred().

[since 6.6] template <typename... Args> QList<QVoice> QTextToSpeech::findVoices(Args &&... args) const

Renvoie la liste des voix correspondant aux critères définis dans args.

Les arguments de args sont traités afin de constituer la liste des voix qui répondent à l’ensemble de ces critères. Un argument de type QString est comparé au paramètre name de la voix, un argument de type QLocale est comparé au paramètre locale de la voix, etc. Il est possible de ne spécifier que les paramètres Language ou Territory des voix souhaitées, et le nom peut être comparé au paramètre regular expression.

Cette fonction renvoie toutes les voix si la liste des critères est vide. Il n’est pas possible de spécifier plusieurs critères du même type ; cela entraînerait une erreur de compilation.

Cette fonction a été introduite dans Qt 6.6.

Voir également availableVoices().

[slot] void QTextToSpeech::pause(QTextToSpeech::BoundaryHint boundaryHint = QTextToSpeech::BoundaryHint::Default)

Met en pause le discours en cours à l'adresse boundaryHint.

Le respect de l'boundaryHint dépend de l'engine.

Voir également resume() et PauseResume.

[slot] void QTextToSpeech::resume()

Reprendre la lecture après l'appel de la fonction ` pause()`.

Voir également pause().

[slot] void QTextToSpeech::say(const QString &text)

Commence à lire le texte text.

Cette fonction lance la synthèse vocale de manière asynchrone et lit le texte sur le périphérique de sortie audio par défaut.

    connect(ui.speakButton, &QPushButton::clicked, m_speech, [this]{
        m_speech->say(ui.plainTextEdit->toPlainText());
    });

L'état actuel est accessible via la propriété ` state ` et prend la valeur ` Speaking ` dès que la lecture commence. Une fois la lecture terminée, ` state ` prendra la valeur ` Ready`.

Voir également enqueue(), stop(), pause(), resume() et synthesize().

[signal, since 6.6] void QTextToSpeech::sayingWord(const QString &word, qsizetype id, qsizetype start, qsizetype length)

Ce signal est émis lorsque l’ word, qui correspond à l’extrait de texte indiqué par start et length dans l’énoncé id, est lu sur le périphérique audio.

Cette fonction a été introduite dans Qt 6.6.

Voir également Capability et say().

[invokable, since 6.4] bool QTextToSpeech::setEngine(const QString &engine, const QVariantMap &params = QVariantMap())

Définit le moteur utilisé par cet objet ` QTextToSpeech ` sur ` engine`, en transmettant ` params ` au constructeur du moteur.

Renvoie si l'engine a pu être défini correctement.

Les paires clé/valeur prises en charge dans ` params ` dépendent du moteur. Consultez la documentation du moteur pour plus de détails. Les entrées non prises en charge seront ignorées.

Cette fonction a été introduite dans Qt 6.4.

Voir également engine().

[slot] void QTextToSpeech::stop(QTextToSpeech::BoundaryHint boundaryHint = QTextToSpeech::BoundaryHint::Default)

Interrompt la lecture en cours à l'adresse boundaryHint et efface la file d'attente des textes en attente.

La lecture ne peut pas être reprise. Le respect de la valeur « boundaryHint » dépend du moteur.

Voir également say(), enqueue() et pause().

Synthétise l'text en données audio brutes.

Cette fonction synthétise la parole de manière asynchrone en données audio brutes. Lorsque des données sont disponibles, la méthode ` functor ` est appelée sous la forme ` functor(QAudioFormat format, QByteArray bytes)`, où ` format ` décrit l’ format des données dans ` bytes` ; ou sous la forme ` functor(QAudioBuffer &buffer)`.

La propriété state est définie sur Synthesizing au début de la synthèse, puis sur Ready une fois celle-ci terminée. Pendant la synthèse, la fonction functor peut être appelée plusieurs fois, éventuellement avec des valeurs différentes pour format.

La fonction ` functor ` peut être une entité appelable, telle qu’un lambda ou une fonction libre, avec un objet ` context ` facultatif :

tts.synthesize("Hello world", [](const QAudioFormat &format, const QByteArray &bytes){
    // process data according to format
});

ou une fonction membre de l’objet ` context ` :

struct PCMProcessor : QObject
{
    void processData(const QAudioFormat &format, const QByteArray &bytes)
    {
        // process data according to format
    }
} processor;
tts.synthesize("Hello world", &processor, &PCMProcessor::processData);

Si l’ context est détruit, l’ functor ne sera plus appelé.

Ces fonctions ont été introduites dans Qt 6.6.

Voir également say() et stop().