CallRecording Class

Package:

com.azure.communication.callautomation

Maven Artifact:

com.azure:azure-communication-callautomation:1.6.1

• java.lang.Object
• • com.azure.communication.callautomation.CallRecording

public final class CallRecording

CallRecording.

Method Summary

Modifier and Type	Method and Description
void	delete(String deleteUrl) Delete the content located in the deleteUrl
Response<Void>	deleteWithResponse(String deleteUrl, Context context) Delete the content located in the deleteUrl
BinaryData	downloadContent(String sourceUrl) Downloads the entire content.
Response<BinaryData>	downloadContentWithResponse(String sourceUrl, HttpRange range, Context context) Downloads the entire content.
void	downloadTo(String sourceUrl, OutputStream destinationStream) Download the recording content, e.g.
void	downloadTo(String sourceUrl, OutputStream destinationStream, HttpRange httpRange, Context context) Download the recording content, e.g.
void	downloadTo(String sourceUrl, Path destinationPath) Download the content located in endpoint into a file marked by path.
void	downloadTo(String sourceUrl, Path destinationPath, DownloadToFileOptions options, Context context) Download the content located in endpoint into a file marked by path.
RecordingStateResult	getState(String recordingId) Get the current recording state by recording id.
Response<RecordingStateResult>	getStateWithResponse(String recordingId, Context context) Get the current recording state by recording id.
void	pause(String recordingId) Pause recording of the call.
Response<Void>	pauseWithResponse(String recordingId, Context context) Pause recording of the call.
void	resume(String recordingId) Resume recording of the call.
Response<Void>	resumeWithResponse(String recordingId, Context context) Resume recording of the call.
RecordingStateResult	start(StartRecordingOptions options) Start recording of the call.
Response<RecordingStateResult>	startWithResponse(StartRecordingOptions options, Context context) Start recording of the call.
void	stop(String recordingId) Stop recording of the call.
Response<Void>	stopWithResponse(String recordingId, Context context) Stop recording of the call.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

delete

public void delete(String deleteUrl)

Delete the content located in the deleteUrl

Parameters:

deleteUrl -

• ACS URL where the content is located.

deleteWithResponse

public Response<Void> deleteWithResponse(String deleteUrl, Context context)

Delete the content located in the deleteUrl

Parameters:

deleteUrl -

• ACS URL where the content is located.

context - A Context representing the request context.

Returns:

Response for successful delete request..

downloadContent

public BinaryData downloadContent(String sourceUrl)

Downloads the entire content.

This method supports downloads up to 2GB of data. Use downloadTo(String sourceUrl, OutputStream destinationStream) to download larger blobs.

Parameters:

sourceUrl -

• ACS URL where the content is located.

Returns:

The content of the blob.

downloadContentWithResponse

public Response<BinaryData> downloadContentWithResponse(String sourceUrl, HttpRange range, Context context)

Downloads the entire content.

This method supports downloads up to 2GB of data. Use downloadTo(String sourceUrl, OutputStream destinationStream, HttpRange httpRange, Context context) to download larger blobs.

Parameters:

sourceUrl - ACS URL where the content is located.

range - 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:

The content of the blob.

downloadTo

public void downloadTo(String sourceUrl, OutputStream destinationStream)

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

Parameters:

sourceUrl -

• ACS URL where the content is located.

destinationStream -

• A stream where to write the downloaded content.

downloadTo

public void downloadTo(String sourceUrl, OutputStream destinationStream, HttpRange httpRange, 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:

sourceUrl -

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

downloadTo

public void downloadTo(String sourceUrl, Path destinationPath)

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

Parameters:

sourceUrl -

• ACS URL where the content is located.

destinationPath -

• File location.

downloadTo

public void downloadTo(String sourceUrl, Path destinationPath, DownloadToFileOptions options, Context context)

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

Parameters:

sourceUrl -

• ACS URL where the content is located.

destinationPath -

• File location.

options -

• an optional DownloadToFileOptions object to modify how the download will work.

context - A Context representing the request context.

getState

public RecordingStateResult getState(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.

getStateWithResponse

public Response<RecordingStateResult> getStateWithResponse(String recordingId, 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.

pause

public void pause(String recordingId)

Pause recording of the call.

Parameters:

recordingId - Recording id to stop.

pauseWithResponse

public Response<Void> pauseWithResponse(String recordingId, 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.

resume

public void resume(String recordingId)

Resume recording of the call.

Parameters:

recordingId - The recording id to stop.

resumeWithResponse

public Response<Void> resumeWithResponse(String recordingId, 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.

start

public RecordingStateResult start(StartRecordingOptions options)

Start recording of the call.

Parameters:

options - A StartRecordingOptions object containing different options for recording.

Returns:

Result for a successful start recording request.

startWithResponse

public Response<RecordingStateResult> startWithResponse(StartRecordingOptions options, Context context)

Start recording of the call.

Parameters:

options - A StartRecordingOptions object containing different options for recording.

context - A Context representing the request context.

Returns:

Result for a successful start recording request.

stop

public void stop(String recordingId)

Stop recording of the call.

Parameters:

recordingId - Recording id to stop.

stopWithResponse

public Response<Void> stopWithResponse(String recordingId, 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.