QTextToSpeech Class

メンバー関数ドキュメント

text を生の音声データに合成する。

この関数は、音声を非同期で生の音声データに合成する。データが利用可能な場合、functor はfunctor(QAudioFormat format, QByteArray bytes) として呼び出され、format はbytes のデータのformat を記述し、またはfunctor(QAudioBuffer &buffer) として呼び出される。

state プロパティは、合成が始まるとSynthesizing に設定され、合成が終了するとReady に設定される。合成中は、functor が複数回呼び出され、format の値が変更される可能性がある。

functor は、ラムダ関数やfree関数のように呼び出し可能で、オプションでcontext オブジェクトを指定できます：

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

または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);

context が破棄されると、functor は呼び出されなくなります。

この関数は Qt 6.6 で導入されました。

say() およびstop()も参照してください 。

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

デフォルトのエンジンプラグインを使用するプラグインから音声合成エンジンをロードし、parent の子として QTextToSpeech オブジェクトを構築します。

デフォルトのエンジンはプラットフォーム固有です。

エンジンが正しく初期化されると、エンジンのstate がQTextToSpeech::Ready に変わります。プラグインのロードに失敗した場合、state はQTextToSpeech::Error に設定されます。

availableEngines()も参照してください 。

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

パラメータengine に一致するプラグインから音声合成エンジンをロードし、parent の子として QTextToSpeech オブジェクトを構築します。

engine が空の場合、デフォルトのエンジンプラグインが使用されます。デフォルトのエンジンはプラットフォーム固有です。

エンジンが正しく初期化された場合、エンジンのstate はQTextToSpeech::Ready に設定されます。プラグインのロードに失敗した場合、またはエンジンの初期化に失敗した場合、エンジンのstate はQTextToSpeech::Error に設定されます。

availableEngines()も参照 。

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

パラメータengine に一致するプラグインから音声合成エンジンをロードし、parent の子として QTextToSpeech オブジェクトを構築し、params をエンジンに渡します。

engine が空の場合、デフォルトのエンジンプラグインが使用されます。デフ ォル ト のエン ジ ンはプ ラ ッ ト フ ォーム固有です。params のどのキー/値ペアをサポートするかは、エンジンに依存します。詳細はエンジンのドキュメントを参照してください。サポー ト さ れていない項目は無視 さ れます。

エン ジ ンの初期化が正 し く 行われた場合、 エン ジ ンのstate はQTextToSpeech::Ready に設定 さ れます。 プ ラ グ イ ンの読み込みに失敗 し た場合、 ま たはエン ジ ンの初期化に失敗 し た場合、 エン ジ ンのstate はQTextToSpeech::Error に設定 さ れます。

この関数は Qt 6.4 で導入されました。

availableEngines()も参照してください 。

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

このQTextToSpeech オブジェクトを破壊し、すべてのスピーチを停止する。

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

このシグナルは、エンジンがid の音声合成を開始する直前に出力されます。id は、enqueue() の呼び出しによって返される値です。アプリケーションはこのシグナルを使用して、voice 属性を直前に変更したり、enqueue() を介してエンキューされたテキストのプロセスを追跡したりできます。

この関数は Qt 6.6 で導入されました。

enqueue(),synthesize(),voiceも参照してください 。

[static invokable] QStringList QTextToSpeech::availableEngines()

サポートされている音声合成エンジンのプラグインのリストを取得する。

engineも参照して ください。

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

アクティブなengine がサポートしているロケールのリストを返します。

availableVoices() およびfindVoices()も参照して ください。

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

現在のlocale で使用可能な声部のリストを返します。

availableLocales() およびfindVoices()も参照して ください。

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

utterance を発話するテキストのキューに追加し、発話を開始する。キュー内のテキストのインデックスを返し、エラーの場合は -1 を返す。

エンジンのstate が現在Ready である場合、utterance が直ちに発話される。そうでない場合、エンジンは現在のテキストを話し終えるとutterance を話し始める。

エンジンがキューの次のテキスト・エントリに進むたびに、aboutToSynthesize （）シグナルが発せられる。これにより、アプリケーションは進行状況を把握し、音声属性を直前に変更することができます。

stop() を呼び出すと、キューはクリアされます。テキストの最後でエンジンを一時停止するには、Utterance 境界ヒントを使用します。

この関数は Qt 6.6 で導入されました。

say(),stop(),aboutToSynthesize(),synthesize()も参照してください 。

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

このシグナルは、エラーが発生し、state がQTextToSpeech::Error に設定された後に発行される。reason パラメータはエラーのタイプを指定し、errorString は人間が読めるエラーの説明を提供する。

QTextToSpeech::ErrorReason は登録されたメタタイプではないので、キュー接続の場合は () と () で登録する必要がある。Q_DECLARE_METATYPE qRegisterMetaType

errorReason()、errorString()、Creating Custom Qt Typesも参照してください 。

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

エンジンがエラーを報告した理由を返します。

state およびerrorOccurred()も参照して ください。

[invokable] QString QTextToSpeech::errorString() const

現在のエンジンのエラーメッセージを返します。

errorOccurred()も参照してください 。

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

args の条件にマッチする声部のリストを返す。

args の引数は、全てにマッチする声部のリストを作成するために処理される。QString 型の引数は、声部のname とマッチし、QLocale 型の引数は、声部のlocale とマッチする。希望する音声のLanguage またはTerritory のみを指定することも可能で、名前をregular expression にマッチさせることもできます。

条件リストが空の場合、この関数はすべての音声を返します。同じ型の複数の条件を指定することはできず、コンパイル時にエラーとなる。

この関数は Qt 6.6 で導入されました。

availableVoices()も参照してください 。

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

boundaryHint で現在のスピーチを一時停止する。

boundaryHint が尊重されるかどうかは、engine に依存する。

resume() およびPauseResumeも参照のこと 。

[slot] void QTextToSpeech::resume()

pause() がコールされた後、スピーチを再開する。

pause()も参照してください 。

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

text を話し始める。

この関数は音声の合成を非同期で開始し、テキストをデフォルトの音声出力デバイスに読み上げます。

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

現在の状態はstate プロパティで確認でき、読み上げが開始されるとSpeaking に設定されます。読み取りが終了すると、state はReady に設定されます。

enqueue(),stop(),pause(),resume(),synthesize()も参照のこと 。

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

このシグナルは、発話id のstart とlength で示されるテキストのスライスであるword がオーディオ・デバイスに再生されたときに発せられる。

この関数は Qt 6.6 で導入されました。

Capability とsay()も参照してください 。

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

このQTextToSpeech オブジェクトが使用するエンジンをengine に設定し、params をエンジンのコンストラクタに渡します。

engine が正常に設定できたかどうかを返します。

params のどのキー/値ペアをサポートするかは、エンジンに依存します。詳細はエンジンのドキュメントを参照してください。サポー ト さ れていない項目は無視 さ れます。

この関数は Qt 6.4 で導入されました。

engine()も参照してください 。

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

boundaryHint で現在の読み取りを停止し、保留中のテキストのキューをクリアする。

読み込みを再開することはできない。boundaryHint が尊重されるかどうかはエンジンに依存する。

say()、enqueue()、pause()も参照 。