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