CallMedia class
CallMedia class represents call media related APIs.
Constructors
| Call |
Methods
Constructor Details
CallMedia(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)
new CallMedia(callConnectionId: string, endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)Parameters
- callConnectionId
-
string
- endpoint
-
string
- credential
- options
-
CallAutomationApiClientOptionalParams
Method Details
cancelAllOperations()
Cancels all the queued media operations.
function cancelAllOperations(): Promise<void>Returns
Promise<void>
hold(CommunicationIdentifier, HoldOptions)
Put participant on hold while playing audio.
function hold(targetParticipant: CommunicationIdentifier, options?: HoldOptions): Promise<void>Parameters
- targetParticipant
- CommunicationIdentifier
The targets to play to.
- options
- HoldOptions
Additional attributes for hold participant.
Returns
Promise<void>
play((FileSource | TextSource | SsmlSource)[], CommunicationIdentifier[], PlayOptions)
Play audio to a specific participant.
function play(playSources: (FileSource | TextSource | SsmlSource)[], playTo: CommunicationIdentifier[], options?: PlayOptions): Promise<void>Parameters
- playSources
-
(FileSource | TextSource | SsmlSource)[]
A PlaySource representing the sources to play. Currently only single play source per request is supported.
- playTo
The targets to play to.
- options
- PlayOptions
Additional attributes for play.
Returns
Promise<void>
playToAll((FileSource | TextSource | SsmlSource)[], PlayToAllOptions)
Play to all participants.
function playToAll(playSources: (FileSource | TextSource | SsmlSource)[], options?: PlayToAllOptions): Promise<void>Parameters
- playSources
-
(FileSource | TextSource | SsmlSource)[]
A PlaySource representing the sources to play. Currently only single play source per request is supported.
- options
- PlayToAllOptions
Additional attributes for play.
Returns
Promise<void>
sendDtmfTones(string[] | DtmfTone[], CommunicationIdentifier, SendDtmfTonesOptions)
Send Dtmf tones.
function sendDtmfTones(tones: string[] | DtmfTone[], targetParticipant: CommunicationIdentifier, options?: SendDtmfTonesOptions): Promise<SendDtmfTonesResult>Parameters
- tones
-
string[] | DtmfTone[]
List of tones to be sent to target participant.
- targetParticipant
- CommunicationIdentifier
Target participant.
- options
- SendDtmfTonesOptions
Additional attributes for send Dtmf tones.
Returns
Promise<SendDtmfTonesResult>
startContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)
Start continuous Dtmf recognition by subscribing to tones.
function startContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>Parameters
- targetParticipant
- CommunicationIdentifier
Target participant.
- options
- ContinuousDtmfRecognitionOptions
Additional attributes for continuous Dtmf recognition.
Returns
Promise<void>
startMediaStreaming(StartMediaStreamingOptions)
Starts media streaming in the call.
function startMediaStreaming(options?: StartMediaStreamingOptions): Promise<void>Parameters
- options
- StartMediaStreamingOptions
Additional attributes for start media streaming.
Returns
Promise<void>
startRecognizing(CommunicationIdentifier, CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions)
Recognize participant input.
function startRecognizing(targetParticipant: CommunicationIdentifier, options: CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions): Promise<void>Parameters
- targetParticipant
- CommunicationIdentifier
Target participant.
- options
-
CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions
Different attributes for recognize.
Returns
Promise<void>
startRecognizing(CommunicationIdentifier, number, CallMediaRecognizeDtmfOptions)
Warning
This API is now deprecated.
This method signature is deprecated. Please use the new signature with targetParticipant and options params instead, and set maxTonesToCollect in options.
Recognize participant input.
function startRecognizing(targetParticipant: CommunicationIdentifier, maxTonesToCollect: number, options: CallMediaRecognizeDtmfOptions): Promise<void>Parameters
- targetParticipant
- CommunicationIdentifier
Target participant.
- maxTonesToCollect
-
number
Maximum number of DTMF tones to be collected.
- options
- CallMediaRecognizeDtmfOptions
Different attributes for recognize.
Returns
Promise<void>
startTranscription(StartTranscriptionOptions)
Starts transcription in the call
function startTranscription(options?: StartTranscriptionOptions): Promise<void>Parameters
- options
- StartTranscriptionOptions
Additional attributes for start transcription.
Returns
Promise<void>
stopContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)
Stop continuous Dtmf recognition by unsubscribing to tones.
function stopContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>Parameters
- targetParticipant
- CommunicationIdentifier
Target participant.
- options
- ContinuousDtmfRecognitionOptions
Additional attributes for continuous Dtmf recognition.
Returns
Promise<void>
stopMediaStreaming(StopMediaStreamingOptions)
Stops media streaming in the call.
function stopMediaStreaming(options?: StopMediaStreamingOptions): Promise<void>Parameters
- options
- StopMediaStreamingOptions
Additional attributes for stop media streaming.
Returns
Promise<void>
stopTranscription(StopTranscriptionOptions)
Stops transcription in the call.
function stopTranscription(options?: StopTranscriptionOptions): Promise<void>Parameters
- options
- StopTranscriptionOptions
Additional attributes for stop transcription.
Returns
Promise<void>
unhold(CommunicationIdentifier, UnholdOptions)
Remove participant from hold.
function unhold(targetParticipant: CommunicationIdentifier, options?: UnholdOptions): Promise<void>Parameters
- targetParticipant
- CommunicationIdentifier
The targets to play to.
- options
- UnholdOptions
Additional attributes for unhold participant.
Returns
Promise<void>
updateTranscription(string, UpdateTranscriptionOptions)
Update transcription language.
function updateTranscription(locale: string, options?: UpdateTranscriptionOptions): Promise<void>Parameters
- locale
-
string
Defines new locale for transcription.
- options
- UpdateTranscriptionOptions
Returns
Promise<void>