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>

表示设置语言操作完成的 Promise。 完成此承诺并不表示语言已更改。 当语言实际上已成功更改时，将发出“SpokenLanguageChanged”事件。

startCaptions(StartCaptionsOptions)

使用此客户端提供的处理程序启动此调用中的题注处理

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

参数

startCaptionsOptions

StartCaptionsOptions

用于启动字幕的其他选项。

返回

Promise<void>

表示“开始标题”操作的初始化过程完成的 Promise 表示此承诺的完成并不表示标题已启动。 当标题实际上已成功启动时，将发出“CaptionsActiveChanged”事件。

stopCaptions()

停止为发起 stopCaptions 的用户调用中检索题注数据

function stopCaptions(): Promise<void>

返回

Promise<void>

表示“停止标题”操作完成的承诺：完成此承诺并不指示机器人已离开调用的标题。 参与者将在成功停止后取消订阅接收字幕数据。