com.azure.communication.callingserver

Class ServerCall

java.lang.Object

com.azure.communication.callingserver.ServerCall

public final class ServerCall
extends Object

Synchronous Client that supports server call operations.

Method Summary

Modifier and Type	Method and Description
AddParticipantResult	addParticipant(com.azure.communication.common.CommunicationIdentifier participant, String callBackUri, String alternateCallerId, String operationContext) Add a participant to the call.
com.azure.core.http.rest.Response<AddParticipantResult>	addParticipantWithResponse(com.azure.communication.common.CommunicationIdentifier participant, String callBackUri, String alternateCallerId, String operationContext, com.azure.core.util.Context context) Add a participant to the call.
CallRecordingProperties	getRecordingState(String recordingId) Get the current recording state by recording id.
com.azure.core.http.rest.Response<CallRecordingProperties>	getRecordingStateWithResponse(String recordingId, com.azure.core.util.Context context) Get the current recording state by recording id.
String	getServerCallId() Get server call id property.
void	pauseRecording(String recordingId) Pause recording of the call.
com.azure.core.http.rest.Response<Void>	pauseRecordingWithResponse(String recordingId, com.azure.core.util.Context context) Pause recording of the call.
PlayAudioResult	playAudio(String audioFileUri, PlayAudioOptions playAudioOptions) Play audio in a call.
PlayAudioResult	playAudio(String audioFileUri, String audioFileId, String callbackUri, String operationContext) Play audio in a call.
com.azure.core.http.rest.Response<PlayAudioResult>	playAudioWithResponse(String audioFileUri, PlayAudioOptions playAudioOptions, com.azure.core.util.Context context) Play audio in a call.
void	removeParticipant(String participantId) Remove a participant from the call.
com.azure.core.http.rest.Response<Void>	removeParticipantWithResponse(String participantId, com.azure.core.util.Context context) Remove a participant from the call.
void	resumeRecording(String recordingId) Resume recording of the call.
com.azure.core.http.rest.Response<Void>	resumeRecordingWithResponse(String recordingId, com.azure.core.util.Context context) Resume recording of the call.
StartCallRecordingResult	startRecording(String recordingStateCallbackUri) Start recording of the call.
com.azure.core.http.rest.Response<StartCallRecordingResult>	startRecordingWithResponse(String recordingStateCallbackUri, StartRecordingOptions startRecordingOptions, com.azure.core.util.Context context) Start recording of the call.
void	stopRecording(String recordingId) Stop recording of the call.
com.azure.core.http.rest.Response<Void>	stopRecordingWithResponse(String recordingId, com.azure.core.util.Context context) Stop recording of the call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getServerCallId

public String getServerCallId()

Get server call id property.

Returns:

Server call id value.

addParticipant

public AddParticipantResult addParticipant(com.azure.communication.common.CommunicationIdentifier participant,
                                           String callBackUri,
                                           String alternateCallerId,
                                           String operationContext)

Add a participant to the call.

Parameters:

participant - Added participant.

callBackUri - CallBackUri to get notifications.

alternateCallerId - Phone number to use when adding a phone number participant.

operationContext - Value to identify context of the operation. This is used to co-relate other communications related to this operation

Returns:

Response for a successful add participant request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addParticipantWithResponse

public com.azure.core.http.rest.Response<AddParticipantResult> addParticipantWithResponse(com.azure.communication.common.CommunicationIdentifier participant,
                                                                                          String callBackUri,
                                                                                          String alternateCallerId,
                                                                                          String operationContext,
                                                                                          com.azure.core.util.Context context)

Add a participant to the call.

Parameters:

participant - Added participant.

callBackUri - CallBackUri to get notifications.

alternateCallerId - Phone number to use when adding a phone number participant.

operationContext - Value to identify context of the operation. This is used to co-relate other communications related to this operation

context - A Context representing the request context.

Returns:

Response for a successful add participant request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeParticipant

public void removeParticipant(String participantId)

Remove a participant from the call.

Parameters:

participantId - Participant id.

removeParticipantWithResponse

public com.azure.core.http.rest.Response<Void> removeParticipantWithResponse(String participantId,
                                                                             com.azure.core.util.Context context)

Remove a participant from the call.

Parameters:

participantId - Participant id.

context - Context representing the request context.

Returns:

Response for a successful remove participant request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

startRecording

public StartCallRecordingResult startRecording(String recordingStateCallbackUri)

