startSubtitle abstract method

Future<int?> startSubtitle(
  1. SubtitleConfig subtitleConfig
)

识别或翻译房间内所有用户的语音,形成字幕。

v3.54 新增。

语音识别或翻译的结果会通过 RTCRoomEventHandler.onSubtitleMessageReceived 事件回调给你。
调用该方法后,你会收到 RTCRoomEventHandler.onSubtitleStateChanged 回调,通知字幕是否开启。

subtitleConfig:字幕配置信息。

返回值:

  • 0:调用成功。
  • !0:调用失败。失败原因参看 ReturnStatus

注意:

  • 使用字幕功能前,你需要开通机器翻译服务并前往 RTC 控制台,在功能配置页面开启字幕功能。
  • 此方法需要在进房后调用。
  • 如需指定源语言,你需要在调用 joinRoom 接口进房时,通过 extraInfo 参数传入格式为"语种英文名": "语种代号" JSON 字符串,例如设置源语言为英文时,传入 "source_language": "en"。如未指定源语言,SDK 会将系统语种设定为源语言。如果你的系统语种不是中文、英文和日文,此时 SDK 会自动将中文设为源语言。
    • 识别模式下,你可以传入 RTC 控制台上预设或自定义的语种英文名和语种代号。识别模式下支持的语言参看识别模式语种支持
    • 翻译模式下,你需要传入机器翻译规定的语种英文名和语种代号。翻译模式下支持的语言及对应的代号参看翻译模式语言支持
  • 调用 RTCRoom.stopSubtitle 可以关闭字幕。

Implementation

Future<int?> startSubtitle(SubtitleConfig subtitleConfig);