Connection class

Pakket:

microsoft-cognitiveservices-speech-sdk

Verbinding is een proxyklasse voor het beheren van de verbinding met de spraakservice van de opgegeven Recognizer. Standaard beheert een Recognizer de verbinding met de service autonoom wanneer dat nodig is. De klasse Verbinding biedt gebruikers aanvullende methoden om expliciet een verbinding te openen of te sluiten en zich te abonneren op wijzigingen in de verbindingsstatus. Het gebruik van Verbinding is optioneel en vooral voor scenario's waarin het gedrag van de toepassing moet worden afgestemd op basis van de verbindingsstatus. Gebruikers kunnen optioneel Open() aanroepen om handmatig een verbinding in te stellen voordat ze de herkenning starten op de Recognizer die aan deze verbinding is gekoppeld. Als de Recognizer verbinding moet maken of de verbinding met de service moet verbreken, wordt de verbinding onafhankelijk ingesteld of afgesloten. In dit geval wordt de verbinding op de hoogte gesteld door wijziging van de verbindingsstatus via verbonden/verbroken gebeurtenissen. Toegevoegd in versie 1.2.1.

Eigenschappen

connected	De gebeurtenis Verbonden om aan te geven dat de recognizer is verbonden met de service.
disconnected	De gebeurtenis Verbinding verbroken om aan te geven dat de herkenningsfunctie is losgekoppeld van de service.
messageReceived	Elk bericht dat is ontvangen van de Speech Service.
messageSent	Elk bericht dat naar de Speech Service wordt verzonden.
receivedServiceMessage	Elk bericht van de service dat niet wordt verwerkt door andere recognizers op het hoogste niveau. Wordt verwijderd in 2.0.

Methoden

close()	Verwijder gekoppelde resources.
closeConnection(() => void, (error: string) => void)	Hiermee wordt de verbinding met de service gesloten. Gebruikers kunnen desgewenst closeConnection() aanroepen om de verbinding van de gekoppelde Recognizer handmatig te sluiten. Als closeConnection() wordt aangeroepen tijdens de herkenning, mislukt de herkenning en wordt deze geannuleerd met een fout.
fromRecognizer(Recognizer | ConversationTranscriber)	Hiermee haalt u het verbindingsexemplaren op van de opgegeven recognizer.
fromSynthesizer(SpeechSynthesizer)	Hiermee haalt u het verbindingsexemplaren op van de opgegeven synthesizer.
openConnection(() => void, (error: string) => void)	Begint met het instellen van de verbinding met de service. Gebruikers kunnen optioneel openConnection() aanroepen om vooraf handmatig een verbinding in te stellen voordat ze de herkenning starten op de Recognizer die aan deze verbinding is gekoppeld. Nadat de herkenning is gestart, heeft het aanroepen van Open() geen effect Opmerking: bij terugkomst is de verbinding mogelijk nog niet gereed. Abonneer u op de gebeurtenis Verbonden om een melding te ontvangen wanneer de verbinding tot stand is gebracht.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Hiermee wordt een bericht naar de spraakservice verzonden. Toegevoegd in versie 1.13.0.
setMessageProperty(string, string, string | object)	Hiermee voegt u een parameter toe aan een bericht aan de service. Toegevoegd in versie 1.12.1.

Eigenschapdetails

connected

De gebeurtenis Verbonden om aan te geven dat de recognizer is verbonden met de service.

connected: (args: ConnectionEventArgs) => void

Waarde van eigenschap

(args: ConnectionEventArgs) => void

disconnected

De gebeurtenis Verbinding verbroken om aan te geven dat de herkenningsfunctie is losgekoppeld van de service.

disconnected: (args: ConnectionEventArgs) => void

Waarde van eigenschap

(args: ConnectionEventArgs) => void

messageReceived

Elk bericht dat is ontvangen van de Speech Service.

messageReceived: (args: ConnectionMessageEventArgs) => void

Waarde van eigenschap

(args: ConnectionMessageEventArgs) => void

messageSent

Elk bericht dat naar de Speech Service wordt verzonden.

messageSent: (args: ConnectionMessageEventArgs) => void

Waarde van eigenschap

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Elk bericht van de service dat niet wordt verwerkt door andere recognizers op het hoogste niveau.

Wordt verwijderd in 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Waarde van eigenschap

(args: ServiceEventArgs) => void

Methodedetails

close()

Verwijder gekoppelde resources.

function close()

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

Hiermee wordt de verbinding met de service gesloten. Gebruikers kunnen desgewenst closeConnection() aanroepen om de verbinding van de gekoppelde Recognizer handmatig te sluiten.

Als closeConnection() wordt aangeroepen tijdens de herkenning, mislukt de herkenning en wordt deze geannuleerd met een fout.

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

Parameters

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Hiermee haalt u het verbindingsexemplaren op van de opgegeven recognizer.

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

Parameters

recognizer

Recognizer | ConversationTranscriber

De recognizer die is gekoppeld aan de verbinding.

Retouren

Connection

Het verbindingsexemplaren van de recognizer.

fromSynthesizer(SpeechSynthesizer)

Hiermee haalt u het verbindingsexemplaren op van de opgegeven synthesizer.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parameters

synthesizer

SpeechSynthesizer

De synthesizer die aan de verbinding is gekoppeld.

Retouren

Connection

Het Connection-exemplaar van de synthesizer.

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

Begint met het instellen van de verbinding met de service. Gebruikers kunnen optioneel openConnection() aanroepen om vooraf handmatig een verbinding in te stellen voordat ze de herkenning starten op de Recognizer die aan deze verbinding is gekoppeld. Nadat de herkenning is gestart, heeft het aanroepen van Open() geen effect

Opmerking: bij terugkomst is de verbinding mogelijk nog niet gereed. Abonneer u op de gebeurtenis Verbonden om een melding te ontvangen wanneer de verbinding tot stand is gebracht.

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

Parameters

cb

() => void

err

(error: string) => void

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

Hiermee wordt een bericht naar de spraakservice verzonden. Toegevoegd in versie 1.13.0.

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

Parameters

path

string

Het WebSocket-pad van het bericht

payload

string | ArrayBuffer

De nettolading van het bericht. Dit is een JSON-tekenreeks of een ArrayBuffer.

success

() => void

Een callback om aan te geven dat het is gelukt.

error

(error: string) => void

Een callback om een fout aan te geven.

setMessageProperty(string, string, string | object)

Hiermee voegt u een parameter toe aan een bericht aan de service. Toegevoegd in versie 1.12.1.

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

Parameters

path

string

Het pad van het netwerkbericht.

propertyName

string

Naam van de eigenschap

propertyValue

string | object

Waarde van de eigenschap. Dit is een JSON-tekenreeks.