Package com.bytedesk.call.mrcp4j.common

Enum Class MrcpEventName

java.lang.Object
java.lang.Enum<MrcpEventName>
com.bytedesk.call.mrcp4j.common.MrcpEventName
All Implemented Interfaces:
Serializable, Comparable<MrcpEventName>, Constable
public enum MrcpEventName extends Enum<MrcpEventName>
Defines the event names that are valid values for MRCPv2 event messages.
Author:
Niels Godfredsen <ngodfredsen@users.sourceforge.net>
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    INTERPRETATION_COMPLETE
    This event from the recognition resource to the client indicates that the INTERPRET operation is complete.
    RECOGNITION_COMPLETE
    This event from the recognizer resource to the client indicates that recognition has completed.
    RECORD_COMPLETE
    This event from the recorder resource to the client indicates that recording has completed due either to no-input, silence after speech or max-time exceeded.
    SPEAK_COMPLETE
    This event from the synthesizer resource to the client indicates that the corresponding "SPEAK" request was completed.
    SPEECH_MARKER
    This event from the synthesizer resource to the client is generated when the synthesizer encounters a marker tag in the speech markup it is currently processing.
    START_OF_INPUT
    This event from the recognition resource, the recorder resource or the verification resource to the client indicates speech or DTMF has been detected by the resource.
    VERIFICATION_COMPLETE
    This event from the verification resource to the client follows a call to VERIFY or VERIFY-FROM-BUFFER and is used to communicate the verification results to the client.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    _name
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    MrcpEventName(String name)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static MrcpEventName
    fromString(String str)
    Converts an MRCP event name in string format to the appropriate MRCP4J enum value.
    String
    toString()
     
    static MrcpEventName
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MrcpEventName[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • SPEECH_MARKER

      public static final MrcpEventName SPEECH_MARKER
      This event from the synthesizer resource to the client is generated when the synthesizer encounters a marker tag in the speech markup it is currently processing.

    • SPEAK_COMPLETE

      public static final MrcpEventName SPEAK_COMPLETE
      This event from the synthesizer resource to the client indicates that the corresponding "SPEAK" request was completed.

    • START_OF_INPUT

      public static final MrcpEventName START_OF_INPUT
      This event from the recognition resource, the recorder resource or the verification resource to the client indicates speech or DTMF has been detected by the resource.

    • RECOGNITION_COMPLETE

      public static final MrcpEventName RECOGNITION_COMPLETE
      This event from the recognizer resource to the client indicates that recognition has completed.

    • INTERPRETATION_COMPLETE

      public static final MrcpEventName INTERPRETATION_COMPLETE
      This event from the recognition resource to the client indicates that the INTERPRET operation is complete.

    • RECORD_COMPLETE

      public static final MrcpEventName RECORD_COMPLETE
      This event from the recorder resource to the client indicates that recording has completed due either to no-input, silence after speech or max-time exceeded.

    • VERIFICATION_COMPLETE

      public static final MrcpEventName VERIFICATION_COMPLETE
      This event from the verification resource to the client follows a call to VERIFY or VERIFY-FROM-BUFFER and is used to communicate the verification results to the client.

  • Field Details

    • _name

      private String _name

  • Constructor Details

    • MrcpEventName

      private MrcpEventName(String name)

  • Method Details

    • values

      public static MrcpEventName[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static MrcpEventName valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<MrcpEventName>

    • fromString

      public static MrcpEventName fromString(String str) throws IllegalArgumentException
      Converts an MRCP event name in string format to the appropriate MRCP4J enum value.
      Parameters:
      str - MRCP event string
      Returns:
      the event name enum instance corresponding to the string name specified
      Throws:
      IllegalArgumentException - if the string value specified does not correspond to a valid MRCP event name