Compartir a través de

Connection class

  • Referencia
Paquete:
microsoft-cognitiveservices-speech-sdk

Connection es una clase de proxy para administrar la conexión al servicio de voz del reconocedor especificado. De forma predeterminada, un reconocedor administra de forma autónoma la conexión al servicio cuando sea necesario. La clase Connection proporciona métodos adicionales para que los usuarios abran o cierren explícitamente una conexión y se suscriba a los cambios de estado de conexión. El uso de Connection es opcional y principalmente para escenarios en los que se necesita un ajuste preciso del comportamiento de la aplicación en función del estado de conexión. Opcionalmente, los usuarios pueden llamar a Open() para configurar manualmente una conexión de antemano antes de iniciar el reconocimiento en el reconocedor asociado a esta conexión. Si Recognizer necesita conectarse o desconectarse al servicio, configurará o apagará la conexión de forma independiente. En este caso, el cambio de estado de la conexión se notificará a través de eventos conectados o desconectados. Se agregó en la versión 1.2.1.

Propiedades

connected

Evento Connected para indicar que el reconocedor está conectado al servicio.
disconnected

Evento Disconnected para indicar que el reconocedor está desconectado del servicio.
messageReceived

Cualquier mensaje recibido del servicio voz.
messageSent

Cualquier mensaje enviado al servicio voz.
receivedServiceMessage

Cualquier mensaje del servicio que no esté procesando ningún otro reconocedor de nivel superior.

Se quitará en la versión 2.0.

Métodos

close()

Elimine los recursos asociados.
closeConnection(() => void, (error: string) => void)

Cierra la conexión del servicio. Opcionalmente, los usuarios pueden llamar a closeConnection() para apagar manualmente la conexión del reconocedor asociado.

Si se llama a closeConnection() durante el reconocimiento, se producirá un error en el reconocimiento y se cancelará con un error.
fromRecognizer(Recognizer | ConversationTranscriber)

Obtiene la instancia de Connection del reconocedor especificado.
fromSynthesizer(SpeechSynthesizer)

Obtiene la instancia de Connection del sintetizador especificado.
openConnection(() => void, (error: string) => void)

Comienza a configurar la conexión al servicio. Opcionalmente, los usuarios pueden llamar a openConnection() para configurar manualmente una conexión de antemano antes de iniciar el reconocimiento en el reconocedor asociado a esta conexión. Después de iniciar el reconocimiento, llamar a Open() no tendrá ningún efecto.

Nota: Al devolver, es posible que la conexión aún no esté lista. Suscríbase al evento Connected para recibir una notificación cuando se establezca la conexión.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)

Envía un mensaje al servicio de voz. Se agregó en la versión 1.13.0.
setMessageProperty(string, string, string | object)

Anexa un parámetro de un mensaje al servicio. Se agregó en la versión 1.12.1.

Detalles de las propiedades

connected

Evento Connected para indicar que el reconocedor está conectado al servicio.

connected: (args: ConnectionEventArgs) => void

Valor de propiedad

(args: ConnectionEventArgs) => void

disconnected

Evento Disconnected para indicar que el reconocedor está desconectado del servicio.

disconnected: (args: ConnectionEventArgs) => void

Valor de propiedad

(args: ConnectionEventArgs) => void

messageReceived

Cualquier mensaje recibido del servicio voz.

messageReceived: (args: ConnectionMessageEventArgs) => void

Valor de propiedad

(args: ConnectionMessageEventArgs) => void

messageSent

Cualquier mensaje enviado al servicio voz.

messageSent: (args: ConnectionMessageEventArgs) => void

Valor de propiedad

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Cualquier mensaje del servicio que no esté procesando ningún otro reconocedor de nivel superior.

Se quitará en la versión 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Valor de propiedad

(args: ServiceEventArgs) => void

Detalles del método

close()

Elimine los recursos asociados.

function close()

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

Cierra la conexión del servicio. Opcionalmente, los usuarios pueden llamar a closeConnection() para apagar manualmente la conexión del reconocedor asociado.

Si se llama a closeConnection() durante el reconocimiento, se producirá un error en el reconocimiento y se cancelará con un error.

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

Parámetros

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Obtiene la instancia de Connection del reconocedor especificado.

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

Parámetros

recognizer

Recognizer | ConversationTranscriber

Reconocedor asociado a la conexión.

Devoluciones

Connection

Instancia de connection del reconocedor.

fromSynthesizer(SpeechSynthesizer)

Obtiene la instancia de Connection del sintetizador especificado.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parámetros

synthesizer
SpeechSynthesizer

Sintetizador asociado a la conexión.

Devoluciones

Connection

Instancia de connection del sintetizador.

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

Comienza a configurar la conexión al servicio. Opcionalmente, los usuarios pueden llamar a openConnection() para configurar manualmente una conexión de antemano antes de iniciar el reconocimiento en el reconocedor asociado a esta conexión. Después de iniciar el reconocimiento, llamar a Open() no tendrá ningún efecto.

Nota: Al devolver, es posible que la conexión aún no esté lista. Suscríbase al evento Connected para recibir una notificación cuando se establezca la conexión.

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

Parámetros

cb

() => void

err

(error: string) => void

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

Envía un mensaje al servicio de voz. Se agregó en la versión 1.13.0.

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

Parámetros

path

string

Ruta de acceso de WebSocket del mensaje

payload

string | ArrayBuffer

La carga del mensaje. Se trata de una cadena JSON o un objeto ArrayBuffer.

success

() => void

Devolución de llamada para indicar que se ha realizado correctamente.

error

(error: string) => void

Devolución de llamada para indicar un error.

setMessageProperty(string, string, string | object)

Anexa un parámetro de un mensaje al servicio. Se agregó en la versión 1.12.1.

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

Parámetros

path

string

Ruta de acceso del mensaje de red.

propertyName

string

Nombre de la propiedad

propertyValue

string | object

Valor de la propiedad. Se trata de una cadena json.