Connection class

Balíček:

microsoft-cognitiveservices-speech-sdk

Připojení je třída proxy pro správu připojení ke službě Speech zadaného rozpoznávání. Ve výchozím nastavení služba Recognizer 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í připojení je volitelné a hlavně pro scénáře, ve kterých je potřeba jemně doladit chování aplikace na základě stavu připojení. Uživatelé můžou volitelně volat Open() a ručně nastavit připojení předem před zahájením rozpoznávání v nástroji Recognizer přidruženém k tomuto připojení. Pokud se služba Recognizer potřebuje připojit nebo odpojit ke službě, nastaví nebo vypne připojení nezávisle. V takovém případě bude připojení upozorněno změnou stavu připojení prostřednictvím událostí Připojeno/Odpojeno. Přidáno ve verzi 1.2.1.

Vlastnosti

connected	Událost Connected (Připojeno) značí, že je rozpoznávání připojeno ke službě.
disconnected	Odpojená událost označující, že je rozpoznávatel odpojen od služby.
messageReceived	Všechny zprávy přijaté ze služby Speech
messageSent	Všechny zprávy odeslané do služby Speech
receivedServiceMessage	Jakákoli zpráva ze služby, kterou nezpracovávají ostatní rozpoznávatelé nejvyšší úrovně. Odebere se ve verzi 2.0.

Metody

close()	Vyřaďte přidružené prostředky.
closeConnection(() => void, (error: string) => void)	Ukončí připojení služby. Uživatelé můžou volitelně volat closeConnection() a ručně vypnout připojení přidruženého rozpoznávání. Pokud se při rozpoznávání volá closeConnection(), rozpoznávání selže a zruší se chybou.
fromRecognizer(Recognizer | ConversationTranscriber)	Získá instanci připojení ze zadaného rozpoznávatele.
fromSynthesizer(SpeechSynthesizer)	Získá connection instance ze zadané syntetizátoru.
openConnection(() => void, (error: string) => void)	Spustí se nastavení připojení ke službě. Uživatelé můžou volitelně volat openConnection() a ručně nastavit připojení předem před zahájením rozpoznávání v nástroji Recognizer 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: Při návratu nemusí být připojení ještě připravené. Přihlaste se k odběru události Připojeno, abyste byli upozorněni při navázání připojení.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Odešle zprávu do služby 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 (Připojeno) značí, že je rozpoznávání připojeno ke službě.

connected: (args: ConnectionEventArgs) => void

Hodnota vlastnosti

(args: ConnectionEventArgs) => void

disconnected

Odpojená událost označující, ž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

Všechny zprávy odeslané do služby Speech

messageSent: (args: ConnectionMessageEventArgs) => void

Hodnota vlastnosti

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Jakákoli zpráva ze služby, kterou nezpracovávají ostatní rozpoznávatelé nejvyšší úrovně.

Odebere se ve verzi 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)

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

Pokud se při rozpoznávání volá closeConnection(), rozpoznávání selže a zruší se 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ávatele.

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

Parametry

recognizer

Recognizer | ConversationTranscriber

Rozpoznač přidružený k připojení.

Návraty

Connection

Instance připojení rozpoznávatele.

fromSynthesizer(SpeechSynthesizer)

Získá connection instance ze zadané syntetizátoru.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parametry

synthesizer

SpeechSynthesizer

Syntetizátor spojený s připojením.

Návraty

Connection

Instance připojení syntetizátoru.

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

Spustí se nastavení připojení ke službě. Uživatelé můžou volitelně volat openConnection() a ručně nastavit připojení předem před zahájením rozpoznávání v nástroji Recognizer 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: Při návratu nemusí být připojení ještě připravené. Přihlaste se k odběru události Připojeno, abyste byli upozorněni při 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 do služby 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. Jedná se o řetězec JSON nebo ArrayBuffer.

success

() => void

Zpětné volání, které značí ú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 k síťové zprávě.

propertyName

string

Název vlastnosti

propertyValue

string | object

Hodnota vlastnosti. Jedná se o řetězec JSON.