クラス Connection
class Connection
: public std::enable_shared_from_this< Connection >
Connection は、指定された Recognizer の音声サービスへの接続を管理するためのプロキシ クラスです。 既定では、必要に応じて、Recognizer によってサービスへの接続が自律的に管理されます。 Connection クラスには、ユーザーが接続を明示的に開いたり閉んだり、接続状態の変更をサブスクライブしたりするための追加のメソッドが用意されています。 Connection の使用は省略可能です。 これは、接続状態に基づいてアプリケーションの動作を微調整する必要があるシナリオを対象としています。 ユーザーは必要に応じて Open() を呼び出して、この接続に関連付けられている認識機能で認識を開始する前に、サービス接続を手動で開始できます。 認識を開始すると、Open() または Close() の呼び出しが失敗する可能性があります。 これは、認識エンジンや進行中の認識には影響しません。 さまざまな理由で接続が切断される可能性があります。継続的な操作を保証するために、Recognizer は常に必要に応じて接続の再確立を試みます。 これらすべての場合、接続/切断されたイベントは、接続状態の変更を示します。 バージョン 1.17.0 で更新されました。
メンバー
接続済み
構文: public EventSignal< constConnectionEventArgs & > Connected;
認識エンジンがサービスに接続されていることを示す Connected イベント。
[Disconnected](切断済み)
構文: public EventSignal< constConnectionEventArgs & > Disconnected;
認識エンジンがサービスから切断されていることを示す Disconnected イベント。
MessageReceived
構文: public EventSignal< constConnectionMessageEventArgs & > MessageReceived;
基になるプロトコルがサービスからメッセージを受信したことを示す MessageReceived イベント。 バージョン 1.10.0 で追加されました。
[ファイル]
構文: public inline void Open ( bool forContinuousRecognition );
サービスへの接続の設定を開始します。 ユーザーは必要に応じて Open() を呼び出して、この接続に関連付けられている認識/シンセサイザーで認識/合成を開始する前に、手動で接続を設定できます。 認識を開始した後、認識エンジン/シンセサイザーのプロセス状態によっては、Open() の呼び出しが失敗する可能性があります。 ただし、このエラーは、関連する Recognizer/シンセサイザーの状態には影響しません。 注: 返却時に、接続がまだ準備できていない可能性があります。 接続が確立されたときに通知を受け取るために、Connected イベントをサブスクライブしてください。
パラメーター
forContinuousRecognition接続を連続認識またはシングルショット認識に使用するかどうかを示します。 接続が SpeechSynthsizer からの場合は有効になりません。
閉じる
構文: public inline void Close ( );
サービスの接続を閉じます。 ユーザーは必要に応じて Close() を呼び出して、関連付けられている Recognizer/シンセサイザーの接続を手動でシャットダウンできます。 認識エンジン/シンセサイザーのプロセス状態によっては、呼び出しが失敗する場合があります。 ただし、このエラーは、関連する Recognizer/シンセサイザーの状態には影響しません。
SetMessageProperty
構文: public inline void SetMessageProperty ( const std::string & path , const std::string & propertyName , const std::string & propertyValue );
メッセージ内のパラメーターをサービスに追加します。 このメソッドは、SpeechSynthesizer の接続では機能しません。 バージョン 1.7.0 で追加されました。
パラメーター
pathメッセージ パス。propertyNameプロパティの名前。propertyValueプロパティの値。 これは json 文字列です。
戻り値
無効。
SendMessageAsync
構文: public inline std::future< void > SendMessageAsync ( const std::string & path , const std::string & payload );
音声サービスにメッセージを送信します。 このメソッドは、SpeechSynthesizer の接続では機能しません。 バージョン 1.7.0 で追加されました。
パラメーター
pathメッセージのパス。payloadメッセージのペイロード。 これは json 文字列です。
戻り値
空の未来。
SendMessageAsync
構文: public inline std::future< void > SendMessageAsync ( const std::string & path , uint8_t * payload , uint32_t size );
バイナリ メッセージを音声サービスに送信します。 このメソッドは、SpeechSynthesizer の接続では機能しません。 バージョン 1.10.0 で追加されました。
パラメーター
pathメッセージのパス。payloadメッセージのバイナリ ペイロード。sizeバイナリ ペイロードのサイズ。
戻り値
空の未来。
接続
構文: public inline explicit Connection ( SPXCONNECTIONHANDLE handle );
内部コンストラクター。 指定されたハンドルを使用して新しいインスタンスを作成します。
パラメーター
handle接続ハンドル。
~接続
構文: public inline ~Connection ( );
デストラクターです。
FromRecognizer
構文: public inline static std::shared_ptr< Connection > FromRecognizer ( std::shared_ptr< Recognizer > recognizer );
指定した認識エンジンから Connection インスタンスを取得します。
パラメーター
recognizer接続に関連付けられている認識エンジン。
戻り値
認識エンジンの Connection インスタンス。
FromConversationTranslator
構文: public inline static std::shared_ptr< Connection > FromConversationTranslator ( std::shared_ptr< Transcription::ConversationTranslator > convTrans );
指定した会話トランスレーターから Connection インスタンスを取得します。
パラメーター
convTrans接続に関連付けられている会話翻訳ツール。
戻り値
会話トランスレーターの Connection インスタンス。
FromDialogServiceConnector
構文: public inline static std::shared_ptr< Connection > FromDialogServiceConnector ( std::shared_ptr< Dialog::DialogServiceConnector > dialogServiceConnector );
音声サービスからの接続と切断の監視と管理に使用される、指定されたダイアログ サービス コネクタから Connection インスタンスを取得します。
パラメーター
dialogServiceConnector接続に関連付けられているダイアログ サービス コネクタ。
戻り値
ダイアログ サービス コネクタの Connection インスタンス。
FromSpeechSynthesizer
構文: public inline static std::shared_ptr< Connection > FromSpeechSynthesizer ( std::shared_ptr< SpeechSynthesizer > synthesizer );
指定した音声シンセサイザーから Connection インスタンスを取得します。 バージョン 1.17.0 で追加されました。
パラメーター
synthesizer接続に関連付けられている音声シンセサイザー。
戻り値
音声シンセサイザーの Connection インスタンス。