更新时间:2025-10-13 GMT+08:00
分享

订阅/取消订阅字幕

subscribeSubtitle

接口描述

该接口用于订阅或者取消订阅字幕。

注意事项

  1. 在会议中时使用此接口。

方法定义

subscribeSubtitle(isSubscribe: boolean): Promise<HWMOpenSubtitleResult>;

参数描述

参数

是否必须

类型

描述

isSubscribe

boolean

是否订阅。

返回值

表1 HWMOpenSubtitleResult参数说明

参数

类型

描述

result

SDKERR

接口调用结果,HWM_SDKERR_SUCCESS表示成功,详细请参考错误码参考

reasonDesc

string

错误描述。

示例代码

1
2
3
4
5
6
7
8
9
/**
* 订阅字幕
*/
handleSubscribeSubtitle(): void {   
    UISDK.getConfCtrlApi().subscribeSubtitle(true).then((res: HWMOpenSubtitleResult) => {
      const message: string = res.result === SDKERR.HWM_SDKERR_SUCCESS ? '订阅字幕成功' : '订阅字幕失败';
      console.log(message);
    })
}

相关文档