Connection class

パッケージ:

microsoft-cognitiveservices-speech-sdk

Connection は、指定された Recognizer の音声サービスへの接続を管理するためのプロキシ クラスです。 既定では、必要に応じて、Recognizer によってサービスへの接続が自律的に管理されます。 Connection クラスには、ユーザーが接続を明示的に開いたり閉んだり、接続状態の変更をサブスクライブしたりするための追加のメソッドが用意されています。 Connection の使用は省略可能であり、主に接続状態に基づいてアプリケーションの動作を微調整する必要があるシナリオに使用されます。 ユーザーは必要に応じて Open() を呼び出して、この接続に関連付けられている認識機能で認識を開始する前に、手動で接続を事前に設定できます。 Recognizer がサービスに接続または切断する必要がある場合、接続は個別にセットアップまたはシャットダウンされます。 この場合、接続/切断されたイベントを介して接続状態の変更によって接続が通知されます。 バージョン 1.2.1 で追加されました。

プロパティ

connected	認識エンジンがサービスに接続されていることを示す Connected イベント。
disconnected	認識エンジンがサービスから切断されていることを示す Disconnected イベント。
messageReceived	Speech Service から受信したメッセージ。
messageSent	Speech Service に送信されたメッセージ。
receivedServiceMessage	他の最上位レベルの認識エンジンによって処理されていないサービスからのメッセージ。 2.0 で削除されます。

メソッド

close()	関連付けられているリソースを破棄します。
closeConnection(() => void, (error: string) => void)	サービスの接続を閉じます。 ユーザーは必要に応じて closeConnection() を呼び出して、関連付けられている Recognizer の接続を手動でシャットダウンできます。 認識中に closeConnection() が呼び出されると、認識は失敗し、エラーで取り消されます。
fromRecognizer(Recognizer | ConversationTranscriber)	指定した認識エンジンから Connection インスタンスを取得します。
fromSynthesizer(SpeechSynthesizer)	指定したシンセサイザーから Connection インスタンスを取得します。
openConnection(() => void, (error: string) => void)	サービスへの接続の設定を開始します。 ユーザーは、必要に応じて openConnection() を呼び出して、この接続に関連付けられている認識機能で認識を開始する前に、手動で接続を事前に設定できます。 認識を開始した後、Open() を呼び出しても効果はありません 注: 返却時に、接続がまだ準備できていない可能性があります。 接続が確立されたときに通知を受け取るために、Connected イベントをサブスクライブしてください。
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	音声サービスにメッセージを送信します。 バージョン 1.13.0 で追加されました。
setMessageProperty(string, string, string | object)	メッセージ内のパラメーターをサービスに追加します。 バージョン 1.12.1 で追加されました。

プロパティの詳細

connected

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

connected: (args: ConnectionEventArgs) => void

プロパティ値

(args: ConnectionEventArgs) => void

disconnected

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

disconnected: (args: ConnectionEventArgs) => void

プロパティ値

(args: ConnectionEventArgs) => void

messageReceived

Speech Service から受信したメッセージ。

messageReceived: (args: ConnectionMessageEventArgs) => void

プロパティ値

(args: ConnectionMessageEventArgs) => void

messageSent

Speech Service に送信されたメッセージ。

messageSent: (args: ConnectionMessageEventArgs) => void

プロパティ値

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

他の最上位レベルの認識エンジンによって処理されていないサービスからのメッセージ。

2.0 で削除されます。

receivedServiceMessage: (args: ServiceEventArgs) => void

プロパティ値

(args: ServiceEventArgs) => void

メソッドの詳細

close()

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

function close()

closeConnection(() => void, (error: string) => void)

サービスの接続を閉じます。 ユーザーは必要に応じて closeConnection() を呼び出して、関連付けられている Recognizer の接続を手動でシャットダウンできます。

認識中に closeConnection() が呼び出されると、認識は失敗し、エラーで取り消されます。

function closeConnection(cb?: () => void, err?: (error: string) => void)

パラメーター

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

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

static function fromRecognizer(recognizer: Recognizer | ConversationTranscriber): Connection

パラメーター

recognizer

Recognizer | ConversationTranscriber

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

戻り値

Connection

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

fromSynthesizer(SpeechSynthesizer)

指定したシンセサイザーから Connection インスタンスを取得します。

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

パラメーター

synthesizer

SpeechSynthesizer

接続に関連付けられているシンセサイザー。

戻り値

Connection

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

openConnection(() => void, (error: string) => void)

サービスへの接続の設定を開始します。 ユーザーは、必要に応じて openConnection() を呼び出して、この接続に関連付けられている認識機能で認識を開始する前に、手動で接続を事前に設定できます。 認識を開始した後、Open() を呼び出しても効果はありません

注: 返却時に、接続がまだ準備できていない可能性があります。 接続が確立されたときに通知を受け取るために、Connected イベントをサブスクライブしてください。

function openConnection(cb?: () => void, err?: (error: string) => void)

パラメーター

cb

() => void

err

(error: string) => void

sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)

音声サービスにメッセージを送信します。 バージョン 1.13.0 で追加されました。

function sendMessageAsync(path: string, payload: string | ArrayBuffer, success?: () => void, error?: (error: string) => void)

パラメーター

path

string

メッセージの WebSocket パス

payload

string | ArrayBuffer

メッセージのペイロード。 これは json 文字列または ArrayBuffer です。

success

() => void

成功を示すコールバック。

error

(error: string) => void

エラーを示すコールバック。

setMessageProperty(string, string, string | object)

メッセージ内のパラメーターをサービスに追加します。 バージョン 1.12.1 で追加されました。

function setMessageProperty(path: string, propertyName: string, propertyValue: string | object)

パラメーター

path

string

ネットワーク メッセージのパス。

propertyName

string

プロパティ名

propertyValue

string | object

プロパティの値。 これは json 文字列です。