TeamsCaptions interface
TeamsCaptions 對象的數據結構
- Extends
屬性
| active |
指出 ISO 639-1 格式的目前使用中標題語言 |
| supported |
ISO 639-1 格式的輔助字幕服務所要使用的支持輔助字幕語言清單 |
繼承的屬性
| active |
以 BCP 47 格式表示呼叫中的目前使用中口語 |
| is |
指出目前呼叫中的標題是否作用中 |
| kind | 指出使用中標號物件的 Captions 類型 |
| supported |
支援口語語言的清單，以 BCP 47 格式搭配輔助字幕服務使用 |
方法
| off("Caption |
取消訂閱任何 CaptionLanguageChangedEventType 事件的函式 |
| off("Captions |
取消訂閱任何 CaptionsPropertyChangedEventType 事件的函式 |
| off("Captions |
取消訂閱任何 CaptionsPropertyChangedEventType 事件的函式 |
| off("Spoken |
取消訂閱任何 SpokenLanguageChangedEventType 事件的函式 |
| on("Caption |
任何 CaptionLanguageChangedEventType 事件的訂閱函式 |
| on("Captions |
任何 CaptionsPropertyChangedEventType 事件的訂閱函式 |
| on("Captions |
CaptionsReceivedEventType 事件的 Subscribe 函式 |
| on("Spoken |
任何 SpokenLanguageChangedEventType 事件的訂閱函式 |
| set |
更新進行中轉譯/輔助字幕的語言 |
繼承的方法
| set |
更新進行中轉譯/輔助字幕的語言 |
| start |
使用此用戶端提供的處理程式，啟動此呼叫中的標題處理 |
| stop |
停止呼叫中起始 stopCaptions 的使用者擷取標題數據 |
屬性詳細資料
activeCaptionLanguage
指出 ISO 639-1 格式的目前使用中標題語言
activeCaptionLanguage: string屬性值
string
supportedCaptionLanguages
ISO 639-1 格式的輔助字幕服務所要使用的支持輔助字幕語言清單
supportedCaptionLanguages: string[]屬性值
string[]
繼承的屬性詳細資料
activeSpokenLanguage
以 BCP 47 格式表示呼叫中的目前使用中口語
activeSpokenLanguage: string屬性值
string
isCaptionsFeatureActive
指出目前呼叫中的標題是否作用中
isCaptionsFeatureActive: boolean屬性值
boolean
kind
supportedSpokenLanguages
支援口語語言的清單，以 BCP 47 格式搭配輔助字幕服務使用
supportedSpokenLanguages: string[]屬性值
string[]
方法詳細資料
off("CaptionLanguageChanged", PropertyChangedEvent)
取消訂閱任何 CaptionLanguageChangedEventType 事件的函式
function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)參數
- event
-
"CaptionLanguageChanged"
事件名稱
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件
off("CaptionsActiveChanged", PropertyChangedEvent)
取消訂閱任何 CaptionsPropertyChangedEventType 事件的函式
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)參數
- event
-
"CaptionsActiveChanged"
事件名稱
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件
off("CaptionsReceived", TeamsCaptionsHandler)
取消訂閱任何 CaptionsPropertyChangedEventType 事件的函式
function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)參數
- event
-
"CaptionsReceived"
事件名稱
- listener
- TeamsCaptionsHandler
回呼 fn，用來訂閱此事件
off("SpokenLanguageChanged", PropertyChangedEvent)
取消訂閱任何 SpokenLanguageChangedEventType 事件的函式
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)參數
- event
-
"SpokenLanguageChanged"
事件名稱
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件
on("CaptionLanguageChanged", PropertyChangedEvent)
任何 CaptionLanguageChangedEventType 事件的訂閱函式
function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)參數
- event
-
"CaptionLanguageChanged"
事件名稱
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件
on("CaptionsActiveChanged", PropertyChangedEvent)
任何 CaptionsPropertyChangedEventType 事件的訂閱函式
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)參數
- event
-
"CaptionsActiveChanged"
事件名稱
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件
on("CaptionsReceived", TeamsCaptionsHandler)
CaptionsReceivedEventType 事件的 Subscribe 函式
function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)參數
- event
-
"CaptionsReceived"
事件名稱
- listener
- TeamsCaptionsHandler
回呼 fn，用來訂閱此事件
on("SpokenLanguageChanged", PropertyChangedEvent)
任何 SpokenLanguageChangedEventType 事件的訂閱函式
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)參數
- event
-
"SpokenLanguageChanged"
事件名稱
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件
setCaptionLanguage(string)
更新進行中轉譯/輔助字幕的語言
function setCaptionLanguage(language: string): Promise<void>參數
- language
-
string
要作為語音標題的語言。 必須是 ISO 639-1 格式（例如 “en”）
傳回
Promise<void>
代表設定語言作業完成的 Promise 此承諾的完成並不表示語言已變更。 當語言實際變更時，將會發出 'CaptionLanguageChanged' 事件。
繼承的方法的詳細資料
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 已離開呼叫的標題。 參與者會在成功停止時取消訂閱接收輔助字幕數據。