CaptionsCommon interface

Ссылка

Пакет:: @azure/communication-calling

Структура данных для объекта CaptionsCommon

Свойства

activeSpokenLanguage	Указывает текущий активный речвой язык в вызове в формате BCP 47
isCaptionsFeatureActive	Указывает, активны ли субтитры в текущем вызове
kind	Указывает тип captions для объекта активных подписей
supportedSpokenLanguages	Список поддерживаемых языков для использования со службой подписей в формате BCP 47

Методы

setSpokenLanguage(string)	Обновляет язык текущего транскрибирования и подписей
startCaptions(StartCaptionsOptions)	Запускает обработку подписей в этом вызове с предоставленным обработчиком для этого клиента.
stopCaptions()	Останавливает извлечение данных подписей в вызове пользователя, инициирующего stopCaptions

Сведения о свойстве

activeSpokenLanguage

Указывает текущий активный речвой язык в вызове в формате BCP 47

activeSpokenLanguage: string

Значение свойства

string

isCaptionsFeatureActive

Указывает, активны ли субтитры в текущем вызове

isCaptionsFeatureActive: boolean

Значение свойства

boolean

kind

Указывает тип captions для объекта активных подписей

kind: CaptionsKind

Значение свойства

CaptionsKind

supportedSpokenLanguages

Список поддерживаемых языков для использования со службой подписей в формате BCP 47

supportedSpokenLanguages: string[]

Значение свойства

string[]

Сведения о методе

setSpokenLanguage(string)

Обновляет язык текущего транскрибирования и подписей

function setSpokenLanguage(language: string): Promise<void>

Параметры

language: string

Язык для речи субтитров как. Должен быть формат BCP 47 (например, "en-us")

Возвращаемое значение

Promise<void>

Обещание, представляющее завершение операции Set Language. Завершение этого обещания не указывает, что язык изменился. Событие SpokenLanguageChanged будет создано при успешном изменении языка.

startCaptions(StartCaptionsOptions)

Запускает обработку подписей в этом вызове с предоставленным обработчиком для этого клиента.

function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>

Параметры

startCaptionsOptions: StartCaptionsOptions

Дополнительные параметры запуска подписей.

Возвращаемое значение

Promise<void>

Обещание, представляющее завершение процесса инициализации для операции "Заголовок начала", завершение этого обещания не указывает, что заголовки начались. Событие CaptionsActiveChanged будет создано при успешном запуске подписей.

stopCaptions()

Останавливает извлечение данных подписей в вызове пользователя, инициирующего stopCaptions

function stopCaptions(): Promise<void>

Возвращаемое значение

Promise<void>

Обещание, представляющее завершение операции стоп-подписи. Завершение этого обещания не указывает, что бот подписей оставил вызов. Участник отменит подписку от получения данных подписей после успешной остановки.