Class Connection

  • Artikel 
class Connection
  : public std::enable_shared_from_this< Connection >

Connection ist eine Proxyklasse zum Verwalten der Verbindung mit dem Sprachdienst der angegebenen Erkennung. Standardmäßig verwaltet eine Erkennung die Verbindung mit dem Dienst bei Bedarf autonom. Die Connection-Klasse stellt zusätzliche Methoden für Benutzer bereit, um eine Verbindung explizit zu öffnen oder zu schließen und Verbindungsänderungen status zu abonnieren. Die Verwendung von Connection ist optional. Es ist für Szenarien vorgesehen, in denen eine Feinabstimmung des Anwendungsverhaltens basierend auf der Verbindung status erforderlich ist. Benutzer können optional Open() aufrufen, um eine Dienstverbindung manuell zu initiieren, bevor sie mit der Erkennung beginnen, die dieser Verbindung zugeordnet ist. Nach dem Starten einer Erkennung schlägt der Aufruf von Open() oder Close() möglicherweise fehl. Dies wirkt sich nicht auf die Erkennung oder die laufende Erkennung aus. Die Verbindung kann aus verschiedenen Gründen getrennt werden. Die Erkennung versucht immer, die Verbindung wie erforderlich neu zu erstellen, um den laufenden Betrieb zu gewährleisten. In all diesen Fällen geben Connected/Disconnected-Ereignisse die Änderung der Verbindung status an. Aktualisiert in Version 1.17.0.

Member

Verbunden

Syntax: public EventSignal< constConnectionEventArgs & > Connected;

Das Connected-Ereignis, das angibt, dass die Erkennung mit dem Dienst verbunden ist.

Getrennt

Syntax: public EventSignal< constConnectionEventArgs & > Disconnected;

Das Disconnected-Ereignis, das angibt, dass die Erkennung vom Dienst getrennt ist.

MessageReceived

Syntax: public EventSignal< constConnectionMessageEventArgs & > MessageReceived;

Das MessageReceived-Ereignis, das angibt, dass das zugrunde liegende Protokoll eine Nachricht vom Dienst empfangen hat. In Version 1.10.0 hinzugefügt.

Öffnen

Syntax: public inline void Open ( bool forContinuousRecognition );

Beginnt mit dem Einrichten der Verbindung mit dem Dienst. Benutzer können optional Open() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor sie mit der Erkennung/Synthese auf dem Recognizer/Synthesizer beginnen, der dieser Verbindung zugeordnet ist. Nach dem Starten der Erkennung schlägt der Aufruf von Open() möglicherweise fehl, abhängig vom Prozessstatus der Erkennung/Des Synthesizers. Der Fehler wirkt sich jedoch nicht auf den Zustand des zugeordneten Erkennungs-/Synthesizers aus. Hinweis: Bei der Rückgabe ist die Verbindung möglicherweise noch nicht bereit. Abonnieren Sie das Connected-Ereignis, um benachrichtigt zu werden, wenn die Verbindung hergestellt wird.

Parameter

  • forContinuousRecognition Gibt an, ob die Verbindung für die fortlaufende Erkennung oder die Single-Shot-Erkennung verwendet wird. Es wird nicht wirksam, wenn die Verbindung über SpeechSynthsizer hergestellt wird.

Schließen

Syntax: public inline void Close ( );

Schließt die Verbindung des Diensts. Benutzer können optional Close() aufrufen, um die Verbindung des zugeordneten Recognizer/Synthesizers manuell zu schließen. Der Aufruf kann je nach Prozessstatus der Erkennung/Synthesizer fehlschlagen. Der Fehler wirkt sich jedoch nicht auf den Zustand des zugeordneten Erkennungs-/Synthesizers aus.

SetMessageProperty

Syntax: public inline void SetMessageProperty ( const std::string & path , const std::string & propertyName , const std::string & propertyValue );

Fügt einen Parameter in einer Nachricht an den Dienst an. Diese Methode funktioniert nicht für die Verbindung von SpeechSynthesizer. In Version 1.7.0 hinzugefügt.

Parameter

  • path den Nachrichtenpfad.

  • propertyName Name der Eigenschaft.

  • propertyValue Wert der Eigenschaft. Dies ist eine JSON-Zeichenfolge.

Gibt zurück

Leere.

SendMessageAsync

Syntax: public inline std::future< void > SendMessageAsync ( const std::string & path , const std::string & payload );

Senden Sie eine Nachricht an den Sprachdienst. Diese Methode funktioniert nicht für die Verbindung von SpeechSynthesizer. In Version 1.7.0 hinzugefügt.

Parameter

  • path Der Pfad der Nachricht.

  • payload Die Nutzlast der Nachricht. Dies ist eine JSON-Zeichenfolge.

Gibt zurück

Eine leere Zukunft.

SendMessageAsync

Syntax: public inline std::future< void > SendMessageAsync ( const std::string & path , uint8_t * payload , uint32_t size );

Senden sie eine binäre Nachricht an den Sprachdienst. Diese Methode funktioniert nicht für die Verbindung von SpeechSynthesizer. In Version 1.10.0 hinzugefügt.

Parameter

  • path Der Pfad der Nachricht.

  • payload Die binäre Nutzlast der Nachricht.

  • size Die Größe der binären Nutzlast.

Gibt zurück

Eine leere Zukunft.

Verbindung

Syntax: public inline explicit Connection ( SPXCONNECTIONHANDLE handle );

Interner Konstruktor. Erstellt mithilfe des bereitgestellten Handles eine neue instance.

Parameter

  • handle Das Verbindungshandle.

~Verbindung

Syntax: public inline ~Connection ( );

Destruktor.

FromRecognizer

Syntax: public inline static std::shared_ptr< Connection > FromRecognizer ( std::shared_ptr< Recognizer > recognizer );

Ruft die Verbindungs-instance von der angegebenen Erkennung ab.

Parameter

  • recognizer Die der Verbindung zugeordnete Erkennung.

Gibt zurück

Die Verbindungs-instance der Erkennung.

FromConversationTranslator

Syntax: public inline static std::shared_ptr< Connection > FromConversationTranslator ( std::shared_ptr< Transcription::ConversationTranslator > convTrans );

Ruft den Verbindungs-instance aus dem angegebenen Konversationsübersetzer ab.

Parameter

  • convTrans Der konversationsübersetzer, der der Verbindung zugeordnet ist.

Gibt zurück

Die Verbindungs-instance des Konversationsübersetzungsprogramms.

FromDialogServiceConnector

Syntax: public inline static std::shared_ptr< Connection > FromDialogServiceConnector ( std::shared_ptr< Dialog::DialogServiceConnector > dialogServiceConnector );

Ruft die Verbindungs-instance aus dem angegebenen Dialogdienstconnector ab, der zum Beobachten und Verwalten der Verbindung und Trennung vom Sprachdienst verwendet wird.

Parameter

  • dialogServiceConnector Der der Verbindung zugeordnete Dialogdienstconnector.

Gibt zurück

Die Verbindungs-instance des Dialogdienstconnectors.

FromSpeechSynthesizer

Syntax: public inline static std::shared_ptr< Connection > FromSpeechSynthesizer ( std::shared_ptr< SpeechSynthesizer > synthesizer );

Ruft die Verbindungs-instance aus dem angegebenen Sprachsynthesizer ab. In Version 1.17.0 hinzugefügt.

Parameter

  • synthesizer Der der Verbindung zugeordnete Sprachsynthesizer.

Gibt zurück

Die Verbindungs-instance des Sprachsynthesizers.