Subtitles

提供字幕功能的集成，详细使用方式见下文。

注意：如需使用直播实时字幕功能，需要连接聊天室才能正常使用

一、直播实时字幕

1.1 设置当前观众是否开启实时字幕

Api 方法： changeViewerSubtitleEnable(enable: boolean): void

参数说明：

• enable：undefined，boolean 类型，必传

1.2 设置立即触发翻译

Api 方法： changeTranslateImmediately(enable: boolean): void

参数说明：

• enable：undefined，boolean 类型，必传

1.3 初始化字幕列表

Api 方法： initSubtitleList(): Promise<void>

1.4 获取字幕配置

从 v1.2.0 开始可以通过 PlvSubtitleModule.generateDefaultSubtitleConfig() 来获取默认配置

Api 方法： getSubtitleConfig(): SubtitleConfig

返回值说明： SubtitleConfig 类型，详细类型说明如下

属性名	说明	类型
subtitleRealTimeEnabled	实时字幕开关	boolean
subtitleTranslateEnabled	实时字幕翻译开关	boolean
subtitleSourceLanguage	实时原声语言	SubtitleSourceLanguage
subtitleTranslateLanguage	实时字幕翻译后语言	SubtitleSourceTranslateLanguage
subtitleTranslateLanguages	实时字幕翻译后语言（可选列表）	SubtitleSourceTranslateLanguage[]
subtitleDisplayNumberLimitEnabled	实时字幕显示数量限制开关	boolean
subtitleDisplayNumber	实时字幕最多显示多少条	number
subtitleEnableByViewer	本地观众是否打开实时字幕	boolean
subtitleEnableByTeacher	讲师是否允许打开实时字幕	boolean

1.5 获取当前字幕列表

Api 方法： getSubtitlesList(): SubtitlesListItem[]

返回值说明： SubtitlesListItem[] 类型

1.6 更新实时字幕翻译语言

Api 方法： updateLiveSubtitleTranslateLanguage(translateLanguage: SubtitleSourceTranslateLanguage): void

参数说明：

• translateLanguage：undefined，SubtitleSourceTranslateLanguage 类型，必传

二、回放字幕

2.1 获取回放字幕内容

Api 方法： getReplaySubtitleContent(url: string): Promise<string>

参数说明：

• url：undefined，string 类型，必传

返回值说明： Promise<string> 类型

2.2 设置传入的回放字幕数据

Api 方法： setReplaySubtitleList(value: ReplaySubtitleItem[]): void

参数说明：

• value：undefined，ReplaySubtitleItem[] 类型，必传

2.3 获取回放字幕的的值

Api 方法： getReplaySubtitleList(): ReplaySubtitleItem[]

返回值说明： ReplaySubtitleItem[] 类型

2.4 解析回放字幕

Api 方法： parseReplaySubtitleContent(content: string): SubtitleParsedItem[]

参数说明：

• content：undefined，string 类型，必传

返回值说明： SubtitleParsedItem[] 类型

2.5 获取回放字幕回放可选项

Api 方法： getSubtitleTranslateOptions(): Promise<SubtitleTranslateOption[]>

返回值说明： Promise<SubtitleTranslateOption[]> 类型