Klassenverbindung

class Connection
  : public std::enable_shared_from_this< Connection >

Die Verbindung ist eine Proxyklasse zum Verwalten der Verbindung mit dem Sprachdienst der angegebenen Erkennung. Standardmäßig verwaltet ein Erkennungsmodul bei Bedarf die Verbindung mit dem Dienst autonom. Die Connection-Klasse bietet zusätzliche Methoden für Benutzer, um eine Verbindung explizit zu öffnen oder zu schließen und Verbindungsstatusänderungen zu abonnieren. Die Verwendung von "Connection" ist optional. Es ist für Szenarien vorgesehen, in denen eine feinabstimmung des Anwendungsverhaltens basierend auf dem Verbindungsstatus erforderlich ist. Benutzer können optional Open() aufrufen, um eine Dienstverbindung manuell zu initiieren, bevor die Erkennung für die erkennung gestartet wird, die dieser Verbindung zugeordnet ist. Nach dem Starten einer Erkennung schlägt möglicherweise ein Fehler beim Aufrufen von Open() oder Close() fehl. Dies wirkt sich nicht auf die Erkennung oder die fortlaufende Erkennung aus. Die Verbindung kann aus verschiedenen Gründen fallen, die Erkennung versucht immer, die Verbindung nach Bedarf erneut zu erstellen, um laufende Vorgänge zu gewährleisten. In all diesen Fällen geben verbundene/getrennte Ereignisse die Änderung des Verbindungsstatus an. Aktualisiert in Version 1.17.0.

Elemente

Verbunden

Syntax: public EventSignal< const ConnectionEventArgs & > Connected;

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

Getrennt

Syntax: public EventSignal< const ConnectionEventArgs & > Disconnected;

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

MessageReceived

Syntax: public EventSignal< const ConnectionMessageEventArgs & > 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 );

Startet das Einrichten der Verbindung mit dem Dienst. Benutzer können optional Open() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor sie die Erkennung/Synthese für die erkennung/Synthesizer starten, die dieser Verbindung zugeordnet ist. Nach dem Starten der Erkennung schlägt der Aufruf von Open() je nach Prozesszustand des Erkennungs-/Synthesizers fehl. 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 fertig. Abonnieren Sie das Connected-Ereignis, um benachrichtigt zu werden, wenn die Verbindung hergestellt wird.

Die Parameter

  • forContinuousRecognition Gibt an, ob die Verbindung für die kontinuierliche Erkennung oder einmalige Erkennung verwendet wird. Es wirkt sich nicht aus, wenn die Verbindung von SpeechSynthsizer stammt.

Schließen

Syntax: public inline void Close ( );

Schließt die Verbindung des Diensts. Benutzer können optional Close() aufrufen, um die Verbindung des zugeordneten Erkennungs-/Synthesizers manuell herunterzufahren. Je nach Prozesszustand des Erkennungs-/Synthesizers schlägt der Aufruf möglicherweise fehl. 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. In Version 1.7.0 hinzugefügt.

Die Parameter

  • path den Nachrichtenpfad.

  • propertyName Name der Eigenschaft.

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

Rückgaben

Leere.

SendMessageAsync

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

Senden Sie eine Nachricht an den Sprachdienst. In Version 1.7.0 hinzugefügt.

Die Parameter

  • path Der Pfad der Nachricht.

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

Rückgaben

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.

Die Parameter

  • path Der Pfad der Nachricht.

  • payload Die binäre Nutzlast der Nachricht.

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

Rückgaben

Eine leere Zukunft.

Verbindung

Syntax: public inline explicit Connection ( SPXCONNECTIONHANDLE handle );

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

Die 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 Connection-Instanz von der angegebenen Erkennung ab.

Die Parameter

  • recognizer Die erkennung, die der Verbindung zugeordnet ist.

Rückgaben

Die Verbindungsinstanz der Erkennung.

FromConversationTranslator

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

Ruft die Verbindungsinstanz aus dem angegebenen Unterhaltungsübersetzer ab.

Die Parameter

  • convTrans Der mit der Verbindung verknüpfte Unterhaltungsübersetzer.

Rückgaben

Die Verbindungsinstanz des Unterhaltungsübersetzers.

FromDialogServiceConnector

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

Ruft die Verbindungsinstanz vom angegebenen Dialogdienstconnector ab, der zum Beobachten und Verwalten von Verbindung und Trennung vom Sprachdienst verwendet wird.

Die Parameter

  • dialogServiceConnector Der Dialogfelddienstconnector, der der Verbindung zugeordnet ist.

Rückgaben

Die Verbindungsinstanz des Dialogdienstconnectors.

FromSpeechSynthesizer

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

Ruft die Connection-Instanz vom angegebenen Sprachsynthesizer ab. In Version 1.17.0 hinzugefügt.

Die Parameter

  • synthesizer Der der Verbindung zugeordnete Sprachsynthesizer.

Rückgaben

Die Connection-Instanz des Sprachsynthesizers.