CallMedia class
CallMedia 類別代表呼叫媒體相關的 API。
建構函式
| Call |
方法
建構函式詳細資料
CallMedia(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)
new CallMedia(callConnectionId: string, endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)參數
- callConnectionId
-
string
- endpoint
-
string
- credential
- options
-
CallAutomationApiClientOptionalParams
方法詳細資料
cancelAllOperations()
取消所有已排入佇列的媒體作業。
function cancelAllOperations(): Promise<void>傳回
Promise<void>
hold(CommunicationIdentifier, HoldOptions)
播放音訊時，讓參與者保持保留。
function hold(targetParticipant: CommunicationIdentifier, options?: HoldOptions): Promise<void>參數
- targetParticipant
- CommunicationIdentifier
要播放的目標。
- options
- HoldOptions
保留參與者的其他屬性。
傳回
Promise<void>
play((FileSource | TextSource | SsmlSource)[], CommunicationIdentifier[], PlayOptions)
將音訊播放至特定參與者。
function play(playSources: (FileSource | TextSource | SsmlSource)[], playTo: CommunicationIdentifier[], options?: PlayOptions): Promise<void>參數
- playSources
-
(FileSource | TextSource | SsmlSource)[]
PlaySource，代表要播放的來源。 目前僅支援每個要求的單一播放來源。
- playTo
要播放的目標。
- options
- PlayOptions
用於播放的其他屬性。
傳回
Promise<void>
playToAll((FileSource | TextSource | SsmlSource)[], PlayToAllOptions)
播放給所有參與者。
function playToAll(playSources: (FileSource | TextSource | SsmlSource)[], options?: PlayToAllOptions): Promise<void>參數
- playSources
-
(FileSource | TextSource | SsmlSource)[]
PlaySource，代表要播放的來源。 目前僅支援每個要求的單一播放來源。
- options
- PlayToAllOptions
用於播放的其他屬性。
傳回
Promise<void>
sendDtmfTones(string[] | DtmfTone[], CommunicationIdentifier, SendDtmfTonesOptions)
傳送 Dtmf 音調。
function sendDtmfTones(tones: string[] | DtmfTone[], targetParticipant: CommunicationIdentifier, options?: SendDtmfTonesOptions): Promise<SendDtmfTonesResult>參數
- tones
-
string[] | DtmfTone[]
要傳送給目標參與者的音調清單。
- targetParticipant
- CommunicationIdentifier
目標參與者。
- options
- SendDtmfTonesOptions
傳送 Dtmf 音調的其他屬性。
傳回
Promise<SendDtmfTonesResult>
startContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)
訂閱音調來啟動連續 Dtmf 辨識。
function startContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>參數
- targetParticipant
- CommunicationIdentifier
目標參與者。
- options
- ContinuousDtmfRecognitionOptions
連續 Dtmf 辨識的其他屬性。
傳回
Promise<void>
startMediaStreaming(StartMediaStreamingOptions)
在呼叫中啟動媒體串流。
function startMediaStreaming(options?: StartMediaStreamingOptions): Promise<void>參數
- options
- StartMediaStreamingOptions
啟動媒體流式處理的其他屬性。
傳回
Promise<void>
startRecognizing(CommunicationIdentifier, CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions)
辨識參與者輸入。
function startRecognizing(targetParticipant: CommunicationIdentifier, options: CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions): Promise<void>參數
- targetParticipant
- CommunicationIdentifier
目標參與者。
- options
-
CallMediaRecognizeDtmfOptions | CallMediaRecognizeChoiceOptions | CallMediaRecognizeSpeechOptions | CallMediaRecognizeSpeechOrDtmfOptions
辨識的不同屬性。
傳回
Promise<void>
startRecognizing(CommunicationIdentifier, number, CallMediaRecognizeDtmfOptions)
警告
此 API 現已淘汰。
This method signature is deprecated. Please use the new signature with targetParticipant and options params instead, and set maxTonesToCollect in options.
辨識參與者輸入。
function startRecognizing(targetParticipant: CommunicationIdentifier, maxTonesToCollect: number, options: CallMediaRecognizeDtmfOptions): Promise<void>參數
- targetParticipant
- CommunicationIdentifier
目標參與者。
- maxTonesToCollect
-
number
要收集的 DTMF 音調數目上限。
- options
- CallMediaRecognizeDtmfOptions
辨識的不同屬性。
傳回
Promise<void>
startTranscription(StartTranscriptionOptions)
開始在呼叫中轉譯
function startTranscription(options?: StartTranscriptionOptions): Promise<void>參數
- options
- StartTranscriptionOptions
開始轉錄的其他屬性。
傳回
Promise<void>
stopContinuousDtmfRecognition(CommunicationIdentifier, ContinuousDtmfRecognitionOptions)
取消訂閱音調來停止連續 Dtmf 辨識。
function stopContinuousDtmfRecognition(targetParticipant: CommunicationIdentifier, options?: ContinuousDtmfRecognitionOptions): Promise<void>參數
- targetParticipant
- CommunicationIdentifier
目標參與者。
- options
- ContinuousDtmfRecognitionOptions
連續 Dtmf 辨識的其他屬性。
傳回
Promise<void>
stopMediaStreaming(StopMediaStreamingOptions)
停止呼叫中的媒體串流。
function stopMediaStreaming(options?: StopMediaStreamingOptions): Promise<void>參數
- options
- StopMediaStreamingOptions
停止媒體流式處理的其他屬性。
傳回
Promise<void>
stopTranscription(StopTranscriptionOptions)
停止通話中的轉譯。
function stopTranscription(options?: StopTranscriptionOptions): Promise<void>參數
- options
- StopTranscriptionOptions
停止轉錄的其他屬性。
傳回
Promise<void>
unhold(CommunicationIdentifier, UnholdOptions)
從保留中移除參與者。
function unhold(targetParticipant: CommunicationIdentifier, options?: UnholdOptions): Promise<void>參數
- targetParticipant
- CommunicationIdentifier
要播放的目標。
- options
- UnholdOptions
未保留參與者的其他屬性。
傳回
Promise<void>
updateTranscription(string, UpdateTranscriptionOptions)
更新轉錄語言。
function updateTranscription(locale: string, options?: UpdateTranscriptionOptions): Promise<void>參數
- locale
-
string
定義用於轉錄的新區域設置。
- options
- UpdateTranscriptionOptions
傳回
Promise<void>