communication-call-automation
Version:
Azure client library for Azure Communication Call Automation services
60 lines • 3.63 kB
TypeScript
import { PlayRequest, CallMediaPlayOptionalParams, CallMediaCancelAllMediaOperationsOptionalParams, RecognizeRequest, CallMediaRecognizeOptionalParams, ContinuousDtmfRecognitionRequest, CallMediaStartContinuousDtmfRecognitionOptionalParams, CallMediaStopContinuousDtmfRecognitionOptionalParams, SendDtmfTonesRequest, CallMediaSendDtmfTonesOptionalParams, CallMediaSendDtmfTonesResponse, HoldRequest, CallMediaHoldOptionalParams, UnholdRequest, CallMediaUnholdOptionalParams } from "../models/index.js";
/** Interface representing a CallMedia. */
export interface CallMedia {
/**
* Plays audio to participants in the call.
* @param callConnectionId The call connection id.
* @param playRequest play request payload.
* @param options The options parameters.
*/
play(callConnectionId: string, playRequest: PlayRequest, options?: CallMediaPlayOptionalParams): Promise<void>;
/**
* Cancel all media operations in a call.
* @param callConnectionId The call connection id
* @param options The options parameters.
*/
cancelAllMediaOperations(callConnectionId: string, options?: CallMediaCancelAllMediaOperationsOptionalParams): Promise<void>;
/**
* Recognize media from call.
* @param callConnectionId The call connection id
* @param recognizeRequest The media recognize request
* @param options The options parameters.
*/
recognize(callConnectionId: string, recognizeRequest: RecognizeRequest, options?: CallMediaRecognizeOptionalParams): Promise<void>;
/**
* Start continuous Dtmf recognition by subscribing to tones.
* @param callConnectionId The call connection id
* @param continuousDtmfRecognitionRequest The continuous recognize request
* @param options The options parameters.
*/
startContinuousDtmfRecognition(callConnectionId: string, continuousDtmfRecognitionRequest: ContinuousDtmfRecognitionRequest, options?: CallMediaStartContinuousDtmfRecognitionOptionalParams): Promise<void>;
/**
* Stop continuous Dtmf recognition by unsubscribing to tones.
* @param callConnectionId The call connection id
* @param continuousDtmfRecognitionRequest The continuous recognize request
* @param options The options parameters.
*/
stopContinuousDtmfRecognition(callConnectionId: string, continuousDtmfRecognitionRequest: ContinuousDtmfRecognitionRequest, options?: CallMediaStopContinuousDtmfRecognitionOptionalParams): Promise<void>;
/**
* Send dtmf tones.
* @param callConnectionId The call connection id
* @param sendDtmfTonesRequest The send dtmf tones request
* @param options The options parameters.
*/
sendDtmfTones(callConnectionId: string, sendDtmfTonesRequest: SendDtmfTonesRequest, options?: CallMediaSendDtmfTonesOptionalParams): Promise<CallMediaSendDtmfTonesResponse>;
/**
* Hold participant from the call using identifier.
* @param callConnectionId The call connection id.
* @param holdRequest The participants to be hold from the call.
* @param options The options parameters.
*/
hold(callConnectionId: string, holdRequest: HoldRequest, options?: CallMediaHoldOptionalParams): Promise<void>;
/**
* Unhold participants from the call using identifier.
* @param callConnectionId The call connection id.
* @param unholdRequest The participants to be hold from the call.
* @param options The options parameters.
*/
unhold(callConnectionId: string, unholdRequest: UnholdRequest, options?: CallMediaUnholdOptionalParams): Promise<void>;
}
//# sourceMappingURL=callMedia.d.ts.map