UNPKG

@azure/communication-call-automation

Version:
95 lines 5.95 kB
import { PlayRequest, CallMediaPlayOptionalParams, StartTranscriptionRequest, CallMediaStartTranscriptionOptionalParams, StopTranscriptionRequest, CallMediaStopTranscriptionOptionalParams, UpdateTranscriptionRequest, CallMediaUpdateTranscriptionOptionalParams, CallMediaCancelAllMediaOperationsOptionalParams, RecognizeRequest, CallMediaRecognizeOptionalParams, ContinuousDtmfRecognitionRequest, CallMediaStartContinuousDtmfRecognitionOptionalParams, CallMediaStopContinuousDtmfRecognitionOptionalParams, SendDtmfTonesRequest, CallMediaSendDtmfTonesOptionalParams, CallMediaSendDtmfTonesResponse, HoldRequest, CallMediaHoldOptionalParams, UnholdRequest, CallMediaUnholdOptionalParams, StartMediaStreamingRequest, CallMediaStartMediaStreamingOptionalParams, StopMediaStreamingRequest, CallMediaStopMediaStreamingOptionalParams } 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>; /** * Starts transcription in the call * @param callConnectionId The call connection id. * @param startTranscriptionRequest * @param options The options parameters. */ startTranscription(callConnectionId: string, startTranscriptionRequest: StartTranscriptionRequest, options?: CallMediaStartTranscriptionOptionalParams): Promise<void>; /** * Stops transcription in the call. * @param callConnectionId The call connection id. * @param stopTranscriptionRequest stop transcription request payload. * @param options The options parameters. */ stopTranscription(callConnectionId: string, stopTranscriptionRequest: StopTranscriptionRequest, options?: CallMediaStopTranscriptionOptionalParams): Promise<void>; /** * API to change transcription language. * @param callConnectionId The call connection id * @param updateTranscriptionRequest The UpdateTranscription request * @param options The options parameters. */ updateTranscription(callConnectionId: string, updateTranscriptionRequest: UpdateTranscriptionRequest, options?: CallMediaUpdateTranscriptionOptionalParams): 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>; /** * Starts media streaming in the call. * @param callConnectionId The call connection id. * @param startMediaStreamingRequest * @param options The options parameters. */ startMediaStreaming(callConnectionId: string, startMediaStreamingRequest: StartMediaStreamingRequest, options?: CallMediaStartMediaStreamingOptionalParams): Promise<void>; /** * Stops media streaming in the call. * @param callConnectionId The call connection id. * @param stopMediaStreamingRequest stop media streaming request payload. * @param options The options parameters. */ stopMediaStreaming(callConnectionId: string, stopMediaStreamingRequest: StopMediaStreamingRequest, options?: CallMediaStopMediaStreamingOptionalParams): Promise<void>; } //# sourceMappingURL=callMedia.d.ts.map