com.azure.communication.callingserver

Class CallConnectionAsync

java.lang.Object

com.azure.communication.callingserver.CallConnectionAsync

public final class CallConnectionAsync
extends Object

Asynchronous client that supports call connection operations.

Method Summary

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

Play audio in a 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 Mono<PlayAudioResult> playAudio(String audioFileUri,
                                       PlayAudioOptions playAudioOptions)

Play audio in a 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 Mono<com.azure.core.http.rest.Response<PlayAudioResult>> playAudioWithResponse(String audioFileUri,
                                                                                      PlayAudioOptions playAudioOptions)

Play audio in a 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.

hangup

public Mono<Void> hangup()

Hangup a call.

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.

hangupWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> hangupWithResponse()

Hangup a call.

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 Mono<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 payload of the cancel all media operations.

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 Mono<com.azure.core.http.rest.Response<CancelAllMediaOperationsResult>> cancelAllMediaOperationsWithResponse(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 payload of the cancel all media operations.

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 Mono<AddParticipantResult> addParticipant(com.azure.communication.common.CommunicationIdentifier participant,
                                                 String alternateCallerId,
                                                 String operationContext)

Add a participant to the call.

Parameters:

participant - Added participant.

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

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 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 Mono<com.azure.core.http.rest.Response<AddParticipantResult>> addParticipantWithResponse(com.azure.communication.common.CommunicationIdentifier participant,
                                                                                                String alternateCallerId,
                                                                                                String operationContext)

Add a participant to the call.

Parameters:

participant - Added participant.

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

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 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 Mono<Void> removeParticipant(String participantId)

Remove a participant from the call.

Parameters:

participantId - Participant id.

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.

removeParticipantWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> removeParticipantWithResponse(String participantId)

Remove a participant from the call.

Parameters:

participantId - Participant id.

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.