Connection class

Pacote:

microsoft-cognitiveservices-speech-sdk

Connection é uma classe proxy para gerenciar a conexão com o serviço de fala do Reconhecedor especificado. Por padrão, um Reconhecedor gerencia de forma autônoma a conexão com o serviço quando necessário. A classe Connection fornece métodos adicionais para que os usuários abram ou fechem explicitamente uma conexão e assinem as alterações de status da conexão. O uso de Connection é opcional e, principalmente, para cenários em que o ajuste fino do comportamento do aplicativo com base no status da conexão é necessário. Opcionalmente, os usuários podem chamar Open() para configurar manualmente uma conexão com antecedência antes de iniciar o reconhecimento no Reconhecedor associado a essa Conexão. Se o Reconhecedor precisar se conectar ou desconectar ao serviço, ele configurará ou desligará a conexão de forma independente. Nesse caso, a Conexão será notificada pela alteração do status da conexão por meio de eventos Conectados/Desconectados. Adicionado na versão 1.2.1.

Propriedades

connected	O evento Connected para indicar que o reconhecedor está conectado ao serviço.
disconnected	O evento Disconnected para indicar que o reconhecedor está desconectado do serviço.
messageReceived	Qualquer mensagem recebida do Serviço de Fala.
messageSent	Qualquer mensagem enviada ao Serviço de Fala.
receivedServiceMessage	Qualquer mensagem do serviço que não esteja sendo processada por nenhum outro reconhecedor de nível superior. Será removido na versão 2.0.

Métodos

close()	Descarte os recursos associados.
closeConnection(() => void, (error: string) => void)	Fecha a conexão do serviço. Opcionalmente, os usuários podem chamar closeConnection() para desligar manualmente a conexão do Reconhecedor associado. Se closeConnection() for chamado durante o reconhecimento, o reconhecimento falhará e cancelará com um erro.
fromRecognizer(Recognizer | ConversationTranscriber)	Obtém a instância de Conexão do reconhecedor especificado.
fromSynthesizer(SpeechSynthesizer)	Obtém a instância de Conexão do sintetizador especificado.
openConnection(() => void, (error: string) => void)	Começa a configurar a conexão com o serviço. Opcionalmente, os usuários podem chamar openConnection() para configurar manualmente uma conexão com antecedência antes de iniciar o reconhecimento no Reconhecedor associado a essa Conexão. Depois de iniciar o reconhecimento, chamar Open() não terá efeito Observação: no retorno, a conexão pode não estar pronta ainda. Assine o evento Connected para ser notificado quando a conexão for estabelecida.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Envia uma mensagem para o serviço de fala. Adicionado na versão 1.13.0.
setMessageProperty(string, string, string | object)	Acrescenta um parâmetro em uma mensagem ao serviço. Adicionado na versão 1.12.1.

Detalhes da propriedade

connected

O evento Connected para indicar que o reconhecedor está conectado ao serviço.

connected: (args: ConnectionEventArgs) => void

Valor da propriedade

(args: ConnectionEventArgs) => void

disconnected

O evento Disconnected para indicar que o reconhecedor está desconectado do serviço.

disconnected: (args: ConnectionEventArgs) => void

Valor da propriedade

(args: ConnectionEventArgs) => void

messageReceived

Qualquer mensagem recebida do Serviço de Fala.

messageReceived: (args: ConnectionMessageEventArgs) => void

Valor da propriedade

(args: ConnectionMessageEventArgs) => void

messageSent

Qualquer mensagem enviada ao Serviço de Fala.

messageSent: (args: ConnectionMessageEventArgs) => void

Valor da propriedade

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Qualquer mensagem do serviço que não esteja sendo processada por nenhum outro reconhecedor de nível superior.

Será removido na versão 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Valor da propriedade

(args: ServiceEventArgs) => void

Detalhes do método

close()

Descarte os recursos associados.

function close()

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

Fecha a conexão do serviço. Opcionalmente, os usuários podem chamar closeConnection() para desligar manualmente a conexão do Reconhecedor associado.

Se closeConnection() for chamado durante o reconhecimento, o reconhecimento falhará e cancelará com um erro.

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

Parâmetros

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Obtém a instância de Conexão do reconhecedor especificado.

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

Parâmetros

recognizer

Recognizer | ConversationTranscriber

O reconhecedor associado à conexão.

Retornos

Connection

A instância de Conexão do reconhecedor.

fromSynthesizer(SpeechSynthesizer)

Obtém a instância de Conexão do sintetizador especificado.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parâmetros

synthesizer

SpeechSynthesizer

O sintetizador associado à conexão.

Retornos

Connection

A instância de Conexão do sintetizador.

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

Começa a configurar a conexão com o serviço. Opcionalmente, os usuários podem chamar openConnection() para configurar manualmente uma conexão com antecedência antes de iniciar o reconhecimento no Reconhecedor associado a essa Conexão. Depois de iniciar o reconhecimento, chamar Open() não terá efeito

Observação: no retorno, a conexão pode não estar pronta ainda. Assine o evento Connected para ser notificado quando a conexão for estabelecida.

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

Parâmetros

cb

() => void

err

(error: string) => void

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

Envia uma mensagem para o serviço de fala. Adicionado na versão 1.13.0.

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

Parâmetros

path

string

O caminho WebSocket da mensagem

payload

string | ArrayBuffer

A carga da mensagem. Esta é uma cadeia de caracteres json ou um ArrayBuffer.

success

() => void

Um retorno de chamada para indicar êxito.

error

(error: string) => void

Um retorno de chamada para indicar um erro.

setMessageProperty(string, string, string | object)

Acrescenta um parâmetro em uma mensagem ao serviço. Adicionado na versão 1.12.1.

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

Parâmetros

path

string

O caminho da mensagem de rede.

propertyName

string

Nome da propriedade

propertyValue

string | object

Valor da propriedade. Esta é uma cadeia de caracteres json.