Package com.bytedesk.call.mrcp4j.common

Enum Class MrcpMethodName

java.lang.Object
java.lang.Enum<MrcpMethodName>
com.bytedesk.call.mrcp4j.common.MrcpMethodName
All Implemented Interfaces:
Serializable, Comparable<MrcpMethodName>, Constable
public enum MrcpMethodName extends Enum<MrcpMethodName>
Defines the method names that are valid values for MRCPv2 request 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
    BARGE_IN_OCCURRED
    Provides a client which has received a barge-in-able event a means to communicate the occurrence of the event to the synthesizer resource.
    CLEAR_BUFFER
    Directs the verification resource to clear the verification buffer.
    CONTROL
    Directs a synthesizer resource that is speaking to modify what it is speaking on the fly.
    DEFINE_GRAMMAR
    Specifies one or more grammars to the recognition resource and requests the resource to access, fetch, and compile the grammars as needed.
    DEFINE_LEXICON
    Provides a lexicon and tells the server to load, unload, activate or deactivate the lexicon.
    DELETE_PHRASE
    Used to delete a phrase in a personal grammar added through voice enrollment or text enrollment.
    DELETE_VOICEPRINT
    Removes a voice-print from a voice-print repository.
    END_PHRASE_ENROLLMENT
    Directs the recognition resource to end an active phrase enrollment session.
    END_SESSION
    Requests the verification resource to terminate an ongoing verification session and release the verification voiceprint resources.
    ENROLLMENT_ROLLBACK
    Discards the last live utterance from the RECOGNIZE operation.
    GET_INTERMEDIATE_RESULT
    Polls the verification resource for intermediate results of a verification request that is in progress.
    GET_PARAMS
    Asks the MRCP resource for its current session parameters.
    GET_RESULT
    May be issued when the recognizer resource is in the recognized state, allows the client to retrieve results for a completed recognition.
    INTERPRET
    Takes as input an interpret-text header, containing the text for which the semantic interpretation is desired, and returns, via the INTERPRETATION- COMPLETE event, an interpretation result which is very similar to the one returned from a RECOGNIZE method invocation.
    MODIFY_PHRASE
    Used to change the phrase ID, NL phrase and/or weight for a given phrase in a personal grammar.
    PAUSE
    Tells the synthesizer resource to pause speech output if it is speaking something.
    QUERY_VOICEPRINT
    Queries the verification resource for status information on a particular voice-print or voice-print repository.
    RECOGNIZE
    Requests the recognizer to start recognition and provides it with one or more grammar references for grammars to match against the input media.
    RECORD
    Directs the recorder resource to start recording audio immediately or wait for the end pointing functionality to detect speech in the audio, depending on the headers specified in the request.
    RESUME
    Tells a paused synthesizer resource to resume speaking.
    SET_PARAMS
    Tells the MRCP resource to define parameters for the session.
    SPEAK
    Provides the synthesizer resource with the speech text and initiates speech synthesis and streaming.
    START_INPUT_TIMERS
    Should be sent from the client to the recognition resource, the recorder resource and/or the verification resource when it knows that a kill-on-barge-in prompt has finished playing.
    START_PHRASE_ENROLLMENT
    Starts a new phrase enrollment session during which the client may call RECOGNIZE multiple times to enroll a new utterance in a grammar.
    START_SESSION
    Requests the verification resource to start a speaker verification or identification session.
    STOP
    Tells the MRCP resource to stop an operation in progress, for example tells the synthesizer resource to stop speaking if it is speaking something.
    VERIFY
    Requests the verification resource to either train/adapt the voiceprint or to verify/identify a claimed identity.
    VERIFY_FROM_BUFFER
    Directs the verification resource to verify buffered audio against a voiceprint.
    VERIFY_ROLLBACK
    Directs the verification resource to discard the last buffered utterance or discard the last live utterances (when the mode is "train" or "verify").

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    _name
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    MrcpMethodName(String name)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static MrcpMethodName
    fromString(String str)
    Converts an MRCP method in string format to the appropriate MRCP4J enum value.
    String
    toString()
     
    static MrcpMethodName
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MrcpMethodName[]
    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

    • SET_PARAMS

      public static final MrcpMethodName SET_PARAMS
      Tells the MRCP resource to define parameters for the session.

    • GET_PARAMS

      public static final MrcpMethodName GET_PARAMS
      Asks the MRCP resource for its current session parameters.

    • SPEAK

      public static final MrcpMethodName SPEAK
      Provides the synthesizer resource with the speech text and initiates speech synthesis and streaming.

    • STOP

      public static final MrcpMethodName STOP
      Tells the MRCP resource to stop an operation in progress, for example tells the synthesizer resource to stop speaking if it is speaking something.

    • PAUSE

      public static final MrcpMethodName PAUSE
      Tells the synthesizer resource to pause speech output if it is speaking something.

    • RESUME

      public static final MrcpMethodName RESUME
      Tells a paused synthesizer resource to resume speaking.

    • BARGE_IN_OCCURRED

      public static final MrcpMethodName BARGE_IN_OCCURRED
      Provides a client which has received a barge-in-able event a means to communicate the occurrence of the event to the synthesizer resource.

    • CONTROL

      public static final MrcpMethodName CONTROL
      Directs a synthesizer resource that is speaking to modify what it is speaking on the fly.

    • DEFINE_LEXICON

      public static final MrcpMethodName DEFINE_LEXICON
      Provides a lexicon and tells the server to load, unload, activate or deactivate the lexicon.

    • DEFINE_GRAMMAR

      public static final MrcpMethodName DEFINE_GRAMMAR
      Specifies one or more grammars to the recognition resource and requests the resource to access, fetch, and compile the grammars as needed.

    • RECOGNIZE

      public static final MrcpMethodName RECOGNIZE
      Requests the recognizer to start recognition and provides it with one or more grammar references for grammars to match against the input media.

    • INTERPRET

      public static final MrcpMethodName INTERPRET
      Takes as input an interpret-text header, containing the text for which the semantic interpretation is desired, and returns, via the INTERPRETATION- COMPLETE event, an interpretation result which is very similar to the one returned from a RECOGNIZE method invocation.

    • GET_RESULT

      public static final MrcpMethodName GET_RESULT
      May be issued when the recognizer resource is in the recognized state, allows the client to retrieve results for a completed recognition.

    • START_INPUT_TIMERS

      public static final MrcpMethodName START_INPUT_TIMERS
      Should be sent from the client to the recognition resource, the recorder resource and/or the verification resource when it knows that a kill-on-barge-in prompt has finished playing.

    • START_PHRASE_ENROLLMENT

      public static final MrcpMethodName START_PHRASE_ENROLLMENT
      Starts a new phrase enrollment session during which the client may call RECOGNIZE multiple times to enroll a new utterance in a grammar.

    • ENROLLMENT_ROLLBACK

      public static final MrcpMethodName ENROLLMENT_ROLLBACK
      Discards the last live utterance from the RECOGNIZE operation.

    • END_PHRASE_ENROLLMENT

      public static final MrcpMethodName END_PHRASE_ENROLLMENT
      Directs the recognition resource to end an active phrase enrollment session.

    • MODIFY_PHRASE

      public static final MrcpMethodName MODIFY_PHRASE
      Used to change the phrase ID, NL phrase and/or weight for a given phrase in a personal grammar.

    • DELETE_PHRASE

      public static final MrcpMethodName DELETE_PHRASE
      Used to delete a phrase in a personal grammar added through voice enrollment or text enrollment.

    • RECORD

      public static final MrcpMethodName RECORD
      Directs the recorder resource to start recording audio immediately or wait for the end pointing functionality to detect speech in the audio, depending on the headers specified in the request.

    • START_SESSION

      public static final MrcpMethodName START_SESSION
      Requests the verification resource to start a speaker verification or identification session.

    • END_SESSION

      public static final MrcpMethodName END_SESSION
      Requests the verification resource to terminate an ongoing verification session and release the verification voiceprint resources.

    • QUERY_VOICEPRINT

      public static final MrcpMethodName QUERY_VOICEPRINT
      Queries the verification resource for status information on a particular voice-print or voice-print repository.

    • DELETE_VOICEPRINT

      public static final MrcpMethodName DELETE_VOICEPRINT
      Removes a voice-print from a voice-print repository.

    • VERIFY

      public static final MrcpMethodName VERIFY
      Requests the verification resource to either train/adapt the voiceprint or to verify/identify a claimed identity.

    • VERIFY_FROM_BUFFER

      public static final MrcpMethodName VERIFY_FROM_BUFFER
      Directs the verification resource to verify buffered audio against a voiceprint.

    • VERIFY_ROLLBACK

      public static final MrcpMethodName VERIFY_ROLLBACK
      Directs the verification resource to discard the last buffered utterance or discard the last live utterances (when the mode is "train" or "verify").

    • CLEAR_BUFFER

      public static final MrcpMethodName CLEAR_BUFFER
      Directs the verification resource to clear the verification buffer.

    • GET_INTERMEDIATE_RESULT

      public static final MrcpMethodName GET_INTERMEDIATE_RESULT
      Polls the verification resource for intermediate results of a verification request that is in progress.

  • Field Details

    • _name

      private String _name

  • Constructor Details

    • MrcpMethodName

      private MrcpMethodName(String name)

  • Method Details

    • values

      public static MrcpMethodName[] 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 MrcpMethodName 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<MrcpMethodName>

    • fromString

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