Connection class

Paket:

microsoft-cognitiveservices-speech-sdk

Anslutningen är en proxyklass för att hantera anslutningen till taltjänsten för den angivna identifieraren. Som standard hanterar en recognizer autonom anslutning till tjänsten vid behov. Klassen Anslutning innehåller ytterligare metoder för användare att uttryckligen öppna eller stänga en anslutning och prenumerera på ändringar i anslutningsstatusen. Användning av Anslutning är valfritt, och främst för scenarier där finjustering av programmets beteende baserat på anslutningsstatus krävs. Användare kan också anropa Open() för att manuellt konfigurera en anslutning i förväg innan de startar igenkänningen på den identifierare som är associerad med den här anslutningen. Om identifieraren behöver ansluta eller koppla från till tjänsten konfigureras eller stängs anslutningen av oberoende av varandra. I det här fallet meddelas anslutningen genom att anslutningsstatusen ändras via anslutna/frånkopplade händelser. Har lagts till i version 1.2.1.

Egenskaper

connected	Händelsen Ansluten som anger att identifieraren är ansluten till tjänsten.
disconnected	Händelsen Frånkopplad för att indikera att identifieraren är frånkopplad från tjänsten.
messageReceived	Alla meddelanden som tas emot från Speech Service.
messageSent	Alla meddelanden som skickas till Speech Service.
receivedServiceMessage	Alla meddelanden från tjänsten som inte bearbetas av andra identifierare på toppnivå. Tas bort i 2.0.

Metoder

close()	Ta bort associerade resurser.
closeConnection(() => void, (error: string) => void)	Stänger anslutningen till tjänsten. Användare kan också anropa closeConnection() för att manuellt stänga av anslutningen för den associerade identifieraren. Om closeConnection() anropas under igenkänningen misslyckas igenkänningen och avbryts med ett fel.
fromRecognizer(Recognizer | ConversationTranscriber)	Hämtar anslutningsinstansen från den angivna identifieraren.
fromSynthesizer(SpeechSynthesizer)	Hämtar anslutningsinstansen från den angivna synthesizern.
openConnection(() => void, (error: string) => void)	Börjar konfigurera anslutningen till tjänsten. Användare kan också anropa openConnection() för att manuellt konfigurera en anslutning i förväg innan de startar igenkänningen på den identifierare som är associerad med den här anslutningen. När du har startat igenkänningen har anropet Open() ingen effekt Obs! När anslutningen returneras kanske den inte är klar än. Prenumerera på den anslutna händelsen för att meddelas när anslutningen upprättas.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Skickar ett meddelande till taltjänsten. Har lagts till i version 1.13.0.
setMessageProperty(string, string, string | object)	Lägger till en parameter i ett meddelande i tjänsten. Har lagts till i version 1.12.1.

Egenskapsinformation

connected

Händelsen Ansluten som anger att identifieraren är ansluten till tjänsten.

connected: (args: ConnectionEventArgs) => void

Egenskapsvärde

(args: ConnectionEventArgs) => void

disconnected

Händelsen Frånkopplad för att indikera att identifieraren är frånkopplad från tjänsten.

disconnected: (args: ConnectionEventArgs) => void

Egenskapsvärde

(args: ConnectionEventArgs) => void

messageReceived

Alla meddelanden som tas emot från Speech Service.

messageReceived: (args: ConnectionMessageEventArgs) => void

Egenskapsvärde

(args: ConnectionMessageEventArgs) => void

messageSent

Alla meddelanden som skickas till Speech Service.

messageSent: (args: ConnectionMessageEventArgs) => void

Egenskapsvärde

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Alla meddelanden från tjänsten som inte bearbetas av andra identifierare på toppnivå.

Tas bort i 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Egenskapsvärde

(args: ServiceEventArgs) => void

Metodinformation

close()

Ta bort associerade resurser.

function close()

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

Stänger anslutningen till tjänsten. Användare kan också anropa closeConnection() för att manuellt stänga av anslutningen för den associerade identifieraren.

Om closeConnection() anropas under igenkänningen misslyckas igenkänningen och avbryts med ett fel.

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

Parametrar

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Hämtar anslutningsinstansen från den angivna identifieraren.

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

Parametrar

recognizer

Recognizer | ConversationTranscriber

Den identifierare som är associerad med anslutningen.

Returer

Connection

Anslutningsinstansen för identifieraren.

fromSynthesizer(SpeechSynthesizer)

Hämtar anslutningsinstansen från den angivna synthesizern.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parametrar

synthesizer

SpeechSynthesizer

Synteten som är associerad med anslutningen.

Returer

Connection

Syntets anslutningsinstans.

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

Börjar konfigurera anslutningen till tjänsten. Användare kan också anropa openConnection() för att manuellt konfigurera en anslutning i förväg innan de startar igenkänningen på den identifierare som är associerad med den här anslutningen. När du har startat igenkänningen har anropet Open() ingen effekt

Obs! När anslutningen returneras kanske den inte är klar än. Prenumerera på den anslutna händelsen för att meddelas när anslutningen upprättas.

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

Parametrar

cb

() => void

err

(error: string) => void

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

Skickar ett meddelande till taltjänsten. Har lagts till i version 1.13.0.

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

Parametrar

path

string

WebSocket-sökvägen till meddelandet

payload

string | ArrayBuffer

Nyttolasten för meddelandet. Det här är en json-sträng eller en ArrayBuffer.

success

() => void

Ett återanrop för att indikera att det lyckades.

error

(error: string) => void

Ett återanrop för att indikera ett fel.

setMessageProperty(string, string, string | object)

Lägger till en parameter i ett meddelande i tjänsten. Har lagts till i version 1.12.1.

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

Parametrar

path

string

Sökvägen till nätverksmeddelandet.

propertyName

string

Namnet på egenskapen

propertyValue

string | object

Värdet för egenskapen. Det här är en json-sträng.