TranslationRecognitionCanceledEventArgs Class

Package:

com.microsoft.cognitiveservices.speech.translation

Maven Artifact:

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

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.SessionEventArgs
  • • com.microsoft.cognitiveservices.speech.RecognitionEventArgs
    • • com.microsoft.cognitiveservices.speech.translation.TranslationRecognitionEventArgs
      • • com.microsoft.cognitiveservices.speech.translation.TranslationRecognitionCanceledEventArgs

public final class TranslationRecognitionCanceledEventArgs
extends TranslationRecognitionEventArgs

Defines payload of translation canceled events.

Method Summary

Modifier and Type	Method and Description
CancellationErrorCode	getErrorCode() The error code in case of an unsuccessful recognition (when getReason() returns Error).
java.lang.String	getErrorDetails() The error message in case of an unsuccessful recognition (when getReason() returns Error).
CancellationReason	getReason() The reason the recognition was canceled.
java.lang.String	toString() Returns a String that represents the speech recognition canceled event args.

Methods inherited from RecognitionEventArgs

getRecognitionResult

Methods inherited from SessionEventArgs

close getSessionId

Methods inherited from TranslationRecognitionEventArgs

getResult toString

Methods inherited from 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.wait java.lang.Object.wait java.lang.Object.wait

Method Details

getErrorCode

public CancellationErrorCode getErrorCode()

The error code in case of an unsuccessful recognition (when getReason() returns Error). Added in version 1.1.0.

Returns:

An error code that represents the error reason.

getErrorDetails

public String getErrorDetails()

The error message in case of an unsuccessful recognition (when getReason() returns Error).

Returns:

A String that represents the error details.

getReason

public CancellationReason getReason()

The reason the recognition was canceled.

Returns:

Specifies the reason canceled.

toString

public String toString()

Returns a String that represents the speech recognition canceled event args.

Overrides:

TranslationRecognitionCanceledEventArgs.toString()

Returns:

A String that represents the speech recognition canceled event args.