Package com.microsoft.cognitiveservices.speech

Enum CancellationReason

java.lang.Object

java.lang.Enum<CancellationReason>

com.microsoft.cognitiveservices.speech.CancellationReason

All Implemented Interfaces:

Serializable, Comparable<CancellationReason>

public enum CancellationReason
extends Enum<CancellationReason>

Defines the possible reasons a recognition result might be canceled.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CancelledByUser	Indicates that request was cancelled by the user.
EndOfStream	Indicates that the end of the audio stream was reached.
Error	Indicates that an error occurred during speech recognition.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the value of cancellation reason
static CancellationReason	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CancellationReason[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Error

public static final CancellationReason Error

Indicates that an error occurred during speech recognition.

EndOfStream

public static final CancellationReason EndOfStream

Indicates that the end of the audio stream was reached.

CancelledByUser

public static final CancellationReason CancelledByUser

Indicates that request was cancelled by the user. Added in version 1.14.0

Method Detail

values

public static CancellationReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CancellationReason c : CancellationReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CancellationReason valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Returns the value of cancellation reason

Returns:

the cancellation id value