Class Connection

  • Статья 
class Connection
  : public std::enable_shared_from_this< Connection >

Connection — это прокси-класс для управления подключением к службе распознавания речи указанного Распознавателя. По умолчанию Распознаватель автономно управляет подключением к службе при необходимости. Класс Connection предоставляет пользователям дополнительные методы для явного открытия или закрытия подключения, а также для подписки на изменения состояния подключения. Использование параметра Connection является необязательным. Он предназначен для сценариев, в которых требуется точная настройка поведения приложения на основе состояния подключения. При необходимости пользователи могут вызвать Open(), чтобы вручную инициировать подключение к службе перед запуском распознавания в Распознавателье, связанном с этим подключением. После запуска распознавания вызов Open() или Close() может завершиться ошибкой. Это не повлияет на Распознаватель или текущее распознавание. По разным причинам подключение может прервать. Распознаватель всегда будет пытаться повторно установить подключение по мере необходимости, чтобы гарантировать выполнение текущих операций. Во всех этих случаях события Connected/Disconnected указывают на изменение состояния подключения. Обновлено в версии 1.17.0.

Элементы

Подключен

Синтаксис: public EventSignal< constConnectionEventArgs & > Connected;

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

Отключен

Синтаксис: public EventSignal< constConnectionEventArgs & > Disconnected;

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

MessageReceived

Синтаксис: public EventSignal< constConnectionMessageEventArgs & > MessageReceived;

Событие MessageReceived, указывающее, что базовый протокол получил сообщение от службы. Добавлено в версии 1.10.0.

Open

Синтаксис: public inline void Open ( bool forContinuousRecognition );

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

Параметры

  • forContinuousRecognition Указывает, используется ли соединение для непрерывного распознавания или однократного распознавания. Оно не действует, если подключение осуществляется из SpeechSynthsizer.

Закрыть

Синтаксис: public inline void Close ( );

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

SetMessageProperty

Синтаксис: public inline void SetMessageProperty ( const std::string & path , const std::string & propertyName , const std::string & propertyValue );

Добавляет параметр в сообщении в службу. Этот метод не работает для подключения SpeechSynthesizer. Добавлено в версии 1.7.0.

Параметры

  • path Путь к сообщению.

  • propertyName Имя свойства.

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

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

Void.

SendMessageAsync

Синтаксис: public inline std::future< void > SendMessageAsync ( const std::string & path , const std::string & payload );

Отправка сообщения в службу распознавания речи. Этот метод не работает для подключения SpeechSynthesizer. Добавлено в версии 1.7.0.

Параметры

  • path Путь к сообщению.

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

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

Пустое будущее.

SendMessageAsync

Синтаксис: public inline std::future< void > SendMessageAsync ( const std::string & path , uint8_t * payload , uint32_t size );

Отправка двоичного сообщения в службу распознавания речи. Этот метод не работает для подключения SpeechSynthesizer. Добавлено в версии 1.10.0.

Параметры

  • path Путь к сообщению.

  • payload Двоичные полезные данные сообщения.

  • size Размер двоичных полезных данных.

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

Пустое будущее.

Подключение

Синтаксис: public inline explicit Connection ( SPXCONNECTIONHANDLE handle );

Внутренний конструктор. Создает новый экземпляр с помощью предоставленного дескриптора.

Параметры

  • handle Дескриптор подключения.

~Подключения

Синтаксис: public inline ~Connection ( );

Деструктор.

FromRecognizer

Синтаксис: public inline static std::shared_ptr< Connection > FromRecognizer ( std::shared_ptr< Recognizer > recognizer );

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

Параметры

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

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

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

FromConversationTranslator

Синтаксис: public inline static std::shared_ptr< Connection > FromConversationTranslator ( std::shared_ptr< Transcription::ConversationTranslator > convTrans );

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

Параметры

  • convTrans Переводчик бесед, связанный с подключением.

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

Экземпляр Подключения переводчика бесед.

FromDialogServiceConnector

Синтаксис: public inline static std::shared_ptr< Connection > FromDialogServiceConnector ( std::shared_ptr< Dialog::DialogServiceConnector > dialogServiceConnector );

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

Параметры

  • dialogServiceConnector Соединитель службы диалогов, связанный с подключением.

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

Экземпляр подключения соединителя службы диалогов.

FromSpeechSynthesizer

Синтаксис: public inline static std::shared_ptr< Connection > FromSpeechSynthesizer ( std::shared_ptr< SpeechSynthesizer > synthesizer );

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

Параметры

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

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

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