Connection class

Пакет:

microsoft-cognitiveservices-speech-sdk

Connection — это прокси-класс для управления подключением к службе распознавания речи указанного распознавателя. По умолчанию Распознаватель автономно управляет подключением к службе при необходимости. Класс Connection предоставляет пользователям дополнительные методы для явного открытия или закрытия подключения и подписки на изменения состояния подключения. Подключение является необязательным и главным образом для сценариев, в которых требуется точная настройка поведения приложения на основе состояния подключения. При необходимости пользователи могут вызвать Open(), чтобы вручную настроить подключение, прежде чем начать распознавание распознавателя, связанного с этим подключением. Если Распознаватель должен подключиться к службе или отключиться от него, он самостоятельно настроит или завершит работу подключения. В этом случае подключение будет уведомлено об изменении состояния подключения через события "Подключено/ отключено". Добавлено в версии 1.2.1.

Свойства

connected	Событие Connected , указывающее, что распознаватель подключен к службе.
disconnected	Событие Disconnected, указывающее, что распознаватель отключен от службы.
messageReceived	Любое сообщение, полученное от службы "Речь".
messageSent	Любое сообщение, отправленное в службу "Речь".
receivedServiceMessage	Любое сообщение от службы, которое не обрабатывается другими распознавателями верхнего уровня. Будет удален в версии 2.0.

Методы

close()	Удалите связанные ресурсы.
closeConnection(() => void, (error: string) => void)	Закрывает подключение к службе. При необходимости пользователи могут вызвать closeConnection(), чтобы вручную завершить подключение связанного Распознавателя. Если метод closeConnection() вызывается во время распознавания, распознавание завершится ошибкой и отменится с ошибкой.
fromRecognizer(Recognizer | ConversationTranscriber)	Возвращает экземпляр Connection из указанного распознавателя.
fromSynthesizer(SpeechSynthesizer)	Возвращает экземпляр Connection из указанного синтезатора.
openConnection(() => void, (error: string) => void)	Начинает настройку подключения к службе. При необходимости пользователи могут вызвать openConnection(), чтобы вручную настроить подключение, прежде чем начать распознавание распознавателя, связанного с этим подключением. После запуска распознавания вызов Open() не будет действовать. Примечание. При возврате подключение может быть еще не готово. Подпишитесь на событие Connected, чтобы получать уведомления при установке подключения.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Отправляет сообщение в службу распознавания речи. Добавлено в версии 1.13.0.
setMessageProperty(string, string, string | object)	Добавляет параметр в сообщении в службу. Добавлено в версии 1.12.1.

Сведения о свойстве

connected

Событие Connected , указывающее, что распознаватель подключен к службе.

connected: (args: ConnectionEventArgs) => void

Значение свойства

(args: ConnectionEventArgs) => void

disconnected

Событие Disconnected, указывающее, что распознаватель отключен от службы.

disconnected: (args: ConnectionEventArgs) => void

Значение свойства

(args: ConnectionEventArgs) => void

messageReceived

Любое сообщение, полученное от службы "Речь".

messageReceived: (args: ConnectionMessageEventArgs) => void

Значение свойства

(args: ConnectionMessageEventArgs) => void

messageSent

Любое сообщение, отправленное в службу "Речь".

messageSent: (args: ConnectionMessageEventArgs) => void

Значение свойства

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Любое сообщение от службы, которое не обрабатывается другими распознавателями верхнего уровня.

Будет удален в версии 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Значение свойства

(args: ServiceEventArgs) => void

Сведения о методе

close()

Удалите связанные ресурсы.

function close()

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

Закрывает подключение к службе. При необходимости пользователи могут вызвать closeConnection(), чтобы вручную завершить подключение связанного Распознавателя.

Если метод closeConnection() вызывается во время распознавания, распознавание завершится ошибкой и отменится с ошибкой.

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

Параметры

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Возвращает экземпляр Connection из указанного распознавателя.

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

Параметры

recognizer

Recognizer | ConversationTranscriber

Распознаватель, связанный с соединением.

Возвращаемое значение

Connection

Экземпляр соединения распознавателя.

fromSynthesizer(SpeechSynthesizer)

Возвращает экземпляр Connection из указанного синтезатора.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Параметры

synthesizer

SpeechSynthesizer

Синтезатор, связанный с соединением.

Возвращаемое значение

Connection

Экземпляр соединения синтезатора.

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

Начинает настройку подключения к службе. При необходимости пользователи могут вызвать openConnection(), чтобы вручную настроить подключение, прежде чем начать распознавание распознавателя, связанного с этим подключением. После запуска распознавания вызов Open() не будет действовать.

Примечание. При возврате подключение может быть еще не готово. Подпишитесь на событие Connected, чтобы получать уведомления при установке подключения.

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

Параметры

cb

() => void

err

(error: string) => void

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

Отправляет сообщение в службу распознавания речи. Добавлено в версии 1.13.0.

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

Параметры

path

string

Путь WebSocket к сообщению

payload

string | ArrayBuffer

Полезные данные сообщения. Это строка JSON или ArrayBuffer.

success

() => void

Обратный вызов, указывающий на успешное выполнение.

error

(error: string) => void

Обратный вызов, указывающий на ошибку.

setMessageProperty(string, string, string | object)

Добавляет параметр в сообщении в службу. Добавлено в версии 1.12.1.

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

Параметры

path

string

Путь к сетевому сообщению.

propertyName

string

Имя свойства

propertyValue

string | object

Значение свойства. Это строка JSON.