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

自定义会中水印

SetWaterMark

接口描述

该接口用于设置水印自定义内容注入,若未进行设置,将默认使用内部优先级来展示水印内容。

图1 自定义水印

注意事项

  1. 该接口必须在会前调用,会中调用不会即时生效。
  2. 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。
  3. 企业级水印开关未打开的场景下,水印自定义内容注入也不会生效。

方法定义

1
HWM_SDK_AGENT_API hwmsdk::HwmErrCode SetWaterMark(const HwmWaterMarkInfo * wtInfo);

回调函数

1
virtual void OnSetWaterMarkInjectInfoResult(hwmsdk::HwmErrCode ret, const char* reason) {};

参数描述

表1 参数说明

参数

是否必须

类型

描述

wtInfo

HwmWaterMarkInfo

设置水印注入信息。

表2 结构体HwmWaterMarkInfo参数说明

参数

类型

描述

content

char[]

设置用户自定义水印注入内容。

color

HwmWaterMarkColorType

设置水印字体颜色。

表3 枚举HwmWaterMarkColorType说明

枚举值

描述

HWM_WATERMARK_COLOR_TYPE_LIGHT

浅色 #CCCCCC。

HWM_WATERMARK_COLOR_TYPE_STANDARD

标准色 #999999。

HWM_WATERMARK_COLOR_TYPE_DARKER

深色 #666666。

返回值

表4 返回值

类型

描述

HwmErrCode

成功返回0,其他值表示失败。失败返回值见错误码参考

示例代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
/**
* 设置水印
*/
void demoWaterMarkInfoDlg::OnBnClickedSetWaterMarkInjectInfo()
{
    unsigned int color = hwmsdkagent::HWM_WATERMARK_COLOR_TYPE_LIGHT;
    hwmsdkagent::HwmWaterMarkInfo injectInfo = {0};
    
    strncpy_s(injectInfo.content, GetContent().c_str(), HWM_MAX_WATERMARK_CONTENT_LEN);
    injectInfo.color = (hwmsdkagent::HwmWaterMarkColorType)color;
    int ret = hwmsdkagent::SetWaterMark(&injectInfo);
    if (hwmsdk::HWM_COMMON_SUCCESS != ret)
    {
        AfxMessageBox(_T("SetWaterMark inject info failed"));
    }
}