Start recording of the call.

Parameters:

recordingStateCallbackUri - Uri to send state change callbacks.

Returns:

Result for a successful start recording request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

startRecordingWithResponse

public com.azure.core.http.rest.Response<StartCallRecordingResult> startRecordingWithResponse(String recordingStateCallbackUri,
                                                                                              StartRecordingOptions startRecordingOptions,
                                                                                              com.azure.core.util.Context context)

Start recording of the call.

Parameters:

recordingStateCallbackUri - Uri to send state change callbacks.

startRecordingOptions - StartRecordingOptions custom options.

context - A Context representing the request context.

Returns:

Result for a successful start recording request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

stopRecording

public void stopRecording(String recordingId)

Stop recording of the call.

Parameters:

recordingId - Recording id to stop.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

stopRecordingWithResponse

public com.azure.core.http.rest.Response<Void> stopRecordingWithResponse(String recordingId,
                                                                         com.azure.core.util.Context context)

Stop recording of the call.

Parameters:

recordingId - Recording id to stop.

context - A Context representing the request context.

Returns:

Response for a successful stop recording request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

pauseRecording

public void pauseRecording(String recordingId)

Pause recording of the call.

Parameters:

recordingId - Recording id to stop.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

pauseRecordingWithResponse

public com.azure.core.http.rest.Response<Void> pauseRecordingWithResponse(String recordingId,
                                                                          com.azure.core.util.Context context)

Pause recording of the call.

Parameters:

recordingId - Recording id to stop.

context - A Context representing the request context.

Returns:

Response for a successful pause recording request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

resumeRecording

public void resumeRecording(String recordingId)

Resume recording of the call.

Parameters:

recordingId - The recording id to stop.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

resumeRecordingWithResponse

public com.azure.core.http.rest.Response<Void> resumeRecordingWithResponse(String recordingId,
                                                                           com.azure.core.util.Context context)

Resume recording of the call.

Parameters:

recordingId - The recording id to stop.

context - A Context representing the request context.

Returns:

Response for a successful resume recording request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRecordingState

public CallRecordingProperties getRecordingState(String recordingId)

Get the current recording state by recording id.

Parameters:

recordingId - The recording id to stop.

Returns:

Response for a successful get recording state request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRecordingStateWithResponse

public com.azure.core.http.rest.Response<CallRecordingProperties> getRecordingStateWithResponse(String recordingId,
                                                                                                com.azure.core.util.Context context)

Get the current recording state by recording id.

Parameters:

recordingId - The recording id to stop.

context - A Context representing the request context.

Returns:

Response for a successful get recording state request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

playAudio

public PlayAudioResult playAudio(String audioFileUri,
                                 String audioFileId,
                                 String callbackUri,
                                 String operationContext)

Play audio in a call.

Parameters:

audioFileUri - Media resource uri of the play audio request. Currently only Wave file (.wav) format audio prompts are supported. More specifically, the audio content in the wave file must be mono (single-channel), 16-bit samples with a 16,000 (16KHz) sampling rate.

audioFileId - Id for the media in the AudioFileUri, using which we cache the media.

callbackUri - Callback Uri to receive PlayAudio status notifications.

operationContext - Value to identify context of the operation. This is used to co-relate other communications related to this operation

Returns:

Response payload for play audio operation.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

playAudio

public PlayAudioResult playAudio(String audioFileUri,
                                 PlayAudioOptions playAudioOptions)

Play audio in a call.

Parameters:

audioFileUri - Media resource uri of the play audio request. Currently only Wave file (.wav) format audio prompts are supported. More specifically, the audio content in the wave file must be mono (single-channel), 16-bit samples with a 16,000 (16KHz) sampling rate.

playAudioOptions - Options for play audio.

Returns:

Response payload for play audio operation.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

playAudioWithResponse

public com.azure.core.http.rest.Response<PlayAudioResult> playAudioWithResponse(String audioFileUri,
                                                                                PlayAudioOptions playAudioOptions,
                                                                                com.azure.core.util.Context context)

Play audio in a call.

Parameters:

audioFileUri - Media resource uri of the play audio request. Currently only Wave file (.wav) format audio prompts are supported. More specifically, the audio content in the wave file must be mono (single-channel), 16-bit samples with a 16,000 (16KHz) sampling rate.

playAudioOptions - Options for play audio.

context - A Context representing the request context.

Returns:

Response payload for play audio operation.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.