Package version:

Class CallMedia

CallMedia class represents call media related APIs.

Constructors

constructor

Methods

cancelAllOperations hold play playToAll sendDtmfTones startContinuousDtmfRecognition startMediaStreaming startRecognizing startTranscription stopContinuousDtmfRecognition stopMediaStreaming stopTranscription unhold updateTranscription

Constructors

constructor

  • new CallMedia(callConnectionId, endpoint, credential, options?): CallMedia

  • Parameters

    • callConnectionId: string
    • endpoint: string
    • credential: any
    • Optionaloptions: CallAutomationApiClientOptionalParams

    Returns CallMedia

Methods

cancelAllOperations

  • cancelAllOperations(): Promise<void>

  • Cancels all the queued media operations.

    Returns Promise<void>

hold

  • hold(targetParticipant, options?): Promise<void>

  • Put participant on hold while playing audio.

    Parameters

    • targetParticipant: CommunicationIdentifier

      The targets to play to.

    • options: HoldOptions = {}

      Additional attributes for hold participant.

    Returns Promise<void>

play

  • play(playSources, playTo, options?): Promise<void>

  • Play audio to a specific participant.

    Parameters

    • playSources: (FileSource | TextSource | SsmlSource)[]

      A PlaySource representing the sources to play. Currently only single play source per request is supported.

    • playTo: CommunicationIdentifier[]

      The targets to play to.

    • options: PlayOptions = ...

      Additional attributes for play.

    Returns Promise<void>

playToAll

  • playToAll(playSources, options?): Promise<void>

  • Play to all participants.

    Parameters

    Returns Promise<void>

sendDtmfTones

startContinuousDtmfRecognition

  • startContinuousDtmfRecognition(targetParticipant, options?): Promise<void>

  • Start continuous Dtmf recognition by subscribing to tones.

    Parameters

    • targetParticipant: CommunicationIdentifier

      Target participant.

    • options: ContinuousDtmfRecognitionOptions = {}

      Additional attributes for continuous Dtmf recognition.

    Returns Promise<void>

startMediaStreaming

  • startMediaStreaming(options?): Promise<void>

  • Starts media streaming in the call.

    Parameters

    Returns Promise<void>

startRecognizing

  • startRecognizing(targetParticipant, maxTonesToCollect, options): Promise<void>

  • Recognize participant input.

    Parameters

    • targetParticipant: CommunicationIdentifier

      Target participant.

    • maxTonesToCollect: number

      Maximum number of DTMF tones to be collected.

    • options: CallMediaRecognizeDtmfOptions

      Different attributes for recognize.

    Returns Promise<void>

    Deprecated

    This method signature is deprecated. Please use the new signature with targetParticipant and options params instead, and set maxTonesToCollect in options.

  • startRecognizing(targetParticipant, options): Promise<void>

  • Recognize participant input.

    Parameters

    Returns Promise<void>

startTranscription

  • startTranscription(options?): Promise<void>

  • Starts transcription in the call

    Parameters

    Returns Promise<void>

stopContinuousDtmfRecognition

  • stopContinuousDtmfRecognition(targetParticipant, options?): Promise<void>

  • Stop continuous Dtmf recognition by unsubscribing to tones.

    Parameters

    • targetParticipant: CommunicationIdentifier

      Target participant.

    • options: ContinuousDtmfRecognitionOptions = {}

      Additional attributes for continuous Dtmf recognition.

    Returns Promise<void>

stopMediaStreaming

  • stopMediaStreaming(options?): Promise<void>

  • Stops media streaming in the call.

    Parameters

    Returns Promise<void>

stopTranscription

  • stopTranscription(options?): Promise<void>

  • Stops transcription in the call.

    Parameters

    Returns Promise<void>

unhold

  • unhold(targetParticipant, options?): Promise<void>

  • Remove participant from hold.

    Parameters

    • targetParticipant: CommunicationIdentifier

      The targets to play to.

    • options: UnholdOptions = {}

      Additional attributes for unhold participant.

    Returns Promise<void>

updateTranscription

  • updateTranscription(locale, options?): Promise<void>

  • Update transcription language.

    Parameters

    Returns Promise<void>

Settings

Member Visibility