Connection Klasse

Paket:

com.microsoft.cognitiveservices.speech

Maven-Artefakt:

com.microsoft.cognitiveservices.speech:client-sdk:1.34.0

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.Connection

Implementiert

java.lang.AutoCloseable

public final class Connection
implements java.lang.AutoCloseable

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 openConnection() 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 openConnection() oder closeConnection() 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. Hinweis: close() muss aufgerufen werden, um die zugrunde liegenden Ressourcen freizugeben, die sich im Objekt befinden. Aktualisiert in Version 1.17.0.

Feldzusammenfassung

Modifizierer und Typ	Feld und Beschreibung
final EventHandlerImpl<ConnectionEventArgs>	connected Das Connected-Ereignis, das angibt, dass die Erkennung mit dem Dienst verbunden ist.
final EventHandlerImpl<ConnectionEventArgs>	disconnected Das Disconnected-Ereignis, das angibt, dass die Erkennung vom Dienst getrennt ist.
final EventHandlerImpl<ConnectionMessageEventArgs>	messageReceived Das Ereignis MessageReceived gibt an, dass der Dienst eine Netzwerknachricht an den Client gesendet hat.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
void	close() Entsorgen sie zugeordneter Ressourcen.
void	closeConnection() Schließt die Verbindung des Diensts.
static Connection	fromConversationTranslator(ConversationTranslator conversationTranslator) Ruft die Verbindungs-instance aus dem Konversationsübersetzungsübersetzung ab.
static Connection	fromDialogServiceConnector(DialogServiceConnector dialogServiceConnector) Ruft den Verbindungs-instance aus dem Dialogdienstconnector ab.
static Connection	fromRecognizer(Recognizer recognizer) Ruft die Verbindungs-instance von der angegebenen Erkennung ab.
static Connection	fromSpeechSynthesizer(SpeechSynthesizer speechSynthesizer) Ruft die Verbindungs-instance aus dem Sprachsynthesizer ab.
void	openConnection(boolean forContinuousRecognition) Beginnt mit dem Einrichten der Verbindung mit dem Dienst.
java.util.concurrent.Future<java.lang.Void>	sendMessageAsync(String path, String payload) Sendet eine Nachricht an den Dienst.
void	setMessageProperty(String path, String propertyName, String propertyValue) Fügt einen Parameter in einer Nachricht an den Dienst an.

Geerbte Methoden von java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Felddetails

connected

public final EventHandlerImpl connected

Das Connected-Ereignis, das angibt, dass die Erkennung mit dem Dienst verbunden ist. Um das verbundene Ereignis nach dem Abonnieren empfangen zu können, muss das Connection-Objekt selbst aktiv sein. Wenn das Connection-Objekt, das dieses Ereignis besitzt, außerhalb seiner Lebensdauer liegt, werden nicht alle abonnierten Ereignisse übermittelt.

disconnected

public final EventHandlerImpl disconnected

Das Disconnected-Ereignis, das angibt, dass die Erkennung vom Dienst getrennt ist. Um das Ereignis "Disconnected" nach dem Abonnieren empfangen zu können, muss das Connection-Objekt selbst aktiv sein. Wenn das Connection-Objekt, das dieses Ereignis besitzt, außerhalb seiner Lebensdauer liegt, werden nicht alle abonnierten Ereignisse übermittelt.

messageReceived

public final EventHandlerImpl messageReceived

Das MessageReceived-Ereignis gibt an, dass der Dienst eine Netzwerknachricht an den Client gesendet hat. In Version 1.15.0 hinzugefügt.

Details zur Methode

close

public void close()

Entsorgen sie zugeordneter Ressourcen. close() muss aufgerufen werden, um die zugrunde liegenden Ressourcen ordnungsgemäß aufzugeben.

closeConnection

public void closeConnection()

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

fromConversationTranslator

public static Connection fromConversationTranslator(ConversationTranslator conversationTranslator)

Ruft die Verbindungs-instance aus dem Konversationsübersetzungsübersetzung ab.

Parameters:

conversationTranslator - Der conversationTranslator, der der Verbindung zugeordnet ist.

Returns:

Die Verbindungs-instance der Erkennung.

fromDialogServiceConnector

public static Connection fromDialogServiceConnector(DialogServiceConnector dialogServiceConnector)

Ruft den Verbindungs-instance aus dem Dialogdienstconnector ab.

Parameters:

dialogServiceConnector - Der der Verbindung zugeordnete Dialogdienstconnector, der zum Überwachen und Verwalten des Verbindungszustands mit dem Sprachdienst verwendet wird.

Returns:

Die verbindungs-instance des Dialogdienstconnectors.

fromRecognizer

public static Connection fromRecognizer(Recognizer recognizer)

Ruft die Verbindungs-instance von der angegebenen Erkennung ab.

Parameters:

recognizer - Die der Verbindung zugeordnete Erkennung.

Returns:

Die Verbindungs-instance der Erkennung.

fromSpeechSynthesizer

public static Connection fromSpeechSynthesizer(SpeechSynthesizer speechSynthesizer)

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

Parameters:

speechSynthesizer - Der der Verbindung zugeordnete Sprachsynthesizer, der zum Überwachen und Verwalten des Verbindungszustands mit dem Sprachdienst verwendet wird.

Returns:

Die Verbindungs-instance des Sprachsynthesizers.

openConnection

public void openConnection(boolean forContinuousRecognition)

Beginnt mit dem Einrichten der Verbindung mit dem Dienst. Benutzer können optional openConnection() aufrufen, um eine Verbindung im Voraus manuell einzurichten, bevor die Erkennung auf der Dieser Verbindung zugeordneten Erkennung beginnt. Nach dem Starten der Erkennung kann der Aufruf von OpenConnection() abhängig vom Prozessstatus der Erkennung fehlschlagen. Der Fehler wirkt sich jedoch nicht auf den Zustand der zugeordneten Erkennung 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.

Parameters:

forContinuousRecognition - gibt an, ob die Verbindung für die kontinuierliche Erkennung oder die Einzelschusserkennung verwendet wird. Es wird nicht wirksam, wenn die Verbindung über SpeechSynthsizer hergestellt wird.

sendMessageAsync

public Future sendMessageAsync(String path, String payload)

Sendet eine Nachricht an den Dienst. In Version 1.7.0 hinzugefügt Hinweis: Diese Methode funktioniert nicht für die Verbindung von SpeechSynthesizer.

Parameters:

path - Der Nachrichtenpfad.

payload - Die Nachrichtennutzlast

Returns:

eine Zukunft, die den asynchronen Vorgang darstellt, der die Nachricht sendet.

setMessageProperty

public void setMessageProperty(String path, String propertyName, String propertyValue)

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

Parameters:

path - Der Nachrichtenpfad.

propertyName - Der Eigenschaftenname, den Sie festlegen möchten.

propertyValue - Der Wert der Eigenschaft, den Sie festlegen möchten.