Connection class

Balíček:

microsoft-cognitiveservices-speech-sdk

Připojení je třída proxy pro správu připojení k řečové službě zadaného rozpoznávání. Rozpoznávání ve výchozím nastavení v případě potřeby samostatně spravuje připojení ke službě. Třída Connection poskytuje uživatelům další metody, jak explicitně otevřít nebo zavřít připojení a přihlásit se k odběru změn stavu připojení. Použití funkce Připojení je volitelné, a to hlavně ve scénářích, kdy je potřeba jemně doladit chování aplikace na základě stavu připojení. Uživatelé můžou volitelně volat Open(), aby předem ručně nastavili připojení před zahájením rozpoznávání v rozpoznávání přidruženém k tomuto připojení. Pokud se rozpoznávání potřebuje připojit nebo odpojit ke službě, nastaví nebo vypne připojení nezávisle na sobě. V takovém případě bude připojení upozorněno na změnu stavu připojení prostřednictvím událostí Připojeno/Odpojeno. Přidáno ve verzi 1.2.1.

Vlastnosti

connected	Událost Connected označuje, že je rozpoznávatel připojen ke službě.
disconnected	Událost Odpojeno, která označuje, že je rozpoznávatel odpojený od služby.
messageReceived	Všechny zprávy přijaté ze služby Speech
messageSent	Jakákoli zpráva odeslaná do služby Speech
receivedServiceMessage	Všechny zprávy ze služby, které nezpracovávají žádné jiné rozpoznávatele nejvyšší úrovně. Odebere se ve 2.0.

Metody

close()	Vyřaďte přidružené prostředky.
closeConnection(() => void, (error: string) => void)	Zavře připojení ke službě. Uživatelé můžou volitelně volat closeConnection() a ručně vypnout připojení přidruženého rozpoznávání. Pokud je během rozpoznávání volána funkce closeConnection(), rozpoznávání se nezdaří a zruší se s chybou.
fromRecognizer(Recognizer | ConversationTranscriber)	Získá instanci připojení ze zadaného rozpoznávání.
fromSynthesizer(SpeechSynthesizer)	Získá instanci připojení ze zadaného syntezátoru.
openConnection(() => void, (error: string) => void)	Začne nastavovat připojení ke službě. Uživatelé můžou volitelně volat openConnection(), aby předem ručně nastavili připojení před zahájením rozpoznávání na rozpoznávacím nástroji přidruženém k tomuto připojení. Po spuštění rozpoznávání nebude mít volání Open() žádný vliv. Poznámka: Po návratu nemusí být připojení ještě připravené. Přihlaste se k odběru připojené události, abyste byli upozorněni na navázání připojení.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Odešle zprávu službě speech. Přidáno ve verzi 1.13.0.
setMessageProperty(string, string, string | object)	Připojí parametr ve zprávě ke službě. Přidáno ve verzi 1.12.1.

Podrobnosti vlastnosti

connected

Událost Connected označuje, že je rozpoznávatel připojen ke službě.

connected: (args: ConnectionEventArgs) => void

Hodnota vlastnosti

(args: ConnectionEventArgs) => void

disconnected

Událost Odpojeno, která označuje, že je rozpoznávatel odpojený od služby.

disconnected: (args: ConnectionEventArgs) => void

Hodnota vlastnosti

(args: ConnectionEventArgs) => void

messageReceived

Všechny zprávy přijaté ze služby Speech

messageReceived: (args: ConnectionMessageEventArgs) => void

Hodnota vlastnosti

(args: ConnectionMessageEventArgs) => void

messageSent

Jakákoli zpráva odeslaná do služby Speech

messageSent: (args: ConnectionMessageEventArgs) => void

Hodnota vlastnosti

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Všechny zprávy ze služby, které nezpracovávají žádné jiné rozpoznávatele nejvyšší úrovně.

Odebere se ve 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Hodnota vlastnosti

(args: ServiceEventArgs) => void

Podrobnosti metody

close()

Vyřaďte přidružené prostředky.

function close()

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

Zavře připojení ke službě. Uživatelé můžou volitelně volat closeConnection() a ručně vypnout připojení přidruženého rozpoznávání.

Pokud je během rozpoznávání volána funkce closeConnection(), rozpoznávání se nezdaří a zruší se s chybou.

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

Parametry

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Získá instanci připojení ze zadaného rozpoznávání.

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

Parametry

recognizer

Recognizer | ConversationTranscriber

Rozpoznávatel přidružený k připojení.

Návraty

Connection

Instance připojení rozpoznávatele.

fromSynthesizer(SpeechSynthesizer)

Získá instanci připojení ze zadaného syntezátoru.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parametry

synthesizer

SpeechSynthesizer

Syntezátor přidružený k připojení.

Návraty

Connection

Instance připojení syntezátoru.

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

Začne nastavovat připojení ke službě. Uživatelé můžou volitelně volat openConnection(), aby předem ručně nastavili připojení před zahájením rozpoznávání na rozpoznávacím nástroji přidruženém k tomuto připojení. Po spuštění rozpoznávání nebude mít volání Open() žádný vliv.

Poznámka: Po návratu nemusí být připojení ještě připravené. Přihlaste se k odběru připojené události, abyste byli upozorněni na navázání připojení.

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

Parametry

cb

() => void

err

(error: string) => void

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

Odešle zprávu službě speech. Přidáno ve verzi 1.13.0.

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

Parametry

path

string

Cesta WebSocket zprávy

payload

string | ArrayBuffer

Datová část zprávy. Toto je řetězec json nebo ArrayBuffer.

success

() => void

Zpětné volání označující úspěch.

error

(error: string) => void

Zpětné volání označující chybu.

setMessageProperty(string, string, string | object)

Připojí parametr ve zprávě ke službě. Přidáno ve verzi 1.12.1.

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

Parametry

path

string

Cesta síťové zprávy.

propertyName

string

Název vlastnosti

propertyValue

string | object

Hodnota vlastnosti Toto je řetězec json.