Connection class

Pacote:

microsoft-cognitiveservices-speech-sdk

A ligação é uma classe proxy para gerir a ligação ao serviço de voz do Reconhecedor especificado. Por predefinição, um Reconhecedor gere de forma autónoma a ligação ao serviço quando necessário. A classe Ligação fornece métodos adicionais para os utilizadores abrirem ou fecharem explicitamente uma ligação e subscreverem alterações ao estado da ligação. A utilização da Ligação é opcional e principalmente para cenários em que é necessária uma otimização do comportamento da aplicação com base no estado da ligação. Opcionalmente, os utilizadores podem chamar Open() para configurar manualmente uma ligação com antecedência antes de iniciarem o reconhecimento no Reconhecedor associado a esta Ligação. Se o Reconhecedor precisar de ligar ou desligar ao serviço, irá configurar ou encerrar a ligação de forma independente. Neste caso, a Ligação será notificada através da alteração do estado da ligação através de eventos Ligados/Desligados. Adicionado na versão 1.2.1.

Propriedades

connected	O evento Ligado para indicar que o reconhecedor está ligado ao serviço.
disconnected	O evento Desligado para indicar que o reconhecedor está desligado do serviço.
messageReceived	Qualquer mensagem recebida do Serviço de Voz.
messageSent	Qualquer mensagem enviada para o Serviço de Voz.
receivedServiceMessage	Qualquer mensagem do serviço que não esteja a ser processada por outros reconhecedores de nível superior. Será removido na 2.0.

Métodos

close()	Eliminar recursos associados.
closeConnection(() => void, (error: string) => void)	Fecha a ligação do serviço. Opcionalmente, os utilizadores podem chamar closeConnection() para encerrar manualmente a ligaçã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 Ligação do reconhecedor especificado.
fromSynthesizer(SpeechSynthesizer)	Obtém a Instância de ligação do sintetizador especificado.
openConnection(() => void, (error: string) => void)	Começa a configurar a ligação ao serviço. Opcionalmente, os utilizadores podem chamar openConnection() para configurar manualmente uma ligação com antecedência antes de iniciarem o reconhecimento no Reconhecedor associado a esta Ligação. Após iniciar o reconhecimento, chamar Open() não terá qualquer efeito Nota: na devolução, a ligação poderá ainda não estar pronta. Subscreva o evento Ligado para ser notificado quando a ligação for estabelecida.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Envia uma mensagem para o serviço de voz. Adicionado na versão 1.13.0.
setMessageProperty(string, string, string | object)	Acrescenta um parâmetro numa mensagem ao serviço. Adicionado na versão 1.12.1.

Detalhes de Propriedade

connected

O evento Ligado para indicar que o reconhecedor está ligado ao serviço.

connected: (args: ConnectionEventArgs) => void

Valor de Propriedade

(args: ConnectionEventArgs) => void

disconnected

O evento Desligado para indicar que o reconhecedor está desligado do serviço.

disconnected: (args: ConnectionEventArgs) => void

Valor de Propriedade

(args: ConnectionEventArgs) => void

messageReceived

Qualquer mensagem recebida do Serviço de Voz.

messageReceived: (args: ConnectionMessageEventArgs) => void

Valor de Propriedade

(args: ConnectionMessageEventArgs) => void

messageSent

Qualquer mensagem enviada para o Serviço de Voz.

messageSent: (args: ConnectionMessageEventArgs) => void

Valor de Propriedade

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Qualquer mensagem do serviço que não esteja a ser processada por outros reconhecedores de nível superior.

Será removido na 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Valor de Propriedade

(args: ServiceEventArgs) => void

Detalhes de Método

close()

Eliminar recursos associados.

function close()

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

Fecha a ligação do serviço. Opcionalmente, os utilizadores podem chamar closeConnection() para encerrar manualmente a ligaçã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 Ligação do reconhecedor especificado.

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

Parâmetros

recognizer

Recognizer | ConversationTranscriber

O reconhecedor associado à ligação.

Devoluções

Connection

A instância de Ligação do reconhecedor.

fromSynthesizer(SpeechSynthesizer)

Obtém a Instância de ligação do sintetizador especificado.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parâmetros

synthesizer

SpeechSynthesizer

O sintetizador associado à ligação.

Devoluções

Connection

A instância de Ligação do sintetizador.

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

Começa a configurar a ligação ao serviço. Opcionalmente, os utilizadores podem chamar openConnection() para configurar manualmente uma ligação com antecedência antes de iniciarem o reconhecimento no Reconhecedor associado a esta Ligação. Após iniciar o reconhecimento, chamar Open() não terá qualquer efeito

Nota: na devolução, a ligação poderá ainda não estar pronta. Subscreva o evento Ligado para ser notificado quando a ligaçã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 voz. 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

O payload da mensagem. Esta é uma cadeia de json ou uma MatrizBuffer.

success

() => void

Uma chamada de retorno para indicar êxito.

error

(error: string) => void

Uma chamada de retorno para indicar um erro.

setMessageProperty(string, string, string | object)

Acrescenta um parâmetro numa 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 json.