com.azure.communication.callingserver

Class CallingServerClient

java.lang.Object

com.azure.communication.callingserver.CallingServerClient

public final class CallingServerClient
extends Object

Synchronous client that supports calling server operations.

Instantiating a synchronous Calling Server Client

 HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(/* add policies */)
     .build();
 
 CallingServerClient callingServerClient = new CallingServerClientBuilder()
     .pipeline(pipeline)
     .connectionString(connectionString)
     .buildClient();
 

View this for additional ways to construct the client.

See Also:

CallingServerClientBuilder

Method Summary

Modifier and Type	Method and Description
CallConnection	createCallConnection(com.azure.communication.common.CommunicationIdentifier source, List<com.azure.communication.common.CommunicationIdentifier> targets, CreateCallOptions createCallOptions) Create a call connection request from source identity to targets identity.
com.azure.core.http.rest.Response<CallConnection>	createCallConnectionWithResponse(com.azure.communication.common.CommunicationIdentifier source, List<com.azure.communication.common.CommunicationIdentifier> targets, CreateCallOptions createCallOptions, com.azure.core.util.Context context) Create a Call Connection Request from source identity to targets identity.
void	downloadTo(String sourceEndpoint, OutputStream destinationStream, com.azure.core.http.HttpRange httpRange) Download the recording content, e.g.
void	downloadTo(String sourceEndpoint, Path destinationPath, ParallelDownloadOptions parallelDownloadOptions, boolean overwrite) Download the content located in endpoint into a file marked by path.
com.azure.core.http.rest.Response<Void>	downloadToWithResponse(String sourceEndpoint, OutputStream destinationStream, com.azure.core.http.HttpRange httpRange, com.azure.core.util.Context context) Download the recording content, e.g.
com.azure.core.http.rest.Response<Void>	downloadToWithResponse(String sourceEndpoint, Path destinationPath, ParallelDownloadOptions parallelDownloadOptions, boolean overwrite, com.azure.core.util.Context context) Download the content located in endpoint into a file marked by path.
CallConnection	getCallConnection(String callConnectionId) Get CallConnection object
ServerCall	initializeServerCall(String serverCallId) Get ServerCall object
CallConnection	joinCall(String serverCallId, com.azure.communication.common.CommunicationIdentifier source, JoinCallOptions joinCallOptions) Join a call
com.azure.core.http.rest.Response<CallConnection>	joinCallWithResponse(String serverCallId, com.azure.communication.common.CommunicationIdentifier source, JoinCallOptions joinCallOptions, com.azure.core.util.Context context) Join a call

Methods inherited from class java.lang.Object

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

Method Detail

createCallConnection

public CallConnection createCallConnection(com.azure.communication.common.CommunicationIdentifier source,
                                           List<com.azure.communication.common.CommunicationIdentifier> targets,
                                           CreateCallOptions createCallOptions)

Create a call connection request from source identity to targets identity.

Parameters:

source - The source of the call.

targets - The targets of the call.

createCallOptions - The call Options.

Returns:

Response for a successful CreateCallConnection request.

 List<CommunicationIdentifier> targets = Arrays.asList(firstCallee, secondCallee);
 List<MediaType> requestedMediaTypes = Arrays.asList(MediaType.AUDIO, MediaType.VIDEO);
 List<EventSubscriptionType> requestedCallEvents = Arrays.asList(
     EventSubscriptionType.DTMF_RECEIVED,
     EventSubscriptionType.PARTICIPANTS_UPDATED);
 CreateCallOptions createCallOptions = new CreateCallOptions(
     callbackUri,
     requestedMediaTypes,
     requestedCallEvents);
 CallConnection callConnection = callingServerClient.createCallConnection(source, targets, createCallOptions);
 

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

createCallConnectionWithResponse

public com.azure.core.http.rest.Response<CallConnection> createCallConnectionWithResponse(com.azure.communication.common.CommunicationIdentifier source,
                                                                                          List<com.azure.communication.common.CommunicationIdentifier> targets,
                                                                                          CreateCallOptions createCallOptions,
                                                                                          com.azure.core.util.Context context)

