Package com.azure.communication.callingserver.models

Class PlayAudioOptions

java.lang.Object
com.azure.communication.callingserver.models.PlayAudioOptions
public final class PlayAudioOptions extends Object
The request payload for playing audio.

  • Constructor Details

    • PlayAudioOptions

      public PlayAudioOptions()

  • Method Details

    • isLoop

      public Boolean isLoop()
      Get the loop property: The flag indicating whether audio file needs to be played in loop or not.
      Returns:
      the loop value.

    • setLoop

      public PlayAudioOptions setLoop(Boolean loop)
      Set the loop property: The flag indicating whether audio file needs to be played in loop or not.
      Parameters:
      loop - the loop value to set.
      Returns:
      the PlayAudioOptions object itself.

    • getOperationContext

      public String getOperationContext()
      Get the operationContext property: The value to identify context of the operation.
      Returns:
      the operationContext value.

    • setOperationContext

      public PlayAudioOptions setOperationContext(String operationContext)
      Set the operationContext property: The value to identify context of the operation.
      Parameters:
      operationContext - the operationContext value to set.
      Returns:
      the PlayAudioOptions object itself.

    • getAudioFileId

      public String getAudioFileId()
      Get the audioFileId property: An id for the media in the AudioFileUri, using which we cache the media resource.
      Returns:
      the audioFileId value.

    • setAudioFileId

      public PlayAudioOptions setAudioFileId(String audioFileId)
      Set the audioFileId property: An id for the media in the AudioFileUri, using which we cache the media resource.
      Parameters:
      audioFileId - the audioFileId value to set.
      Returns:
      the PlayAudioOptions object itself.

    • getCallbackUri

      public String getCallbackUri()
      Get the callbackUri property: The callback Uri to receive PlayAudio status notifications.
      Returns:
      the callbackUri value.

    • setCallbackUri

      public PlayAudioOptions setCallbackUri(String callbackUri)
      Set the callbackUri property: The callback Uri to receive PlayAudio status notifications.
      Parameters:
      callbackUri - the callbackUri value to set.
      Returns:
      the PlayAudioOptions object itself.