Package com.azure.communication.callautomation.models

Class PlayToAllOptions

java.lang.Object
com.azure.communication.callautomation.models.PlayToAllOptions
public final class PlayToAllOptions extends Object
The PlayToAllOptions model.

  • Constructor Details

    • PlayToAllOptions

      public PlayToAllOptions(List<PlaySource> playSources)
      Constructor
      Parameters:
      playSources - A List of PlaySource representing the sources to play.

    • PlayToAllOptions

      public PlayToAllOptions(PlaySource playSource)
      Constructor
      Parameters:
      playSource - A PlaySource representing the source to play.

  • Method Details

    • getPlaySources

      public List<PlaySource> getPlaySources()
      Get the play sources.
      Returns:
      the playSource 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.

    • getOperationCallbackUrl

      public String getOperationCallbackUrl()
      Get the overridden call back URL override for operation.
      Returns:
      the operationCallbackUrl

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

    • setOperationContext

      public PlayToAllOptions setOperationContext(String operationContext)
      Set the operationContext property.
      Parameters:
      operationContext - the operationContext 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.

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

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