StartRecordingOptions Class

Package:

com.azure.communication.callautomation.models

Maven Artifact:

com.azure:azure-communication-callautomation:1.6.1

• java.lang.Object
• • com.azure.communication.callautomation.models.StartRecordingOptions

public final class StartRecordingOptions

The options for creating a call.

Constructor Summary

Constructor	Description
StartRecordingOptions(CallLocator callLocator)	Constructor
StartRecordingOptions(String callConnectionId)	Constructor

Method Summary

Modifier and Type	Method and Description
List<CommunicationIdentifier>	getAudioChannelParticipantOrdering() Get the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording.
String	getCallConnectionId() Get the call connection ID.
CallLocator	getCallLocator() Get the call locator.
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.
RecordingChannel	getRecordingChannel() Get the channel property.
RecordingContent	getRecordingContent() Get the content property.
RecordingFormat	getRecordingFormat() Get the recording format.
String	getRecordingStateCallbackUrl() Uri to send state change callbacks.
RecordingStorage	getRecordingStorage() Get the externalStorage property: Used to specify external storage for call recording
Boolean	isPauseOnStart() Get pause on start.
StartRecordingOptions	setAudioChannelParticipantOrdering(List<CommunicationIdentifier> audioChannelParticipantOrdering) Set the audioChannelParticipantOrdering property: The sequential order in which audio channels are assigned to participants in the unmixed recording.
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.
StartRecordingOptions	setPauseOnStart(Boolean pauseOnStart) Set the pause on start property.
StartRecordingOptions	setRecordingChannel(RecordingChannel recordingChannel) Set the channel property.
StartRecordingOptions	setRecordingContent(RecordingContent recordingContent) Set the content property.
StartRecordingOptions	setRecordingFormat(RecordingFormat recordingFormat) Set the recording format property.
StartRecordingOptions	setRecordingStateCallbackUrl(String recordingStateCallbackUrl) Set the recordingStateCallbackUrl
StartRecordingOptions	setRecordingStorage(RecordingStorage recordingStorage) Set the externalStorage property: Used to specify external storage for call recording

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

StartRecordingOptions

public StartRecordingOptions(CallLocator callLocator)

Constructor

Parameters:

callLocator - Either a GroupCallLocator or ServerCallLocator for locating the call.

StartRecordingOptions

public StartRecordingOptions(String callConnectionId)

Constructor

Parameters:

callConnectionId - The call connection ID for locating the call.

Method Details

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.

getCallConnectionId

public String getCallConnectionId()

Get the call connection ID.

Returns:

the call connection ID.

getCallLocator

public CallLocator getCallLocator()

Get the call locator.

Returns:

the call locator.

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.

getRecordingChannel

public RecordingChannel getRecordingChannel()

Get the channel property.

Returns:

the channel property.

getRecordingContent

public RecordingContent getRecordingContent()

Get the content property.

Returns:

the content property.

getRecordingFormat

public RecordingFormat getRecordingFormat()

Get the recording format.

Returns:

the recording format.

getRecordingStateCallbackUrl

public String getRecordingStateCallbackUrl()

Uri to send state change callbacks.

Returns:

url to send state change callbacks.

getRecordingStorage

public RecordingStorage getRecordingStorage()

Get the externalStorage property: Used to specify external storage for call recording

Returns:

the externalStorage value.

isPauseOnStart

public Boolean isPauseOnStart()

Get pause on start.

Returns:

pause on start.

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

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.

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

setRecordingChannel

public StartRecordingOptions setRecordingChannel(RecordingChannel recordingChannel)

Set the channel property.

Parameters:

recordingChannel - the RecordingChannel.

Returns:

the StartRecordingOptions

setRecordingContent

public StartRecordingOptions setRecordingContent(RecordingContent recordingContent)

Set the content property.

Parameters:

recordingContent - the RecordingContent.

Returns:

the StartRecordingOptions

setRecordingFormat

public StartRecordingOptions setRecordingFormat(RecordingFormat recordingFormat)

Set the recording format property.

Parameters:

recordingFormat - the RecordingFormat.

Returns:

the StartRecordingOptions

setRecordingStateCallbackUrl

public StartRecordingOptions setRecordingStateCallbackUrl(String recordingStateCallbackUrl)

Set the recordingStateCallbackUrl

Parameters:

recordingStateCallbackUrl - to send state change callbacks.

Returns:

the StartRecordingOptions

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.