Подключение класса

class Connection
  : public std::enable_shared_from_this< Connection >

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

Члены

Подключено

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

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

Отключен

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

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

MessageReceived

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

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

Откройте

Синтаксис: 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 );

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

Параметры

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

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

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

Возвраты

пустота.

SendMessageAsync

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

Отправьте сообщение службе распознавания речи. Добавлено в версию 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 );

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

Параметры

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

Возвраты

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

FromConversationTranslator

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

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

Параметры

• 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 );

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

Параметры

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

Возвраты

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