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 作業完成的 Promise。 完成此承諾並不表示語言已變更。 當語言實際變更時，將會發出 'SpokenLanguageChanged' 事件。

startCaptions(StartCaptionsOptions)

使用此用戶端提供的處理程式，啟動此呼叫中的標題處理

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

參數

startCaptionsOptions

StartCaptionsOptions

啟動標題的其他選項。

傳回

Promise<void>

代表開始標題作業之初始化程式完成的 Promise 此承諾的完成並不表示標題已啟動。 當標題實際上已成功啟動時，將會發出 『CaptionsActiveChanged』 事件。

stopCaptions()

停止呼叫中起始 stopCaptions 的使用者擷取標題數據

function stopCaptions(): Promise<void>

傳回

Promise<void>

代表停止標題作業完成的 Promise 此承諾的完成不會指出 Bot 已離開呼叫的標題。 參與者會在成功停止時取消訂閱接收輔助字幕數據。