Connection class

Paket:

microsoft-cognitiveservices-speech-sdk

Connection ist eine Proxyklasse zum Verwalten der Verbindung mit dem Sprachdienst der angegebenen Erkennung. Standardmäßig verwaltet eine Erkennung die Verbindung mit dem Dienst bei Bedarf autonom. Die Connection-Klasse bietet zusätzliche Methoden für Benutzer zum expliziten Öffnen oder Schließen einer Verbindung und zum Abonnieren von Verbindungsstatusänderungen. Die Verwendung von Connection ist optional und vor allem für Szenarien, in denen eine Feinabstimmung des Anwendungsverhaltens basierend auf dem Verbindungsstatus erforderlich ist. Benutzer können Optional Open() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor sie mit der Erkennung auf der Erkennung beginnen, die dieser Verbindung zugeordnet ist. Wenn die Erkennung eine Verbindung mit dem Dienst herstellen oder trennen muss, wird die Verbindung unabhängig eingerichtet oder heruntergefahren. In diesem Fall wird die Verbindung durch Änderung des Verbindungsstatus über Connected/Disconnected-Ereignisse benachrichtigt. In Version 1.2.1 hinzugefügt.

Eigenschaften

connected	Das Connected-Ereignis, um anzugeben, dass die Erkennung mit dem Dienst verbunden ist.
disconnected	Das Disconnected-Ereignis, um anzugeben, dass die Erkennung vom Dienst getrennt ist.
messageReceived	Jede Nachricht, die vom Speech-Dienst empfangen wird.
messageSent	Jede Nachricht, die an den Speech-Dienst gesendet wird.
receivedServiceMessage	Jede Nachricht vom Dienst, die nicht von anderen Erkennungsern der obersten Ebene verarbeitet wird. Wird in Version 2.0 entfernt.

Methoden

close()	Entsorgen Sie zugeordnete Ressourcen.
closeConnection(() => void, (error: string) => void)	Schließt die Verbindung des Diensts. Benutzer können optional closeConnection() aufrufen, um die Verbindung der zugehörigen Erkennung manuell herunterzufahren. Wenn closeConnection() während der Erkennung aufgerufen wird, schlägt die Erkennung fehl und bricht mit einem Fehler ab.
fromRecognizer(Recognizer | ConversationTranscriber)	Ruft die Connection-Instanz aus der angegebenen Erkennung ab.
fromSynthesizer(SpeechSynthesizer)	Ruft die Connection-Instanz aus dem angegebenen Synthesizer ab.
openConnection(() => void, (error: string) => void)	Beginnt mit dem Einrichten der Verbindung mit dem Dienst. Benutzer können optional openConnection() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor sie mit der Erkennung auf der Erkennung beginnen, die dieser Verbindung zugeordnet ist. Nach dem Start der Erkennung hat das Aufrufen von Open() keine Auswirkungen. Hinweis: Bei der Rückgabe ist die Verbindung möglicherweise noch nicht bereit. Abonnieren Sie das Connected-Ereignis, um benachrichtigt zu werden, wenn die Verbindung hergestellt wird.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Sendet eine Nachricht an den Sprachdienst. In Version 1.13.0 hinzugefügt.
setMessageProperty(string, string, string | object)	Fügt einen Parameter in einer Nachricht an den Dienst an. In Version 1.12.1 hinzugefügt.

Details zur Eigenschaft

connected

Das Connected-Ereignis, um anzugeben, dass die Erkennung mit dem Dienst verbunden ist.

connected: (args: ConnectionEventArgs) => void

Eigenschaftswert

(args: ConnectionEventArgs) => void

disconnected

Das Disconnected-Ereignis, um anzugeben, dass die Erkennung vom Dienst getrennt ist.

disconnected: (args: ConnectionEventArgs) => void

Eigenschaftswert

(args: ConnectionEventArgs) => void

messageReceived

Jede Nachricht, die vom Speech-Dienst empfangen wird.

messageReceived: (args: ConnectionMessageEventArgs) => void

Eigenschaftswert

(args: ConnectionMessageEventArgs) => void

messageSent

Jede Nachricht, die an den Speech-Dienst gesendet wird.

messageSent: (args: ConnectionMessageEventArgs) => void

Eigenschaftswert

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Jede Nachricht vom Dienst, die nicht von anderen Erkennungsern der obersten Ebene verarbeitet wird.

Wird in Version 2.0 entfernt.

receivedServiceMessage: (args: ServiceEventArgs) => void

Eigenschaftswert

(args: ServiceEventArgs) => void

Details zur Methode

close()

Entsorgen Sie zugeordnete Ressourcen.

function close()

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

Schließt die Verbindung des Diensts. Benutzer können optional closeConnection() aufrufen, um die Verbindung der zugehörigen Erkennung manuell herunterzufahren.

Wenn closeConnection() während der Erkennung aufgerufen wird, schlägt die Erkennung fehl und bricht mit einem Fehler ab.

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

Parameter

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Ruft die Connection-Instanz aus der angegebenen Erkennung ab.

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

Parameter

recognizer

Recognizer | ConversationTranscriber

Die der Verbindung zugeordnete Erkennung.

Gibt zurück

Connection

Die Verbindungsinstanz der Erkennung.

fromSynthesizer(SpeechSynthesizer)

Ruft die Connection-Instanz aus dem angegebenen Synthesizer ab.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parameter

synthesizer

SpeechSynthesizer

Der der Verbindung zugeordnete Synthesizer.

Gibt zurück

Connection

Die Connection-Instanz des Synthesizers.

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

Beginnt mit dem Einrichten der Verbindung mit dem Dienst. Benutzer können optional openConnection() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor sie mit der Erkennung auf der Erkennung beginnen, die dieser Verbindung zugeordnet ist. Nach dem Start der Erkennung hat das Aufrufen von Open() keine Auswirkungen.

Hinweis: Bei der Rückgabe ist die Verbindung möglicherweise noch nicht bereit. Abonnieren Sie das Connected-Ereignis, um benachrichtigt zu werden, wenn die Verbindung hergestellt wird.

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

Parameter

cb

() => void

err

(error: string) => void

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

Sendet eine Nachricht an den Sprachdienst. In Version 1.13.0 hinzugefügt.

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

Parameter

path

string

Der WebSocket-Pfad der Nachricht

payload

string | ArrayBuffer

Die Nutzlast der Nachricht. Dies ist eine JSON-Zeichenfolge oder ein ArrayBuffer.

success

() => void

Ein Rückruf, der den Erfolg anzeigt.

error

(error: string) => void

Ein Rückruf, der auf einen Fehler hinweist.

setMessageProperty(string, string, string | object)

Fügt einen Parameter in einer Nachricht an den Dienst an. In Version 1.12.1 hinzugefügt.

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

Parameter

path

string

Der Pfad der Netzwerknachricht.

propertyName

string

Name der Eigenschaft

propertyValue

string | object

Der Wert der Eigenschaft. Dies ist eine JSON-Zeichenfolge.