Class StartRecordingOptions
java.lang.Object
com.azure.communication.callautomation.models.StartRecordingOptions
The options for creating a call.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionList<com.azure.communication.common.CommunicationIdentifier>
Get the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording.Get the call locator.Get the channel property.Get the content property.Get the recording format.Uri to send state change callbacks.Get the Repeatability headers configuration.setAudioChannelParticipantOrdering
(List<com.azure.communication.common.CommunicationIdentifier> audioChannelParticipantOrdering) Set the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording.setRecordingChannel
(RecordingChannel recordingChannel) Set the channel property.setRecordingContent
(RecordingContent recordingContent) Set the content property.setRecordingFormat
(RecordingFormat recordingFormat) Set the recording format property.setRecordingStateCallbackUrl
(String recordingStateCallbackUrl) Set the recordingStateCallbackUrlsetRepeatabilityHeaders
(RepeatabilityHeaders repeatabilityHeaders) Set the repeatability headers
-
Constructor Details
-
StartRecordingOptions
Constructor- Parameters:
callLocator
- Either aGroupCallLocator
orServerCallLocator
for locating the call.
-
-
Method Details
-
getCallLocator
Get the call locator.- Returns:
- the call locator.
-
getRecordingStateCallbackUrl
Uri to send state change callbacks.- Returns:
- url to send state change callbacks.
-
setRecordingStateCallbackUrl
Set the recordingStateCallbackUrl- Parameters:
recordingStateCallbackUrl
- to send state change callbacks.- Returns:
- the
StartRecordingOptions
-
getRecordingChannel
Get the channel property.- Returns:
- the channel property.
-
setRecordingChannel
Set the channel property.- Parameters:
recordingChannel
- theRecordingChannel
.- Returns:
- the
StartRecordingOptions
-
getRecordingContent
Get the content property.- Returns:
- the content property.
-
setRecordingContent
Set the content property.- Parameters:
recordingContent
- theRecordingContent
.- Returns:
- the
StartRecordingOptions
-
getRecordingFormat
Get the recording format.- Returns:
- the recording format.
-
setRecordingFormat
Set the recording format property.- Parameters:
recordingFormat
- theRecordingFormat
.- Returns:
- the
StartRecordingOptions
-
getAudioChannelParticipantOrdering
public List<com.azure.communication.common.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<com.azure.communication.common.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 ofCommunicationIdentifier
.- Returns:
- the
StartRecordingOptions
-
getRepeatabilityHeaders
Get the Repeatability headers configuration.- Returns:
- the repeatabilityHeaders
-
setRepeatabilityHeaders
Set the repeatability headers- Parameters:
repeatabilityHeaders
- The repeatability headers configuration.- Returns:
- the StartRecordingOptions object itself.
-