Package com.azure.communication.callautomation.models

Class CallMediaRecognizeOptions

java.lang.Object
com.azure.communication.callautomation.models.CallMediaRecognizeOptions
Direct Known Subclasses:
CallMediaRecognizeDtmfOptions
public abstract class CallMediaRecognizeOptions extends Object
Options to configure the Recognize operation

  • Constructor Details

    • CallMediaRecognizeOptions

      public CallMediaRecognizeOptions(RecognizeInputType recognizeInputType, com.azure.communication.common.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

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

    • setPlayPrompt

      public CallMediaRecognizeOptions setPlayPrompt(PlaySource playPrompt)
      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.

    • 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 com.azure.communication.common.CommunicationIdentifier getTargetParticipant()
      Get the targetParticipant property: Target participant of DTFM tone recognition.
      Returns:
      the targetParticipant value.