Connection class

參考

套件:: microsoft-cognitiveservices-speech-sdk

Connection 是一種 Proxy 類別，可用來管理與指定辨識器之語音服務的連線。根據預設，辨識器會視需要自發管理服務的連線。 Connection 類別提供其他方法，讓使用者明確開啟或關閉連線，以及訂閱線上狀態變更。使用 Connection 是選擇性的，主要適用于需要根據線上狀態微調應用程式行為的案例。使用者可以選擇性地呼叫 Open () ，以在與此連線相關聯的辨識器上開始辨識之前，事先手動設定連線。如果辨識器需要連線或中斷服務連線，則會獨立設定或關閉連線。在此情況下，連線會透過連線/中斷線上活動變更來通知線上狀態。已在 1.2.1 版中新增。

屬性

connected	Connected 事件，表示辨識器已連線至服務。
disconnected	Disconnected 事件，表示辨識器已中斷服務連線。
messageReceived	從語音服務接收的任何訊息。
messageSent	傳送至語音服務的任何訊息。
receivedServiceMessage	任何其他最上層辨識器未處理之服務的任何訊息。將會在 2.0 中移除。

方法

close()	處置相關聯的資源。
closeConnection(() => void, (error: string) => void)	關閉服務的連線。使用者可以選擇性地呼叫 closeConnection () 以手動關閉相關聯辨識器的連線。如果在辨識期間呼叫 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

從語音服務接收的任何訊息。

messageReceived: (args: ConnectionMessageEventArgs) => void

屬性值

(args: ConnectionMessageEventArgs) => void

messageSent

傳送至語音服務的任何訊息。

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 () 以手動關閉相關聯辨識器的連線。

如果在辨識期間呼叫 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 字串。