com.azure.communication.callingserver

Class CallConnection

java.lang.Object

com.azure.communication.callingserver.CallConnection

public final class CallConnection
extends Object

Synchronous Client that supports call connection operations.

Method Summary

Modifier and Type	Method and Description
AddParticipantResult	addParticipant(com.azure.communication.common.CommunicationIdentifier participant, 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 alternateCallerId, String operationContext, com.azure.core.util.Context context) Add a participant to the call.
CancelAllMediaOperationsResult	cancelAllMediaOperations(String operationContext) Cancel all media operations in the call.
com.azure.core.http.rest.Response<CancelAllMediaOperationsResult>	cancelAllMediaOperationsWithResponse(String operationContext, com.azure.core.util.Context context) Cancel all media operations in the call.
String	getCallConnectionId() Get the call connection id property.
void	hangup() Disconnect from a call.
com.azure.core.http.rest.Response<Void>	hangupWithResponse(com.azure.core.util.Context context) Disconnect from a call.
PlayAudioResult	playAudio(String audioFileUri, boolean loop, String audioFileId, String callbackUri, String operationContext) Play audio in the call.
PlayAudioResult	playAudio(String audioFileUri, PlayAudioOptions playAudioOptions) Play audio in the call.
com.azure.core.http.rest.Response<PlayAudioResult>	playAudioWithResponse(String audioFileUri, PlayAudioOptions playAudioOptions, com.azure.core.util.Context context) Play audio in the 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.

Methods inherited from class java.lang.Object

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

Method Detail

getCallConnectionId

public String getCallConnectionId()

Get the call connection id property.

Returns:

Call connection id value.

playAudio

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

Play audio in the call.

Parameters:

audioFileUri - The 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.

loop - The flag indicating whether audio file needs to be played in loop or not.

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

callbackUri - call back uri to receive notifications.

operationContext - The 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 the call.

Parameters:

audioFileUri - The 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 the call.

Parameters:

audioFileUri - The 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.

hangup

public void hangup()

Disconnect from a call.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

hangupWithResponse

public com.azure.core.http.rest.Response<Void> hangupWithResponse(com.azure.core.util.Context context)

Disconnect from a call.

Parameters:

context - A Context representing the request context.

Returns:

Response for a successful hangup request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

cancelAllMediaOperations

public CancelAllMediaOperationsResult cancelAllMediaOperations(String operationContext)

Cancel all media operations in the call.

Parameters:

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

Returns:

Response for a successful cancel all media operations request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

cancelAllMediaOperationsWithResponse

public com.azure.core.http.rest.Response<CancelAllMediaOperationsResult> cancelAllMediaOperationsWithResponse(String operationContext,
                                                                                                              com.azure.core.util.Context context)

Cancel all media operations in the call.

Parameters:

operationContext - The 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 cancel all media operations request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

addParticipant

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

Add a participant to the call.

Parameters:

participant - Added participant.

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 alternateCallerId,
                                                                                          String operationContext,
                                                                                          com.azure.core.util.Context context)

Add a participant to the call.

Parameters:

participant - Added participant.

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 - 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.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

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.