Create a Call Connection Request from source identity to targets identity.

Parameters:

source - The source of the call.

targets - The targets of the call.

createCallOptions - The call Options.

context - A Context representing the request context.

Returns:

Response for a successful CreateCallConnection request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

joinCall

public CallConnection joinCall(String serverCallId,
                               com.azure.communication.common.CommunicationIdentifier source,
                               JoinCallOptions joinCallOptions)

Join a call

Parameters:

serverCallId - The server call id.

source - of Join Call request.

joinCallOptions - to Join Call.

Returns:

CallConnection for a successful join request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

joinCallWithResponse

public com.azure.core.http.rest.Response<CallConnection> joinCallWithResponse(String serverCallId,
                                                                              com.azure.communication.common.CommunicationIdentifier source,
                                                                              JoinCallOptions joinCallOptions,
                                                                              com.azure.core.util.Context context)

Join a call

Parameters:

serverCallId - The server call id.

source - of Join Call request.

joinCallOptions - to Join Call.

context - A Context representing the request context.

Returns:

Response for a successful join request.

Throws:

CallingServerErrorException - thrown if the request is rejected by server.

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

getCallConnection

public CallConnection getCallConnection(String callConnectionId)

Get CallConnection object

Parameters:

callConnectionId - The call connection id.

Returns:

CallConnection.

initializeServerCall

public ServerCall initializeServerCall(String serverCallId)

Get ServerCall object

Parameters:

serverCallId - Server call id.

Returns:

ServerCall

downloadTo

public void downloadTo(String sourceEndpoint,
                       OutputStream destinationStream,
                       com.azure.core.http.HttpRange httpRange)

Download the recording content, e.g. Recording's metadata, Recording video, etc., from endpoint and write it into the OutputStream passed as parameter.

Parameters:

sourceEndpoint - - ACS URL where the content is located.

destinationStream - - A stream where to write the downloaded content.

httpRange - - An optional HttpRange value containing the range of bytes to download. If missing, the whole content will be downloaded.

downloadToWithResponse

public com.azure.core.http.rest.Response<Void> downloadToWithResponse(String sourceEndpoint,
                                                                      OutputStream destinationStream,
                                                                      com.azure.core.http.HttpRange httpRange,
                                                                      com.azure.core.util.Context context)

Download the recording content, e.g. Recording's metadata, Recording video, etc., from endpoint and write it in the OutputStream passed as parameter.

Parameters:

sourceEndpoint - - ACS URL where the content is located.

destinationStream - - A stream where to write the downloaded content.

httpRange - - An optional HttpRange value containing the range of bytes to download. If missing, the whole content will be downloaded.

context - A Context representing the request context.

Returns:

Response containing the http response information from the download.

downloadTo

public void downloadTo(String sourceEndpoint,
                       Path destinationPath,
                       ParallelDownloadOptions parallelDownloadOptions,
                       boolean overwrite)

Download the content located in endpoint into a file marked by path. This download will be done using parallel workers.

Parameters:

sourceEndpoint - - ACS URL where the content is located.

destinationPath - - File location.

parallelDownloadOptions - - an optional ParallelDownloadOptions object to modify how the parallel download will work.

overwrite - - True to overwrite the file if it exists.

downloadToWithResponse

public com.azure.core.http.rest.Response<Void> downloadToWithResponse(String sourceEndpoint,
                                                                      Path destinationPath,
                                                                      ParallelDownloadOptions parallelDownloadOptions,
                                                                      boolean overwrite,
                                                                      com.azure.core.util.Context context)

Download the content located in endpoint into a file marked by path. This download will be done using parallel workers.

Parameters:

sourceEndpoint - - ACS URL where the content is located.

destinationPath - - File location.

parallelDownloadOptions - - an optional ParallelDownloadOptions object to modify how the parallel download will work.

overwrite - - True to overwrite the file if it exists.

context - A Context representing the request context.

Returns:

Response containing the http response information from the download.