communication-call-automation/dist/commonjs/callMedia.d.ts

Azure client library for Azure Communication Call Automation services

import { CallAutomationApiClientOptionalParams, Tone } from "./generated/src/index.js";
import { CommunicationIdentifier } from "@azure/communication-common";
import { FileSource, TextSource, SsmlSource, DtmfTone } from "./models/models.js";
import { PlayOptions, PlayToAllOptions, CallMediaRecognizeDtmfOptions, CallMediaRecognizeChoiceOptions, ContinuousDtmfRecognitionOptions, SendDtmfTonesOptions, CallMediaRecognizeSpeechOptions, CallMediaRecognizeSpeechOrDtmfOptions, HoldOptions, UnholdOptions } from "./models/options.js";
import { KeyCredential, TokenCredential } from "@azure/core-auth";
import { SendDtmfTonesResult } from "./models/responses.js";
/**
 * CallMedia class represents call media related APIs.
 */
export declare class CallMedia {
    private readonly callConnectionId;
    private readonly callMedia;
    private readonly callAutomationApiClient;
    constructor(callConnectionId: string, endpoint: string, credential: KeyCredential | TokenCredential, options?: CallAutomationApiClientOptionalParams);
    private createPlaySourceInternal;
    /**
     * Play audio to a specific participant.
     *
     * @param playSources - A PlaySource representing the sources to play. Currently only single play source per request is supported.
     * @param playTo - The targets to play to.
     * @param options - Additional attributes for play.
     */
    play(playSources: (FileSource | TextSource | SsmlSource)[], playTo: CommunicationIdentifier[], options?: PlayOptions): Promise<void>;
    /**
     * Play to all participants.
     *
     * @param playSources - A PlaySource representing the sources to play. Currently only single play source per request is supported.
     * @param options - Additional attributes for play.
     */
    playToAll(playSources: (FileSource | TextSource | SsmlSource)[], options?: PlayToAllOptions): Promise<void>;
    private createRecognizeRequest;
    /**
     *  Recognize participant input.
     *  @deprecated This method signature is deprecated. Please use the new signature with targetParticipant and options params instead, and set maxTonesToCollect in options.
     *  @param targetParticipant - Target participant.
     *  @param maxTonesToCollect - Maximum number of DTMF tones to be collected.
     *  @param options - Different attributes for recognize.
     * */
    startRecognizing(targetParticipant: CommunicationIdentifier, maxTonesToCollect: number, options: CallMediaRecognizeDtmfOptions): Promise<void>;
    /**
     *  Recognize participant input.
     *  @param targetParticipant - Target participant.
     *  @param options - Different attributes for recognize.
     * */
    startRecognizing(targetParticipant: CommunicationIdentifier, options: CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions): Promise<void>;
    /**
     * Cancels all the queued media operations.
     */
    cancelAllOperations(): Promise<void>;
    /**
     * Start continuous Dtmf recognition by subscribing to tones.
     * @param targetParticipant - Target participant.
     * @param options - Additional attributes for continuous Dtmf recognition.
     * */
    startContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>;
    /**
     * Stop continuous Dtmf recognition by unsubscribing to tones.
     * @param targetParticipant - Target participant.
     * @param options - Additional attributes for continuous Dtmf recognition.
     * */
    stopContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>;
    /**
     * Send Dtmf tones.
     * @param tones - List of tones to be sent to target participant.
     * @param targetParticipant - Target participant.
     * @param options - Additional attributes for send Dtmf tones.
     * */
    sendDtmfTones(tones: Tone[] | DtmfTone[], targetParticipant: CommunicationIdentifier, options?: SendDtmfTonesOptions): Promise<SendDtmfTonesResult>;
    /**
     * Put participant on hold while playing audio.
     *
     * @param targetParticipant - The targets to play to.
     * @param options - Additional attributes for hold participant.
     */
    hold(targetParticipant: CommunicationIdentifier, options?: HoldOptions): Promise<void>;
    /**
     * Remove participant from hold.
     *
     * @param targetParticipant - The targets to play to.
     * @param options - Additional attributes for unhold participant.
     */
    unhold(targetParticipant: CommunicationIdentifier, options?: UnholdOptions): Promise<void>;
}
//# sourceMappingURL=callMedia.d.ts.map