Connection クラス

  • リファレンス
パッケージ:
com.microsoft.cognitiveservices.speech
Maven 成果物:
com.microsoft.cognitiveservices.speech:client-sdk:1.34.0
  • java.lang.Object
    • com.microsoft.cognitiveservices.speech.Connection

実装

java.lang.AutoCloseable

public final class Connection
implements java.lang.AutoCloseable

Connection は、指定された Recognizer の音声サービスへの接続を管理するためのプロキシ クラスです。 既定では、必要に応じて、Recognizer によってサービスへの接続が自律的に管理されます。 Connection クラスには、ユーザーが接続を明示的に開いたり閉んだり、接続状態の変更をサブスクライブしたりするための追加のメソッドが用意されています。 Connection の使用は省略可能です。 これは、接続状態に基づいてアプリケーションの動作を微調整する必要があるシナリオを対象としています。 ユーザーは必要に応じて openConnection() を呼び出して、この接続に関連付けられている認識機能で認識を開始する前に、サービス接続を手動で開始できます。 認識を開始すると、openConnection() または closeConnection() の呼び出しが失敗する可能性があります。 これは、認識エンジンや進行中の認識には影響しません。 さまざまな理由で接続が切断される可能性があります。継続的な操作を保証するために、Recognizer は常に必要に応じて接続の再確立を試みます。 これらすべての場合、接続/切断されたイベントは、接続状態の変更を示します。 注: オブジェクトが保持する基になるリソースを解放するには、close() を呼び出す必要があります。 バージョン 1.17.0 で更新されました。

フィールドの概要

修飾子と型 フィールドと説明
final EventHandlerImpl<ConnectionEventArgs> connected

認識エンジンがサービスに接続されていることを示す Connected イベント。
final EventHandlerImpl<ConnectionEventArgs> disconnected

認識エンジンがサービスから切断されていることを示す Disconnected イベント。
final EventHandlerImpl<ConnectionMessageEventArgs> messageReceived

MessageReceived イベントは、サービスがクライアントにネットワーク メッセージを送信したことを示します。

メソッドの概要

修飾子と型 メソッドと説明
void close()

関連付けられているリソースを破棄します。
void closeConnection()

サービスの接続を閉じます。
static Connection fromConversationTranslator(ConversationTranslator conversationTranslator)

会話トランスレーターから Connection インスタンスを取得します。
static Connection fromDialogServiceConnector(DialogServiceConnector dialogServiceConnector)

ダイアログ サービス コネクタから Connection インスタンスを取得します。
static Connection fromRecognizer(Recognizer recognizer)

指定した認識エンジンから Connection インスタンスを取得します。
static Connection fromSpeechSynthesizer(SpeechSynthesizer speechSynthesizer)

音声シンセサイザーから Connection インスタンスを取得します。
void openConnection(boolean forContinuousRecognition)

サービスへの接続の設定を開始します。
java.util.concurrent.Future<java.lang.Void> sendMessageAsync(String path, String payload)

サービスにメッセージを送信します。
void setMessageProperty(String path, String propertyName, String propertyValue)

メッセージ内のパラメーターをサービスに追加します。

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

フィールドの詳細

connected

public final EventHandlerImpl connected

認識エンジンがサービスに接続されていることを示す Connected イベント。 サブスクライブ後に接続されたイベントを受信するには、Connection オブジェクト自体がアクティブである必要があります。 このイベントを所有する Connection オブジェクトが有効期間外の場合、サブスクライブされているすべてのイベントは配信されません。

disconnected

public final EventHandlerImpl disconnected

認識エンジンがサービスから切断されていることを示す Disconnected イベント。 サブスクライブ後に切断されたイベントを受信するには、Connection オブジェクト自体がライブである必要があります。 このイベントを所有する Connection オブジェクトが有効期間外の場合、サブスクライブされているすべてのイベントは配信されません。

messageReceived

public final EventHandlerImpl messageReceived

MessageReceived イベントは、サービスがクライアントにネットワーク メッセージを送信したことを示します。 バージョン 1.15.0 で追加されました。

メソッドの詳細

close

public void close()

関連付けられているリソースを破棄します。 基になるリソースを正しく放棄するには、close() を呼び出す必要があります。

closeConnection

public void closeConnection()

サービスの接続を閉じます。 ユーザーは必要に応じて closeConnection() を呼び出して、関連付けられている Recognizer の接続を手動でシャットダウンできます。 認識エンジンのプロセス状態によっては、呼び出しが失敗する場合があります。 ただし、エラーは関連する Recognizer の状態には影響しません。

fromConversationTranslator

public static Connection fromConversationTranslator(ConversationTranslator conversationTranslator)

会話トランスレーターから Connection インスタンスを取得します。

Parameters:

conversationTranslator - 接続に関連付けられている conversationTranslator。

Returns:

認識エンジンの Connection インスタンス。

fromDialogServiceConnector

public static Connection fromDialogServiceConnector(DialogServiceConnector dialogServiceConnector)

ダイアログ サービス コネクタから Connection インスタンスを取得します。

Parameters:

dialogServiceConnector - 音声サービスとの接続状態の監視と管理に使用される、接続に関連付けられているダイアログ サービス コネクタ。

Returns:

ダイアログ サービス コネクタの Connection インスタンス。

fromRecognizer

public static Connection fromRecognizer(Recognizer recognizer)

指定した認識エンジンから Connection インスタンスを取得します。

Parameters:

recognizer - 接続に関連付けられている認識エンジン。

Returns:

認識エンジンの Connection インスタンス。

fromSpeechSynthesizer

public static Connection fromSpeechSynthesizer(SpeechSynthesizer speechSynthesizer)

音声シンセサイザーから Connection インスタンスを取得します。 バージョン 1.17.0 で追加されました

Parameters:

speechSynthesizer - 音声サービスとの接続状態の監視と管理に使用される、接続に関連付けられている音声シンセサイザー。

Returns:

音声シンセサイザーの Connection インスタンス。

openConnection

public void openConnection(boolean forContinuousRecognition)

サービスへの接続の設定を開始します。 ユーザーは、必要に応じて openConnection() を呼び出して、この接続に関連付けられている認識機能で認識を開始する前に、手動で接続を事前に設定できます。 認識を開始した後、認識エンジンのプロセス状態によっては、OpenConnection() の呼び出しが失敗することがあります。 ただし、エラーは関連する Recognizer の状態には影響しません。 注: 返却時に、接続がまだ準備できていない可能性があります。 接続が確立されたときに通知を受け取るために、Connected イベントをサブスクライブしてください。

Parameters:

forContinuousRecognition - は、接続が連続認識とシングルショット認識のどちらに使用されるかを示します。 接続が SpeechSynthsizer からの場合は有効になりません。

sendMessageAsync

public Future sendMessageAsync(String path, String payload)

サービスにメッセージを送信します。 バージョン 1.7.0 で追加された注: このメソッドは SpeechSynthesizer の接続では機能しません。

Parameters:

path - メッセージ パス。
payload - メッセージ ペイロード。

Returns:

メッセージを送信する非同期操作を表す未来。

setMessageProperty

public void setMessageProperty(String path, String propertyName, String propertyValue)

メッセージ内のパラメーターをサービスに追加します。 バージョン 1.7.0 で追加された注: このメソッドは SpeechSynthesizer の接続では機能しません。

Parameters:

path - メッセージ パス。
propertyName - 設定するプロパティ名。
propertyValue - 設定するプロパティの値。

適用対象