Freigeben über

Connection class

Paket:
microsoft-cognitiveservices-speech-sdk

Die Verbindung ist eine Proxyklasse zum Verwalten der Verbindung mit dem Sprachdienst der angegebenen Erkennung. Standardmäßig verwaltet ein Erkennungsmodul bei Bedarf die Verbindung mit dem Dienst autonom. Die Connection-Klasse bietet zusätzliche Methoden für Benutzer, um eine Verbindung explizit zu öffnen oder zu schließen und Verbindungsstatusänderungen zu abonnieren. Die Verwendung von "Connection" ist optional und hauptsächlich für Szenarien, in denen die Feinabstimmung des Anwendungsverhaltens basierend auf dem Verbindungsstatus erforderlich ist. Benutzer können optional Open() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor die Erkennung für die dieser Verbindung zugeordnete Erkennung gestartet wird. Wenn die Erkennung eine Verbindung mit dem Dienst herstellen oder trennen muss, wird die Verbindung unabhängig voneinander eingerichtet oder heruntergefahren. In diesem Fall wird die Verbindung durch Änderung des Verbindungsstatus über Verbundene/Getrennte Ereignisse benachrichtigt. In Version 1.2.1 hinzugefügt.

Eigenschaften

connected

Das Connected-Ereignis, das angibt, dass die Erkennung mit dem Dienst verbunden ist.
disconnected

Das Disconnected-Ereignis, das angibt, dass die Erkennung vom Dienst getrennt ist.
messageReceived

Jede Nachricht, die vom Sprachdienst empfangen wurde.
messageSent

Jede Nachricht, die an den Sprachdienst gesendet wird.
receivedServiceMessage

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

Wird in 2.0 entfernt.

Methoden

close()

Verwerfen von zugeordneten Ressourcen.
closeConnection(() => void, (error: string) => void)

Schließt die Verbindung des Diensts. Benutzer können optional closeConnection() aufrufen, um die Verbindung der zugeordneten 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 von der angegebenen Erkennung ab.
fromSynthesizer(SpeechSynthesizer)

Ruft die Connection-Instanz vom angegebenen Synthesizer ab.
openConnection(() => void, (error: string) => void)

Startet das Einrichten der Verbindung mit dem Dienst. Benutzer können optional openConnection() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor sie die Erkennung für die dieser Verbindung zugeordnete Erkennung starten. Nach dem Starten der Erkennung hat das Aufrufen von Open() keine Auswirkungen.

Hinweis: Bei der Rückgabe ist die Verbindung möglicherweise noch nicht fertig. 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, das angibt, dass die Erkennung mit dem Dienst verbunden ist.

connected: (args: ConnectionEventArgs) => void

Eigenschaftswert

(args: ConnectionEventArgs) => void

disconnected

Das Disconnected-Ereignis, das angibt, dass die Erkennung vom Dienst getrennt ist.

disconnected: (args: ConnectionEventArgs) => void

Eigenschaftswert

(args: ConnectionEventArgs) => void

messageReceived

Jede Nachricht, die vom Sprachdienst empfangen wurde.

messageReceived: (args: ConnectionMessageEventArgs) => void

Eigenschaftswert

(args: ConnectionMessageEventArgs) => void

messageSent

Jede Nachricht, die an den Sprachdienst gesendet wird.

messageSent: (args: ConnectionMessageEventArgs) => void

Eigenschaftswert

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

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

Wird in 2.0 entfernt.

receivedServiceMessage: (args: ServiceEventArgs) => void

Eigenschaftswert

(args: ServiceEventArgs) => void

Details zur Methode

close()

Verwerfen von zugeordneten Ressourcen.

function close()

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

Schließt die Verbindung des Diensts. Benutzer können optional closeConnection() aufrufen, um die Verbindung der zugeordneten 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 von der angegebenen Erkennung ab.

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

Parameter

recognizer

Recognizer | ConversationTranscriber

Die erkennung, die der Verbindung zugeordnet ist.

Gibt zurück

Connection

Die Verbindungsinstanz der Erkennung.

fromSynthesizer(SpeechSynthesizer)

Ruft die Connection-Instanz vom angegebenen Synthesizer ab.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parameter

synthesizer
SpeechSynthesizer

Der Synthesizer, der der Verbindung zugeordnet ist.

Gibt zurück

Connection

Die Connection-Instanz des Synthesizers.

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

Startet das Einrichten der Verbindung mit dem Dienst. Benutzer können optional openConnection() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor sie die Erkennung für die dieser Verbindung zugeordnete Erkennung starten. Nach dem Starten der Erkennung hat das Aufrufen von Open() keine Auswirkungen.

Hinweis: Bei der Rückgabe ist die Verbindung möglicherweise noch nicht fertig. 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 auf Erfolg hinweist.

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

Wert der Eigenschaft. Dies ist eine JSON-Zeichenfolge.