QTextToSpeech Class

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

[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()、および「カスタム Qt 型の作成」も参照してください 。

[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()も参照してください 。

text を生のオーディオデータに合成します。

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

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

functor は、ラムダ式やフリー関数のような呼び出し可能なオブジェクトであり、オプションで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()」も参照してください 。