CallMediaRecognizeOptions 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

Implements

JsonSerializable<CallMediaRecognizeOptions>

public abstract class CallMediaRecognizeOptions
implements JsonSerializable<CallMediaRecognizeOptions>

Options to configure the Recognize operation

Constructor Summary

Constructor	Description
CallMediaRecognizeOptions(RecognizeInputType recognizeInputType, CommunicationIdentifier targetParticipant)	Initializes a CallMediaRecognizeOptions object.

Method Summary

Modifier and Type	Method and Description
static CallMediaRecognizeOptions	fromJson(JsonReader jsonReader) Reads an instance of CallMediaRecognizeOptions from the JsonReader.
Duration	getInitialSilenceTimeout() Get the initialSilenceTimeout property: Time to wait for first input after prompt (if any).
String	getOperationCallbackUrl() Get the overridden call back URL override for operation.
String	getOperationContext() Get the operationContext property: The value to identify context of the operation.
PlaySource	getPlayPrompt() Deprecated Use the getPlayPrompts() method. Get the playPrompt property: The source of the audio to be played for recognition.
List<PlaySource>	getPlayPrompts() Get the playPrompts property: The list source of the audio to be played for recognition.
RecognizeInputType	getRecognizeInputType() Get the recognizeInputType property: Determines the type of the recognition.
CommunicationIdentifier	getTargetParticipant() Get the targetParticipant property: Target participant of DTFM tone recognition.
Boolean	isInterruptCallMediaOperation() Get the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests.
Boolean	isInterruptPrompt() Get the interruptPrompt property: Determines if we interrupt the prompt and start recognizing.
Boolean	isStopCurrentOperations() Get the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests.
CallMediaRecognizeOptions	setInitialSilenceTimeout(Duration initialSilenceTimeout) Set the initialSilenceTimeout property: Time to wait for first input after prompt (if any).
CallMediaRecognizeOptions	setInterruptCallMediaOperation(Boolean interruptCallMediaOperation) Set the interruptCallMediaOperation property: If set recognize can barge into other existing queued-up/currently-processing requests.
CallMediaRecognizeOptions	setInterruptPrompt(Boolean interruptPrompt) Set the interruptPrompt property: Determines if we interrupt the prompt and start recognizing.
CallMediaRecognizeOptions	setOperationCallbackUrl(String operationCallbackUrl) Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
CallMediaRecognizeOptions	setOperationContext(String operationContext) Set the operationContext property: The value to identify context of the operation.
CallMediaRecognizeOptions	setPlayPrompt(PlaySource playPrompt) Deprecated Use the setPlayPrompts(List<PlaySource> playPrompts) or #setPlayPrompts(PlaySource...) method. Set the playPrompt property: The source of the audio to be played for recognition.
CallMediaRecognizeOptions	setPlayPrompts(List<PlaySource> playPrompts) Set the playPrompts property: The list source of the audio to be played for recognition.
CallMediaRecognizeOptions	setPlayPrompts(PlaySource[] playPrompts) Set the playPrompts property: The list source of the audio to be played for recognition.
CallMediaRecognizeOptions	setRecognizeInputType(RecognizeInputType recognizeInputType) Set the recognizeInputType property: Determines the type of the recognition.
CallMediaRecognizeOptions	setStopCurrentOperations(Boolean stopCurrentOperations) Set the stopCurrentOperations property: If set recognize can barge into other existing queued-up/currently-processing requests.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static CallMediaRecognizeOptions fromJson(JsonReader jsonReader)

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.

getInitialSilenceTimeout

public Duration getInitialSilenceTimeout()

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

Returns:

the initialSilenceTimeout value.

getOperationCallbackUrl

public String getOperationCallbackUrl()

Get the overridden call back URL override for operation.

Returns:

the operationCallbackUrl

getOperationContext

public String getOperationContext()

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

Returns:

the operationContext value.

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.

getPlayPrompts

public List<PlaySource> getPlayPrompts()

Get the playPrompts property: The list source of the audio to be played for recognition.

Returns:

the playPrompts value.

getRecognizeInputType

public RecognizeInputType getRecognizeInputType()

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

Returns:

the recognizeInputType value.

getTargetParticipant

public CommunicationIdentifier getTargetParticipant()

Get the targetParticipant property: Target participant of DTFM tone recognition.

Returns:

the targetParticipant value.

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.

isInterruptPrompt

public Boolean isInterruptPrompt()

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

Returns:

the interruptPrompt value.

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.

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.

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.

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.

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.

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.

setPlayPrompt

@Deprecated
public CallMediaRecognizeOptions setPlayPrompt(PlaySource playPrompt)

Deprecated

Use the setPlayPrompts(List<PlaySource> playPrompts) 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.

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.

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.

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.