CallMediaRecognizeChoiceOptions Class

Package:

com.azure.communication.callautomation.models

Maven Artifact:

com.azure:azure-communication-callautomation:1.6.1

• java.lang.Object
• • com.azure.communication.callautomation.models.CallMediaRecognizeOptions
  • • com.azure.communication.callautomation.models.CallMediaRecognizeChoiceOptions

public final class CallMediaRecognizeChoiceOptions
extends CallMediaRecognizeOptions

The Recognize configurations specific for Recognize Choice.

Constructor Summary

Constructor	Description
CallMediaRecognizeChoiceOptions(CommunicationIdentifier targetParticipant, List<RecognitionChoice> choices)	Initializes a CallMediaRecognizeDtmfOptions object.

Method Summary

Modifier and Type	Method and Description
static CallMediaRecognizeChoiceOptions	fromJson(JsonReader jsonReader) Reads an instance of CallMediaRecognizeChoiceOptions from the JsonReader.
List<RecognitionChoice>	getChoices() Get the list of recognition choices.
String	getSpeechLanguage() Get the speech language property.
String	getSpeechRecognitionModelEndpointId() Get the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.
CallMediaRecognizeChoiceOptions	setInitialSilenceTimeout(Duration initialSilenceTimeout) Set the initialSilenceTimeout property: Time to wait for first input after prompt (if any).
CallMediaRecognizeChoiceOptions	setInterruptCallMediaOperation(Boolean interruptCallMediaOperation) Set the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests.
CallMediaRecognizeChoiceOptions	setInterruptPrompt(Boolean interruptPrompt) Set the interruptPrompt property: Determines if we interrupt the prompt and start recognizing.
CallMediaRecognizeChoiceOptions	setOperationContext(String operationContext) Set the operationContext property: The value to identify context of the operation.
CallMediaRecognizeChoiceOptions	setPlayPrompt(PlaySource playPrompt) Set the playPrompt property: The source of the audio to be played for recognition.
CallMediaRecognizeChoiceOptions	setRecognizeInputType(RecognizeInputType recognizeInputType) Set the recognizeInputType property: Determines the type of the recognition.
CallMediaRecognizeChoiceOptions	setSpeechLanguage(String speechLanguage) Set the speech language property.
CallMediaRecognizeChoiceOptions	setSpeechRecognitionModelEndpointId(String speechRecognitionModelEndpointId) Set the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.
CallMediaRecognizeChoiceOptions	setStopCurrentOperations(Boolean stopCurrentOperations) Set the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from CallMediaRecognizeOptions

fromJson getInitialSilenceTimeout getOperationCallbackUrl getOperationContext getPlayPrompt getPlayPrompts getRecognizeInputType getTargetParticipant isInterruptCallMediaOperation isInterruptPrompt isStopCurrentOperations setInitialSilenceTimeout setInterruptCallMediaOperation setInterruptPrompt setOperationCallbackUrl setOperationContext setPlayPrompt setPlayPrompts setPlayPrompts setRecognizeInputType setStopCurrentOperations

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CallMediaRecognizeChoiceOptions

public CallMediaRecognizeChoiceOptions(CommunicationIdentifier targetParticipant, List<RecognitionChoice> choices)

Initializes a CallMediaRecognizeDtmfOptions object.

Parameters:

targetParticipant - Target participant of DTFM tone recognition.

choices - Maximum number of DTMF tones to be collected.

Method Details

fromJson

public static CallMediaRecognizeChoiceOptions fromJson(JsonReader jsonReader)

Reads an instance of CallMediaRecognizeChoiceOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CallMediaRecognizeChoiceOptions 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 CallMediaRecognizeChoiceOptions.

getChoices

public List<RecognitionChoice> getChoices()

Get the list of recognition choices.

Returns:

the list of recognition choices.

getSpeechLanguage

public String getSpeechLanguage()

Get the speech language property.

Returns:

the speech language.

getSpeechRecognitionModelEndpointId

public String getSpeechRecognitionModelEndpointId()

Get the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.

Returns:

the speechRecognitionModelEndpointId value.

setInitialSilenceTimeout

public CallMediaRecognizeChoiceOptions setInitialSilenceTimeout(Duration initialSilenceTimeout)

Set the initialSilenceTimeout property: Time to wait for first input after prompt (if any).

Overrides:

CallMediaRecognizeChoiceOptions.setInitialSilenceTimeout(Duration initialSilenceTimeout)

Parameters:

initialSilenceTimeout - the initialSilenceTimeout value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

setInterruptCallMediaOperation

public CallMediaRecognizeChoiceOptions setInterruptCallMediaOperation(Boolean interruptCallMediaOperation)

Set the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests.

Overrides:

CallMediaRecognizeChoiceOptions.setInterruptCallMediaOperation(Boolean interruptCallMediaOperation)

Parameters:

interruptCallMediaOperation - the interruptCallMediaOperation value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

setInterruptPrompt

public CallMediaRecognizeChoiceOptions setInterruptPrompt(Boolean interruptPrompt)

Set the interruptPrompt property: Determines if we interrupt the prompt and start recognizing.

Overrides:

CallMediaRecognizeChoiceOptions.setInterruptPrompt(Boolean interruptPrompt)

Parameters:

interruptPrompt - the interruptPrompt value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

setOperationContext

public CallMediaRecognizeChoiceOptions setOperationContext(String operationContext)

Set the operationContext property: The value to identify context of the operation.

Overrides:

CallMediaRecognizeChoiceOptions.setOperationContext(String operationContext)

Parameters:

operationContext - the operationContext value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

setPlayPrompt

public CallMediaRecognizeChoiceOptions setPlayPrompt(PlaySource playPrompt)

Set the playPrompt property: The source of the audio to be played for recognition.

Overrides:

CallMediaRecognizeChoiceOptions.setPlayPrompt(PlaySource playPrompt)

Parameters:

playPrompt - the playPrompt value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

setRecognizeInputType

public CallMediaRecognizeChoiceOptions setRecognizeInputType(RecognizeInputType recognizeInputType)

Set the recognizeInputType property: Determines the type of the recognition.

Overrides:

CallMediaRecognizeChoiceOptions.setRecognizeInputType(RecognizeInputType recognizeInputType)

Parameters:

recognizeInputType - the recognizeInputType value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

setSpeechLanguage

public CallMediaRecognizeChoiceOptions setSpeechLanguage(String speechLanguage)

Set the speech language property.

Parameters:

speechLanguage - the interToneTimeout value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

setSpeechRecognitionModelEndpointId

public CallMediaRecognizeChoiceOptions setSpeechRecognitionModelEndpointId(String speechRecognitionModelEndpointId)

Set the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.

Parameters:

speechRecognitionModelEndpointId - the speechRecognitionModelEndpointId value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

setStopCurrentOperations

public CallMediaRecognizeChoiceOptions setStopCurrentOperations(Boolean stopCurrentOperations)

Set the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests.

Overrides:

CallMediaRecognizeChoiceOptions.setStopCurrentOperations(Boolean stopCurrentOperations)

Parameters:

stopCurrentOperations - the stopCurrentOperations value to set.

Returns:

the CallMediaRecognizeChoiceOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException