Package com.microsoft.cognitiveservices.speech

Class SpeechRecognitionCanceledEventArgs

  • public final class SpeechRecognitionCanceledEventArgs
extends SpeechRecognitionEventArgs
    Defines payload of speech recognition canceled events.

    • Constructor Detail

      • SpeechRecognitionCanceledEventArgs

        public SpeechRecognitionCanceledEventArgs​(long eventArgs)
        Constructs an instance of a SpeechRecognitionCanceledEventArgs object.
        Parameters:
        eventArgs - recognition canceled event args object.

      • SpeechRecognitionCanceledEventArgs

        public SpeechRecognitionCanceledEventArgs​(long eventArgs,
                                          boolean dispose)
        Speech Recognition Canceled Event ARGS
        Parameters:
        eventArgs - Args for the event.
        dispose - Should the event args be disposed when done.

    • Method Detail

      • getReason

        public CancellationReason getReason()
        The reason the recognition was canceled.
        Returns:
        Specifies the reason canceled.

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

      • toString

        public String toString()
        Returns a String that represents the speech recognition canceled event args.
        Overrides:
        toString in class SpeechRecognitionEventArgs
        Returns:
        A String that represents the speech recognition canceled event args.