Package com.azure.communication.callautomation.models

Class PlayOptions

java.lang.Object

com.azure.communication.callautomation.models.PlayOptions

public final class PlayOptions
extends Object

The PlayOptions model.

Constructor Summary

Constructors

Constructor	Description
PlayOptions(PlaySource playSource, List<CommunicationIdentifier> playTo)	Constructor
PlayOptions(List<PlaySource> playSources, List<CommunicationIdentifier> playTo)	Constructor

Method Summary

Modifier and Type	Method	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.
List<CommunicationIdentifier>	getPlayTo()	Get the list of targets to play to.
boolean	isLoop()	Get the loop property: The option to play the provided audio source in loop when set to true.
PlayOptions	setLoop(boolean loop)	Set the loop property: The option to play the provided audio source in loop when set to true.
PlayOptions	setOperationCallbackUrl(String operationCallbackUrl)	Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
PlayOptions	setOperationContext(String operationContext)	Set the operationContext property.

Methods inherited from class java.lang.Object

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

Constructor Details

PlayOptions

public PlayOptions(List<PlaySource> playSources,
 List<CommunicationIdentifier> playTo)

Constructor

Parameters:

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

playTo - The targets to play to.

PlayOptions

public PlayOptions(PlaySource playSource,
 List<CommunicationIdentifier> playTo)

Constructor

Parameters:

playSource - A PlaySource representing the source to play.

playTo - The targets to play to.

Method Details

getPlaySources

public List<PlaySource> getPlaySources()

Get the play sources.

Returns:

the playSources value.

getPlayTo

public List<CommunicationIdentifier> getPlayTo()

Get the list of targets to play to.

Returns:

the playTo 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.

getOperationContext

public String getOperationContext()

Get the operationContext property.

Returns:

the operationContext value.

setLoop

public PlayOptions 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.

setOperationContext

public PlayOptions setOperationContext(String operationContext)

Set the operationContext property.

Parameters:

operationContext - the operationContext value to set.

Returns:

the PlayOptionsInternal object itself.

getOperationCallbackUrl

public String getOperationCallbackUrl()

Get the overridden call back URL override for operation.

Returns:

the operationCallbackUrl

setOperationCallbackUrl

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