PlayToAllOptions 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.PlayToAllOptions

public final class PlayToAllOptions

The PlayToAllOptions model.

Constructor Summary

Constructor	Description
PlayToAllOptions(PlaySource playSource)	Constructor
PlayToAllOptions(List<PlaySource> playSources)	Constructor

Method Summary

Modifier and Type	Method and Description
String	getOperationCallbackUrl() Get the overridden call back URL override for operation.
String	getOperationContext() Get the operationContext property.
List<PlaySource>	getPlaySources() Get the play sources.
Boolean	isInterruptCallMediaOperation() Get the interruptCallMediaOperation property: If set play can barge into other existing queued-up/currently-processing requests.
boolean	isLoop() Get the loop property: The option to play the provided audio source in loop when set to true.
PlayToAllOptions	setInterruptCallMediaOperation(Boolean interruptCallMediaOperation) Set the interruptCallMediaOperation property: If set play can barge into other existing queued-up/currently-processing requests.
PlayToAllOptions	setLoop(boolean loop) Set the loop property: The option to play the provided audio source in loop when set to true.
PlayToAllOptions	setOperationCallbackUrl(String operationCallbackUrl) Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
PlayToAllOptions	setOperationContext(String operationContext) Set the operationContext property.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PlayToAllOptions

public PlayToAllOptions(PlaySource playSource)

Constructor

Parameters:

playSource - A PlaySource representing the source to play.

PlayToAllOptions

public PlayToAllOptions(List<PlaySource> playSources)

Constructor

Parameters:

playSources - A List of PlaySource representing the sources to play.

Method Details

getOperationCallbackUrl

public String getOperationCallbackUrl()

Get the overridden call back URL override for operation.

Returns:

the operationCallbackUrl

getOperationContext

public String getOperationContext()

Get the operationContext property.

Returns:

the operationContext value.

getPlaySources

public List<PlaySource> getPlaySources()

Get the play sources.

Returns:

the playSource value.

isInterruptCallMediaOperation

public Boolean isInterruptCallMediaOperation()

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

Returns:

the interruptCallMediaOperation value.

isLoop

public boolean isLoop()

Get the loop property: The option to play the provided audio source in loop when set to true.

Returns:

the loop value.

setInterruptCallMediaOperation

public PlayToAllOptions setInterruptCallMediaOperation(Boolean interruptCallMediaOperation)

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

Parameters:

interruptCallMediaOperation - the interruptCallMediaOperation value to set.

Returns:

the PlayOptionsInternal object itself.

setLoop

public PlayToAllOptions setLoop(boolean loop)

Set the loop property: The option to play the provided audio source in loop when set to true.

Parameters:

loop - the loop value to set.

Returns:

the PlayOptionsInternal object itself.

setOperationCallbackUrl

public PlayToAllOptions 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 PlayToAllOptions object itself.

setOperationContext

public PlayToAllOptions setOperationContext(String operationContext)

Set the operationContext property.

Parameters:

operationContext - the operationContext value to set.

Returns:

the PlayOptionsInternal object itself.