Package com.azure.communication.callautomation.models

Class CallMediaRecognizeDtmfOptions

java.lang.Object

com.azure.communication.callautomation.models.CallMediaRecognizeOptions

com.azure.communication.callautomation.models.CallMediaRecognizeDtmfOptions

public class CallMediaRecognizeDtmfOptions
extends CallMediaRecognizeOptions

The Recognize configurations specific for Dtmf.

Constructor Summary

Constructors

Constructor	Description
CallMediaRecognizeDtmfOptions(com.azure.communication.common.CommunicationIdentifier targetParticipant, int maxTonesToCollect)	Initializes a CallMediaRecognizeDtmfOptions object.

Method Summary

Modifier and Type	Method	Description
Duration	getInterToneTimeout()	Get the interToneTimeout property: Time to wait between DTMF inputs to stop recognizing.
Integer	getMaxTonesToCollect()	Get the maxTonesToCollect property: Maximum number of DTMFs to be collected.
List<DtmfTone>	getStopTones()	Get the stopTones property: List of tones that will stop recognizing.
CallMediaRecognizeDtmfOptions	setInterToneTimeout(Duration interToneTimeout)	Set the interToneTimeout property: Time to wait between DTMF inputs to stop recognizing.
CallMediaRecognizeDtmfOptions	setStopTones(List<DtmfTone> stopDtmfTones)	Set the stopTones property: List of tones that will stop recognizing.

Methods inherited from class com.azure.communication.callautomation.models.CallMediaRecognizeOptions

getInitialSilenceTimeout, getOperationContext, getPlayPrompt, getRecognizeInputType, getTargetParticipant, isInterruptCallMediaOperation, isInterruptPrompt, isStopCurrentOperations, setInitialSilenceTimeout, setInterruptCallMediaOperation, setInterruptPrompt, setOperationContext, setPlayPrompt, setRecognizeInputType, setStopCurrentOperations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CallMediaRecognizeDtmfOptions

public CallMediaRecognizeDtmfOptions(com.azure.communication.common.CommunicationIdentifier targetParticipant,
 int maxTonesToCollect)

Initializes a CallMediaRecognizeDtmfOptions object.

Parameters:

targetParticipant - Target participant of DTFM tone recognition.

maxTonesToCollect - Maximum number of DTMF tones to be collected.

Method Details

getInterToneTimeout

public Duration getInterToneTimeout()

Get the interToneTimeout property: Time to wait between DTMF inputs to stop recognizing. If left unspecified, the default value is set to 2 seconds.

Returns:

the interToneTimeout value.

setInterToneTimeout

public CallMediaRecognizeDtmfOptions setInterToneTimeout(Duration interToneTimeout)

Set the interToneTimeout property: Time to wait between DTMF inputs to stop recognizing.

Parameters:

interToneTimeout - the interToneTimeout value to set.

Returns:

the DtmfConfigurationsInternal object itself.

getMaxTonesToCollect

public Integer getMaxTonesToCollect()

Get the maxTonesToCollect property: Maximum number of DTMFs to be collected.

Returns:

the maxTonesToCollect value.

getStopTones

public List<DtmfTone> getStopTones()

Get the stopTones property: List of tones that will stop recognizing.

Returns:

the stopTones value.

setStopTones

public CallMediaRecognizeDtmfOptions setStopTones(List<DtmfTone> stopDtmfTones)

Set the stopTones property: List of tones that will stop recognizing.

Parameters:

stopDtmfTones - the stopTones value to set.

Returns:

the DtmfConfigurationsInternal object itself.