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。 現時点では、要求ごとに 1 つの再生ソースのみがサポートされています。
- 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。 現時点では、要求ごとに 1 つの再生ソースのみがサポートされています。
- 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
recognize の異なる属性。
戻り値
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
recognize の異なる属性。
戻り値
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>