Connection class

Paquet:

microsoft-cognitiveservices-speech-sdk

La connexion est une classe proxy pour la gestion de la connexion au service speech du module Recognizer spécifié. Par défaut, un Recognizer gère de manière autonome la connexion au service si nécessaire. La classe Connection fournit des méthodes supplémentaires pour permettre aux utilisateurs d’ouvrir ou de fermer explicitement une connexion et de s’abonner aux modifications d’état de connexion. L’utilisation de la connexion est facultative et principalement pour les scénarios où le réglage précis du comportement de l’application en fonction de l’état de la connexion est nécessaire. Les utilisateurs peuvent éventuellement appeler Open() pour configurer manuellement une connexion à l’avance avant de commencer la reconnaissance sur le module Recognizer associé à cette connexion. Si recognizer doit se connecter ou se déconnecter du service, il configure ou arrête la connexion indépendamment. Dans ce cas, la connexion sera avertie par le changement d’état de connexion via les événements connectés/déconnectés. Ajouté dans la version 1.2.1.

Propriétés

connected	Événement connecté pour indiquer que le module de reconnaissance est connecté au service.
disconnected	Événement déconnecté pour indiquer que le module de reconnaissance est déconnecté du service.
messageReceived	Tout message reçu du service Speech.
messageSent	Tout message envoyé au service Speech.
receivedServiceMessage	Tout message du service qui n’est pas traité par d’autres modules de reconnaissance de niveau supérieur. Sera supprimé dans la version 2.0.

Méthodes

close()	Supprimez les ressources associées.
closeConnection(() => void, (error: string) => void)	Ferme la connexion au service. Les utilisateurs peuvent éventuellement appeler closeConnection() pour arrêter manuellement la connexion du module Recognizer associé. Si closeConnection() est appelé pendant la reconnaissance, la reconnaissance échoue et s’annule avec une erreur.
fromRecognizer(Recognizer | ConversationTranscriber)	Obtient l’instance de connexion à partir du module de reconnaissance spécifié.
fromSynthesizer(SpeechSynthesizer)	Obtient l’instance de connexion à partir du synthétiseur spécifié.
openConnection(() => void, (error: string) => void)	Commence à configurer la connexion au service. Les utilisateurs peuvent éventuellement appeler openConnection() pour configurer manuellement une connexion à l’avance avant de commencer la reconnaissance sur le module Recognizer associé à cette connexion. Après avoir démarré la reconnaissance, l’appel d’Open() n’aura aucun effet Remarque : Lors du retour, la connexion n’est peut-être pas encore prête. Veuillez vous abonner à l’événement Connecté pour être averti lorsque la connexion est établie.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Envoie un message au service speech. Ajouté dans la version 1.13.0.
setMessageProperty(string, string, string | object)	Ajoute un paramètre dans un message au service. Ajouté dans la version 1.12.1.

Détails de la propriété

connected

Événement connecté pour indiquer que le module de reconnaissance est connecté au service.

connected: (args: ConnectionEventArgs) => void

Valeur de propriété

(args: ConnectionEventArgs) => void

disconnected

Événement déconnecté pour indiquer que le module de reconnaissance est déconnecté du service.

disconnected: (args: ConnectionEventArgs) => void

Valeur de propriété

(args: ConnectionEventArgs) => void

messageReceived

Tout message reçu du service Speech.

messageReceived: (args: ConnectionMessageEventArgs) => void

Valeur de propriété

(args: ConnectionMessageEventArgs) => void

messageSent

Tout message envoyé au service Speech.

messageSent: (args: ConnectionMessageEventArgs) => void

Valeur de propriété

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Tout message du service qui n’est pas traité par d’autres modules de reconnaissance de niveau supérieur.

Sera supprimé dans la version 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Valeur de propriété

(args: ServiceEventArgs) => void

Détails de la méthode

close()

Supprimez les ressources associées.

function close()

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

Ferme la connexion au service. Les utilisateurs peuvent éventuellement appeler closeConnection() pour arrêter manuellement la connexion du module Recognizer associé.

Si closeConnection() est appelé pendant la reconnaissance, la reconnaissance échoue et s’annule avec une erreur.

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

Paramètres

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Obtient l’instance de connexion à partir du module de reconnaissance spécifié.

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

Paramètres

recognizer

Recognizer | ConversationTranscriber

Module de reconnaissance associé à la connexion.

Retours

Connection

Instance de connexion du module de reconnaissance.

fromSynthesizer(SpeechSynthesizer)

Obtient l’instance de connexion à partir du synthétiseur spécifié.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Paramètres

synthesizer

SpeechSynthesizer

Synthétiseur associé à la connexion.

Retours

Connection

Instance de connexion du synthétiseur.

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

Commence à configurer la connexion au service. Les utilisateurs peuvent éventuellement appeler openConnection() pour configurer manuellement une connexion à l’avance avant de commencer la reconnaissance sur le module Recognizer associé à cette connexion. Après avoir démarré la reconnaissance, l’appel d’Open() n’aura aucun effet

Remarque : Lors du retour, la connexion n’est peut-être pas encore prête. Veuillez vous abonner à l’événement Connecté pour être averti lorsque la connexion est établie.

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

Paramètres

cb

() => void

err

(error: string) => void

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

Envoie un message au service speech. Ajouté dans la version 1.13.0.

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

Paramètres

path

string

Chemin d’accès WebSocket du message

payload

string | ArrayBuffer

Charge utile du message. Il s’agit d’une chaîne json ou d’un ArrayBuffer.

success

() => void

Rappel pour indiquer la réussite.

error

(error: string) => void

Rappel pour indiquer une erreur.

setMessageProperty(string, string, string | object)

Ajoute un paramètre dans un message au service. Ajouté dans la version 1.12.1.

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

Paramètres

path

string

Chemin d’accès du message réseau.

propertyName

string

Nom de la propriété

propertyValue

string | object

Valeur de la propriété. Il s’agit d’une chaîne json.