CallMedia Class

Package:

com.azure.communication.callautomation

Maven Artifact:

com.azure:azure-communication-callautomation:1.6.1

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

public final class CallMedia

CallContent.

Method Summary

Modifier and Type	Method and Description
void	cancelAllMediaOperations() Cancels all the queued media operations.
Response<Void>	cancelAllMediaOperationsWithResponse(Context context) Cancels all the queued media operations
void	hold(CommunicationIdentifier targetParticipant) Holds participant in call.
void	hold(CommunicationIdentifier targetParticipant, PlaySource playSource) Holds participant in call.
Response<Void>	holdWithResponse(HoldOptions options, Context context) Holds participant in call.
void	play(List<PlaySource> playSources, List<CommunicationIdentifier> playTo) Play
void	play(PlaySource playSource, List<CommunicationIdentifier> playTo) Play
void	playToAll(List<PlaySource> playSources) Play to all participants
void	playToAll(PlaySource playSource) Play to all participants
Response<Void>	playToAllWithResponse(PlayToAllOptions options, Context context) PlayAllWithResponse
Response<Void>	playWithResponse(PlayOptions options, Context context) PlayWithResponse
SendDtmfTonesResult	sendDtmfTones(List<DtmfTone> tones, CommunicationIdentifier targetParticipant) Sends Dtmf tones
Response<SendDtmfTonesResult>	sendDtmfTonesWithResponse(SendDtmfTonesOptions options, Context context) Sends Dtmf tones
void	startContinuousDtmfRecognition(CommunicationIdentifier targetParticipant) Starts continuous Dtmf recognition.
Response<Void>	startContinuousDtmfRecognitionWithResponse(ContinuousDtmfRecognitionOptions options, Context context) Starts continuous Dtmf recognition.
void	startMediaStreaming() Starts media streaming in the call.
Response<Void>	startMediaStreamingWithResponse(StartMediaStreamingOptions options, Context context) Starts media streaming in the call.
void	startRecognizing(CallMediaRecognizeOptions callMediaRecognizeOptions) Recognize tones.
Response<Void>	startRecognizingWithResponse(CallMediaRecognizeOptions callMediaRecognizeOptions, Context context) Recognize tones.
void	startTranscription() Starts transcription in the call.
Response<Void>	startTranscriptionWithResponse(StartTranscriptionOptions options, Context context) Starts transcription in the call.
void	stopContinuousDtmfRecognition(CommunicationIdentifier targetParticipant) Stops continuous Dtmf recognition.
Response<Void>	stopContinuousDtmfRecognitionWithResponse(ContinuousDtmfRecognitionOptions options, Context context) Stops continuous Dtmf recognition.
void	stopMediaStreaming() Stop media streaming in the call.
Response<Void>	stopMediaStreamingWithResponse(StopMediaStreamingOptions options, Context context) Stop media streaming in the call.
void	stopTranscription() Stops transcription in the call.
Response<Void>	stopTranscriptionWithResponse(StopTranscriptionOptions options, Context context) Stops transcription in the call.
void	unhold(CommunicationIdentifier targetParticipant) Removes hold from participant in call.
Response<Void>	unholdWithResponse(UnholdOptions options, Context context) Removes hold from participant in call.
void	updateTranscription(String locale) Updates transcription language in the call.
Response<Void>	updateTranscriptionWithResponse(UpdateTranscriptionOptions options, Context context) Updates transcription language in the call.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

cancelAllMediaOperations

public void cancelAllMediaOperations()

Cancels all the queued media operations.

cancelAllMediaOperationsWithResponse

public Response<Void> cancelAllMediaOperationsWithResponse(Context context)

Cancels all the queued media operations

Parameters:

context - A Context representing the request context.

Returns:

Response for successful playAll request.

hold

public void hold(CommunicationIdentifier targetParticipant)

Holds participant in call.

Parameters:

targetParticipant - the target.

hold

public void hold(CommunicationIdentifier targetParticipant, PlaySource playSource)

Holds participant in call.

Parameters:

targetParticipant - the target.

playSource - A PlaySource representing the source to play.

holdWithResponse

public Response<Void> holdWithResponse(HoldOptions options, Context context)

Holds participant in call.

Parameters:

options -

• Different options to pass to the request.

context - Context

Returns:

Response for successful operation.

play

public void play(List<PlaySource> playSources, List<CommunicationIdentifier> playTo)

Play

Parameters:

playSources - A List of PlaySource representing the sources to play.

playTo - the targets to play to.

play

public void play(PlaySource playSource, List<CommunicationIdentifier> playTo)

Play

Parameters:

playSource - A PlaySource representing the source to play.

playTo - the targets to play to.

playToAll

public void playToAll(List<PlaySource> playSources)

Play to all participants

Parameters:

playSources - A List of PlaySource representing the sources to play.

playToAll

public void playToAll(PlaySource playSource)

Play to all participants

Parameters:

playSource - A PlaySource representing the source to play.

