文档首页/ 华为云会议 Meeting/ 服务端API参考/ 会议事件推送/ 会议级事件推送/ 接口参考/ 实时字幕信息推送
更新时间：2024-01-19 GMT+08:00
查看PDF
分享

实时字幕信息推送

描述

会议中任何人都可以通过该接口首次启动会议的实时字幕。当会议处于开启实时字幕状态时，会议中任何人都可以订阅实时字幕推送消息帧。

会议结束时，会议的实时字幕才会停止。

表1 请求文本

参数

类型

描述

action

String

消息类型，必须为ConfControl。

sequence

String

消息序列，消息帧的唯一标识。

type

String

会控类型，必须为REALTIMESUBTITLE。

data

String

具体的请求JSON字符串，参考表2 data数据结构。
表2 data数据结构

参数名称

是否必须

参数类型

描述

conferenceID

是

String

会议ID。

confToken

是

String

会控Token。

isSubtitle

否

Integer

0：停止实时字幕

1：启动实时字幕

subtitleType

否

Integer

字幕显示方式：

0：声音最大的2方发言人

sisProperty

否

String

所使用的模型:

chinese_16k_general：中文普通话（默认）

chinese_16k_trial：庭审模式

id

否

Array of strings

字幕显示方式为“指定发言人”时必填。发言会场ID列表（6.3.5章节在线与会者推送的pid），最多4人。
表3 实时字幕推送消息帧

参数

类型

描述

action

String

"RealTimeSubtitleNotify"

version

String

全量消息为：消息生成时的时间戳（毫秒）。

增量消息为：递增序列号。

createTime

String

消息生成时的时间戳（毫秒）。

msgID

String

消息的唯一标识。

msgMode

Integer

消息模式：

0：全量消息

1： 增量消息

confID

String

订阅的会议ID

data

SubtitleData object

实时字幕信息，内容由实时字幕服务与终端约定。SubtitleData数据结构如下。
表4 SubtitleData数据结构

参数

类型

描述

msgs

Msgs<0..*>

字幕文字内容，见下面Msgs数据结构。

isFinal

Boolean

是否断句。

timestamp

Integer

时间戳。

beginTime

Integer

字幕开始时间。

endTime

Integer

字幕结束时间。

participantID

String

会场ID。
表5 Msgs数据结构

参数

类型

描述

subtitleLang

String

语言类型。

Mandarin：普通话

English：英语

translateText

String

字幕文字。

id

String

字幕消息id。

开启实时字幕示例

var confToken = 获取会控Token接口;
var openRealTimeSubtitle = JSON.stringify({
    sequence: "000000000000000002611382273463",
    action: "ConfControl",
    type: "REALTIMESUBTITLE",
    data: JSON.stringify({
        conferenceID: "986812232",
        confToken: confToken,
        isSubtitle: "1",
        subtitleType: "0"
    }),
 });

实时字幕推送示例

{
	"action": "RealTimeSubtitleNotify",
	"version": "1614936396556",
	"createTime": "1614936396556",
	"msgID": "e20544e37d9411ebbae3fd5b302953d3",
	"msgMode": 0,
	"confID": "981112355",
	"data": {
		"msgs ": [{
			"subtitleLang": "Mandarin",
			"translateText": "实时字幕。 ",
			"id ": "c0196fb9-c9c3-47ba-a685-05223552de2f"
		}],
		"isFinal ": false,
		"timestamp ": 1614936396553,
		"beginTime": 1528680,
		"endTime": 1530900,
		"participantID": "984r8z9f4p6p6pry97yfan6z76681f09"
	}
}
父主题： 接口参考