Captions interface

包:

@azure/communication-calling

Captions 对象的数据结构

扩展

CaptionsCommon

继承属性

activeSpokenLanguage	以 BCP 47 格式指示呼叫中的当前活动口语
isCaptionsFeatureActive	指示标题是否在当前调用中处于活动状态
kind	指示活动题注对象的 Captions 类型
supportedSpokenLanguages	要与 BCP 47 格式的字幕服务一起使用的受支持口语列表

方法

off("CaptionsActiveChanged", PropertyChangedEvent)	取消订阅任何 CaptionsPropertyChangedEventType 事件的函数
off("CaptionsReceived", CaptionsHandler)	取消订阅任何 CaptionsPropertyChangedEventType 事件的函数
off("SpokenLanguageChanged", PropertyChangedEvent)	取消订阅任何 SpokenLanguageChangedEventType 事件的函数
on("CaptionsActiveChanged", PropertyChangedEvent)	订阅任何 CaptionsPropertyChangedEventType 事件的函数
on("CaptionsReceived", CaptionsHandler)	CaptionsReceivedEventType 事件的 Subscribe 函数
on("SpokenLanguageChanged", PropertyChangedEvent)	任何 SpokenLanguageChangedEventType 事件的订阅函数

继承的方法

setSpokenLanguage(string)	更新正在进行的听录/字幕的语言
startCaptions(StartCaptionsOptions)	使用此客户端提供的处理程序启动此调用中的题注处理
stopCaptions()	停止为发起 stopCaptions 的用户调用中检索题注数据

继承属性详细信息

activeSpokenLanguage

以 BCP 47 格式指示呼叫中的当前活动口语

activeSpokenLanguage: string

属性值

string

继承自CaptionsCommon.activeSpokenLanguage

isCaptionsFeatureActive

指示标题是否在当前调用中处于活动状态

isCaptionsFeatureActive: boolean

属性值

boolean

继承自CaptionsCommon.isCaptionsFeatureActive

kind

指示活动题注对象的 Captions 类型

kind: CaptionsKind

属性值

CaptionsKind

继承自CaptionsCommon.kind

supportedSpokenLanguages

要与 BCP 47 格式的字幕服务一起使用的受支持口语列表

supportedSpokenLanguages: string[]

属性值

string[]

继承自CaptionsCommon.supportedSpokenLanguages

方法详细信息

off("CaptionsActiveChanged", PropertyChangedEvent)

取消订阅任何 CaptionsPropertyChangedEventType 事件的函数

function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)

参数

event

"CaptionsActiveChanged"

事件名称

listener

PropertyChangedEvent

用于订阅此事件的回调 fn

off("CaptionsReceived", CaptionsHandler)

取消订阅任何 CaptionsPropertyChangedEventType 事件的函数

function off(event: "CaptionsReceived", listener: CaptionsHandler)

参数

event

"CaptionsReceived"

事件名称

listener

CaptionsHandler

用于订阅此事件的回调 fn

off("SpokenLanguageChanged", PropertyChangedEvent)

取消订阅任何 SpokenLanguageChangedEventType 事件的函数

function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)

参数

event

"SpokenLanguageChanged"

事件名称

listener

PropertyChangedEvent

用于订阅此事件的回调 fn

on("CaptionsActiveChanged", PropertyChangedEvent)

订阅任何 CaptionsPropertyChangedEventType 事件的函数

function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)

参数

event

"CaptionsActiveChanged"

事件名称

listener

PropertyChangedEvent

用于订阅此事件的回调 fn

on("CaptionsReceived", CaptionsHandler)

CaptionsReceivedEventType 事件的 Subscribe 函数

function on(event: "CaptionsReceived", listener: CaptionsHandler)

参数

event

"CaptionsReceived"

事件名称

listener

CaptionsHandler

用于订阅此事件的回调 fn

on("SpokenLanguageChanged", PropertyChangedEvent)

任何 SpokenLanguageChangedEventType 事件的订阅函数

function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)

参数

event

"SpokenLanguageChanged"

事件名称

listener

PropertyChangedEvent

用于订阅此事件的回调 fn

继承的方法详细信息

setSpokenLanguage(string)

更新正在进行的听录/字幕的语言

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

参数

language

string

将语音描述为的语言。 必须是 BCP 47 格式（例如“en-us”）

返回

Promise<void>

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

继承自CaptionsCommon.setSpokenLanguage

startCaptions(StartCaptionsOptions)

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

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

参数

startCaptionsOptions

StartCaptionsOptions

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

返回

Promise<void>

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

继承自CaptionsCommon.startCaptions

stopCaptions()

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

function stopCaptions(): Promise<void>

返回

Promise<void>

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

继承自CaptionsCommon.stopCaptions