更新时间:2024-07-30 GMT+08:00

自定义会中水印

接口功能

该接口用于设置水印自定义内容注入,若未进行设置,将默认使用内部优先级来展示水印内容。注意事项:1、该接口必须在会前调用,会中调用不会即时生效;2、企业级水印开关未打开的场景下,水印自定义内容注入也不会生效。

函数原型

setWaterMark(waterMarkInfo: WaterMarkInfo, onSetWaterMarkResult?: (ret: SDKERR, reason: string) => void): void

请求参数

表1 入参说明
参数名称 是否必选 参数类型 参数说明
waterMarkInfo Y WaterMarkInfo 水印注入信息
onSetWaterMarkResult Y (ret: SDKERR, reason: string) => void 设置水印注入信息回调
表2 WaterMarkInfo
参数名称 是否必选 参数类型 参数说明
content N string 用户自定义水印注入内容
color N WaterMarkColorType 水印字体颜色,0-浅色,1-标准色,2-深色
表3 WaterMarkColorType枚举说明
枚举名称 枚举值 枚举说明
HWM_WATERMARK_COLOR_TYPE_LIGHT 0 浅色 #CCCCCC
HWM_WATERMARK_COLOR_TYPE_STANDARD 1 标准色 #999999
HWM_WATERMARK_COLOR_TYPE_DARKER 2 深色 #666666

返回值

void

回调方法参数说明:

(ret: SDKERR, reason: string) => void

表4 入参说明
参数名称 参数类型 参数说明
ret SDKERR 请参考错误码参考 错误码
reason string 错误描述