ConversationTranscriptionCanceledEventArgs Class

  • Reference
Package:
com.microsoft.cognitiveservices.speech.transcription
Maven Artifact:
com.microsoft.cognitiveservices.speech:client-sdk:1.38.0

public final class ConversationTranscriptionCanceledEventArgs
extends ConversationTranscriptionEventArgs

Class that defines conversation transcription canceled events. Added in version 1.5.0

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 conversation transcribing canceled event args.

Methods inherited from RecognitionEventArgs

getRecognitionResult

Methods inherited from SessionEventArgs

close getSessionId

Methods inherited from ConversationTranscriptionEventArgs

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).

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 conversation transcribing canceled event args.

Overrides:

ConversationTranscriptionCanceledEventArgs.toString()

Returns:

A String that represents the conversation transcribing canceled event args.

Applies to