Package com.azure.communication.callautomation.models

Class StartRecordingOptions

java.lang.Object
com.azure.communication.callautomation.models.StartRecordingOptions
public final class StartRecordingOptions extends Object
The options for creating a call.

  • Constructor Details

  • Method Details

    • getCallLocator

      public CallLocator getCallLocator()
      Get the call locator.
      Returns:
      the call locator.

    • getRecordingStateCallbackUrl

      public String getRecordingStateCallbackUrl()
      Uri to send state change callbacks.
      Returns:
      url to send state change callbacks.

    • setRecordingStateCallbackUrl

      public StartRecordingOptions setRecordingStateCallbackUrl(String recordingStateCallbackUrl)
      Set the recordingStateCallbackUrl
      Parameters:
      recordingStateCallbackUrl - to send state change callbacks.
      Returns:
      the StartRecordingOptions

    • getRecordingChannel

      public RecordingChannel getRecordingChannel()
      Get the channel property.
      Returns:
      the channel property.

    • setRecordingChannel

      public StartRecordingOptions setRecordingChannel(RecordingChannel recordingChannel)
      Set the channel property.
      Parameters:
      recordingChannel - the RecordingChannel.
      Returns:
      the StartRecordingOptions

    • getRecordingContent

      public RecordingContent getRecordingContent()
      Get the content property.
      Returns:
      the content property.

    • setRecordingContent

      public StartRecordingOptions setRecordingContent(RecordingContent recordingContent)
      Set the content property.
      Parameters:
      recordingContent - the RecordingContent.
      Returns:
      the StartRecordingOptions

    • getRecordingFormat

      public RecordingFormat getRecordingFormat()
      Get the recording format.
      Returns:
      the recording format.

    • setRecordingFormat

      public StartRecordingOptions setRecordingFormat(RecordingFormat recordingFormat)
      Set the recording format property.
      Parameters:
      recordingFormat - the RecordingFormat.
      Returns:
      the StartRecordingOptions

    • isPauseOnStart

      public Boolean isPauseOnStart()
      Get pause on start.
      Returns:
      pause on start.

    • setPauseOnStart

      public StartRecordingOptions setPauseOnStart(Boolean pauseOnStart)
      Set the pause on start property.
      Parameters:
      pauseOnStart - indicate if the recording should be paused on start.
      Returns:
      the StartRecordingOptions

    • getAudioChannelParticipantOrdering

      public List<CommunicationIdentifier> getAudioChannelParticipantOrdering()
      Get the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording. When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified, the audio channel to participant mapping will be automatically assigned based on the order in which participant first audio was detected. Channel to participant mapping details can be found in the metadata of the recording.
      Returns:
      the audioChannelParticipantOrdering value.

    • setAudioChannelParticipantOrdering

      public StartRecordingOptions setAudioChannelParticipantOrdering(List<CommunicationIdentifier> audioChannelParticipantOrdering)
      Set the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording. When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified, the audio channel to participant mapping will be automatically assigned based on the order in which participant first audio was detected. Channel to participant mapping details can be found in the metadata of the recording.
      Parameters:
      audioChannelParticipantOrdering - the list of CommunicationIdentifier.
      Returns:
      the StartRecordingOptions

    • getRecordingStorage

      public RecordingStorage getRecordingStorage()
      Get the externalStorage property: Used to specify external storage for call recording
      Returns:
      the externalStorage value.

    • setRecordingStorage

      public StartRecordingOptions setRecordingStorage(RecordingStorage recordingStorage)
      Set the externalStorage property: Used to specify external storage for call recording
      Parameters:
      recordingStorage - the external storage for call recording
      Returns:
      the StartRecordingOptions object itself.

    • getChannelAffinity

      public List<ChannelAffinity> getChannelAffinity()
      Get the channelAffinity property: The channel affinity of call recording When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned. Channel-Participant mapping details can be found in the metadata of the recording. ///.
      Returns:
      the channelAffinity value.

    • setChannelAffinity

      public StartRecordingOptions setChannelAffinity(List<ChannelAffinity> channelAffinity)
      Set the channelAffinity property: The channel affinity of call recording When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned. Channel-Participant mapping details can be found in the metadata of the recording. ///.
      Parameters:
      channelAffinity - the channelAffinity value to set.
      Returns:
      the StartRecordingOptions object itself.