playToAllWithResponse

public Response<Void> playToAllWithResponse(PlayToAllOptions options, Context context)

PlayAllWithResponse

Parameters:

options - play options.

context - A Context representing the request context.

Returns:

Response for successful playAll request.

playWithResponse

public Response<Void> playWithResponse(PlayOptions options, Context context)

PlayWithResponse

Parameters:

options - play options.

context - A Context representing the request context.

Returns:

Response for successful play request.

sendDtmfTones

public SendDtmfTonesResult sendDtmfTones(List<DtmfTone> tones, CommunicationIdentifier targetParticipant)

Sends Dtmf tones

Parameters:

tones - tones to be sent

targetParticipant - the target participant

Returns:

Response for successful sendDtmfTones request.

sendDtmfTonesWithResponse

public Response<SendDtmfTonesResult> sendDtmfTonesWithResponse(SendDtmfTonesOptions options, Context context)

Sends Dtmf tones

Parameters:

options - SendDtmfTones configuration options

context - Context

Returns:

Response for successful sendDtmfTones request.

startContinuousDtmfRecognition

public void startContinuousDtmfRecognition(CommunicationIdentifier targetParticipant)

Starts continuous Dtmf recognition.

Parameters:

targetParticipant - the target participant

startContinuousDtmfRecognitionWithResponse

public Response<Void> startContinuousDtmfRecognitionWithResponse(ContinuousDtmfRecognitionOptions options, Context context)

Starts continuous Dtmf recognition.

Parameters:

options - ContinuousDtmfRecognition configuration options

context - Context

Returns:

Response for successful start continuous dtmf recognition request.

startMediaStreaming

public void startMediaStreaming()

Starts media streaming in the call.

startMediaStreamingWithResponse

public Response<Void> startMediaStreamingWithResponse(StartMediaStreamingOptions options, Context context)

Starts media streaming in the call.

Parameters:

options - Options for the start media streaming operation.

context - Context

Returns:

Response for successful start transcription request.

startRecognizing

public void startRecognizing(CallMediaRecognizeOptions callMediaRecognizeOptions)

Recognize tones.

Parameters:

callMediaRecognizeOptions - Optional elements for recognize.

startRecognizingWithResponse

public Response<Void> startRecognizingWithResponse(CallMediaRecognizeOptions callMediaRecognizeOptions, Context context)

Recognize tones.

Parameters:

callMediaRecognizeOptions - Optional elements for recognize.

context - A Context representing the request context.

Returns:

Response for a successful recognize request.

startTranscription

public void startTranscription()

Starts transcription in the call.

startTranscriptionWithResponse

public Response<Void> startTranscriptionWithResponse(StartTranscriptionOptions options, Context context)

Starts transcription in the call.

Parameters:

options - Options for the Start Transcription operation.

context - Context

Returns:

Response for successful start transcription request.

stopContinuousDtmfRecognition

public void stopContinuousDtmfRecognition(CommunicationIdentifier targetParticipant)

Stops continuous Dtmf recognition.

Parameters:

targetParticipant - the target participant

stopContinuousDtmfRecognitionWithResponse

public Response<Void> stopContinuousDtmfRecognitionWithResponse(ContinuousDtmfRecognitionOptions options, Context context)

Stops continuous Dtmf recognition.

Parameters:

options - ContinuousDtmfRecognition configuration options

context - Context

Returns:

Response for successful stop continuous dtmf recognition request.

stopMediaStreaming

public void stopMediaStreaming()

Stop media streaming in the call.

stopMediaStreamingWithResponse

public Response<Void> stopMediaStreamingWithResponse(StopMediaStreamingOptions options, Context context)

Stop media streaming in the call.

Parameters:

options - Options for the stop media streaming operation.

context - Context

Returns:

Response for successful stop transcription request.

stopTranscription

public void stopTranscription()

Stops transcription in the call.

stopTranscriptionWithResponse

public Response<Void> stopTranscriptionWithResponse(StopTranscriptionOptions options, Context context)

Stops transcription in the call.

Parameters:

options - Options for the Stop Transcription operation.

context - Context

Returns:

Response for successful stop transcription request.

unhold

public void unhold(CommunicationIdentifier targetParticipant)

Removes hold from participant in call.

Parameters:

targetParticipant - the target.

unholdWithResponse

public Response<Void> unholdWithResponse(UnholdOptions options, Context context)

Removes hold from participant in call.

Parameters:

options - Different options to pass to the request.

context - Context.

Returns:

Response for successful operation.

updateTranscription

public void updateTranscription(String locale)

Updates transcription language in the call.

Parameters:

locale - Defines new locale for transcription.

updateTranscriptionWithResponse

public Response<Void> updateTranscriptionWithResponse(UpdateTranscriptionOptions options, Context context)

Updates transcription language in the call.

Parameters:

options - Options for the Update Transcription operation.

context - Context

Returns:

Response for successful update transcription request.