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>