Package com.azure.communication.callautomation.models

Class CallMediaRecognizeOptions

java.lang.Object
com.azure.communication.callautomation.models.CallMediaRecognizeOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<CallMediaRecognizeOptions>
Direct Known Subclasses:
CallMediaRecognizeChoiceOptions, CallMediaRecognizeDtmfOptions, CallMediaRecognizeSpeechOptions, CallMediaRecognizeSpeechOrDtmfOptions
public abstract class CallMediaRecognizeOptions extends Object implements com.azure.json.JsonSerializable<CallMediaRecognizeOptions>
Options to configure the Recognize operation

  • Constructor Details

    • CallMediaRecognizeOptions

      public CallMediaRecognizeOptions(RecognizeInputType recognizeInputType, CommunicationIdentifier targetParticipant)
      Initializes a CallMediaRecognizeOptions object.
      Parameters:
      recognizeInputType - What input the operation should recognize.
      targetParticipant - Target participant of DTFM tone recognition.

  • Method Details

    • getRecognizeInputType

      public RecognizeInputType getRecognizeInputType()
      Get the recognizeInputType property: Determines the type of the recognition.
      Returns:
      the recognizeInputType value.

    • setRecognizeInputType

      public CallMediaRecognizeOptions setRecognizeInputType(RecognizeInputType recognizeInputType)
      Set the recognizeInputType property: Determines the type of the recognition.
      Parameters:
      recognizeInputType - the recognizeInputType value to set.
      Returns:
      the RecognizeRequest object itself.

    • getPlayPrompt

      @Deprecated public PlaySource getPlayPrompt()
      Deprecated.
      Use the getPlayPrompts() method.
      Get the playPrompt property: The source of the audio to be played for recognition.
      Returns:
      the playPrompt value.

    • setPlayPrompt

      @Deprecated public CallMediaRecognizeOptions setPlayPrompt(PlaySource playPrompt)
      Deprecated.
      Use the setPlayPrompts(List) or setPlayPrompts(PlaySource...) method.
      Set the playPrompt property: The source of the audio to be played for recognition.
      Parameters:
      playPrompt - the playPrompt value to set.
      Returns:
      the RecognizeRequest object itself.

    • getPlayPrompts

      public List<PlaySource> getPlayPrompts()
      Get the playPrompts property: The list source of the audio to be played for recognition.
      Returns:
      the playPrompts value.

    • setPlayPrompts

      public CallMediaRecognizeOptions setPlayPrompts(List<PlaySource> playPrompts)
      Set the playPrompts property: The list source of the audio to be played for recognition.
      Parameters:
      playPrompts - the playPrompts value to set.
      Returns:
      the RecognizeRequest object itself.

    • setPlayPrompts

      public CallMediaRecognizeOptions setPlayPrompts(PlaySource... playPrompts)
      Set the playPrompts property: The list source of the audio to be played for recognition.
      Parameters:
      playPrompts - the playPrompts value to set.
      Returns:
      the RecognizeRequest object itself.

    • isInterruptCallMediaOperation

      public Boolean isInterruptCallMediaOperation()
      Get the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests.
      Returns:
      the interruptCallMediaOperation value.

    • setInterruptCallMediaOperation

      public CallMediaRecognizeOptions setInterruptCallMediaOperation(Boolean interruptCallMediaOperation)
      Set the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests.
      Parameters:
      interruptCallMediaOperation - the interruptCallMediaOperation value to set.
      Returns:
      the RecognizeRequest object itself.

    • isStopCurrentOperations

      public Boolean isStopCurrentOperations()
      Get the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests.
      Returns:
      the stopCurrentOperations value.

    • setStopCurrentOperations

      public CallMediaRecognizeOptions setStopCurrentOperations(Boolean stopCurrentOperations)
      Set the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests.
      Parameters:
      stopCurrentOperations - the stopCurrentOperations value to set.
      Returns:
      the RecognizeRequest object itself.

    • getOperationContext

      public String getOperationContext()
      Get the operationContext property: The value to identify context of the operation.
      Returns:
      the operationContext value.

    • setOperationContext

      public CallMediaRecognizeOptions setOperationContext(String operationContext)
      Set the operationContext property: The value to identify context of the operation.
      Parameters:
      operationContext - the operationContext value to set.
      Returns:
      the RecognizeRequest object itself.

    • isInterruptPrompt

      public Boolean isInterruptPrompt()
      Get the interruptPrompt property: Determines if we interrupt the prompt and start recognizing.
      Returns:
      the interruptPrompt value.

    • setInterruptPrompt

      public CallMediaRecognizeOptions setInterruptPrompt(Boolean interruptPrompt)
      Set the interruptPrompt property: Determines if we interrupt the prompt and start recognizing.
      Parameters:
      interruptPrompt - the interruptPrompt value to set.
      Returns:
      the RecognizeConfigurations object itself.

    • getInitialSilenceTimeout

      public Duration getInitialSilenceTimeout()
      Get the initialSilenceTimeout property: Time to wait for first input after prompt (if any).
      Returns:
      the initialSilenceTimeout value.

    • setInitialSilenceTimeout

      public CallMediaRecognizeOptions setInitialSilenceTimeout(Duration initialSilenceTimeout)
      Set the initialSilenceTimeout property: Time to wait for first input after prompt (if any).
      Parameters:
      initialSilenceTimeout - the initialSilenceTimeout value to set.
      Returns:
      the RecognizeConfigurations object itself.

    • getTargetParticipant

      public CommunicationIdentifier getTargetParticipant()
      Get the targetParticipant property: Target participant of DTFM tone recognition.
      Returns:
      the targetParticipant value.

    • getOperationCallbackUrl

      public String getOperationCallbackUrl()
      Get the overridden call back URL override for operation.
      Returns:
      the operationCallbackUrl

    • setOperationCallbackUrl

      public CallMediaRecognizeOptions setOperationCallbackUrl(String operationCallbackUrl)
      Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
      Parameters:
      operationCallbackUrl - the operationCallbackUrl to set
      Returns:
      the CallMediaRecognizeOptions object itself.

    • fromJson

      public static CallMediaRecognizeOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of CallMediaRecognizeOptions from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of CallMediaRecognizeOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ExternalStorage.