出于信息安全、版权声明、防伪、宣传等目的，您可以为视频流画面添加编码水印，例如添加公司名称、标语等文字水印、录制时间等时间戳水印、以及 logo 等图片水印。

在教育场景中，视频水印功能可以为教学课件设置版权方 Logo 等各种类型的水印；在金融场景中，为了保证业务员的操作规范性和服务质量、信息存档，需要对业务办理的全过程进行实时录制，并相应打上水印标识以实现防伪、记录等目的。

功能介绍

NERTC SDK 支持以下三种视频水印设置：

• 静态图片水印：使用图片作为水印。
• 文字水印：使用一段文字信息作为水印，支持设置字体和字号。
• 动态时间戳水印：使用当前时间戳作为水印，显示格式为 “yyyy-MM-dd HH:mm:ss"。

前提条件

• V5.5.0 之前的版本，请联系网易云信技术支持，开通视频水印功能。
• V5.5.0 及之后版本，您可以直接使用视频水印功能，无需人工开通。

注意事项

• 视频水印相关方法作用于发布的视频流，并非画布；当画布被移除时，水印也不会自动移除。因此，对视频流截图时，图片里显示水印。
• 每次仅支持设置单个视频水印，再次调用 setLocalVideoWatermarkConfigs 方法设置视频水印时，会覆盖之前的水印设置。
• 设置镜像模式时，水印不受镜像效果影响。
• V5.3.0 版本开始不再支持画布水印相关接口（setLocalCanvasWatermarkConfigs 和 setRemoteCanvasWatermarkConfigs ），建议您使用本文中的编码水印，从源头保证数据的真实性。

配置步骤

1. 调用 setLocalVideoWatermarkConfigs 方法设置视频水印，水印在本地视频预览与视频通话过程中均生效。调用此方法时，您需要设置 enabled、type 和 config 参数，相关参数的说明如下：

参数	描述
enabled	添加或删除水印。 true：添加水印。 false：删除水印。
type	设置显示水印的视频流类型，可以设置为主流（kNERtcVideoStreamMain）或辅流（kNERtcVideoStreamSub）。
config	设置视频水印的类型，支持的类型如下： 图片水印：设置 watermarkType 参数为 kNERtcWatermarkTypeImage，并通过 image_watermarks 参数配置图片水印。 文字水印：设置 watermarkType 参数为 kNERtcWatermarkTypeText，并通过 text_watermarks 参数配置文字水印。 时间戳水印：设置 watermarkType 参数为 kNERtcWatermarkTypeTimestamp，并通过 timestamp_watermarks 参数配置时间戳水印。

• 此接口设置在通话结束后仍然有效，直至销毁 SDK。
• 设置水印成功后，SDK 会返回 onLocalVideoWatermarkState 水印状态回调。
• 若您成功设置水印后再次调整水印参数，但出现传参错误，SDK 会取消上一次水印并返回 onLocalVideoWatermarkState 水印状态回调。

2. 启用该方法后，SDK 会触发水印启用成功与否的 onLocalVideoWatermarkState() 回调，并提供相关错误原因说明，具体请参考 NERtcLocalVideoWatermarkState。

   如果状态码提示设备不支持，请联系网易云信技术支持获取帮助。

设置图片水印

设置 watermarkType 参数为 kNERtcWatermarkTypeImage，并通过 imageWaterMark 参数配置图片水印，图片水印详细的参数说明如下表所示。

参数	参数说明
fps	播放帧率。 取值范围为 0 ~ 30，默认值为 0，表示不自动切换图片。
loop	是否设置循环。 默认值为 true，表示循环。若设置为 false ，则水印图片组播放完毕后消失。
image_paths	图片绝对路径。 支持 PNG 和 JPG 格式的图片，支持设置最多 10 张图片。
wm_alpha	整体水印透明度。 取值范围为 0.0 ~ 1.0，默认值为 1.0，表示不透明。
wm_width	水印框的宽度。 单位为像素（pixel），默认值为 0，表示按原始图宽。
wm_height	水印框的高度。 单位为像素（pixel），默认值为 0，表示按原始图高。
offset_x	图片左上角与视频画布左上角的水平距离。 单位为像素（pixel），默认值为 0。
offset_y	图片左上角与视频画布左上角的垂直距离。 单位为像素（pixel），默认值为 0。

注意事项

• 若您设置的播放帧率高于视频流的帧率，则按照视频流帧率切换图片。
• 图片水印的图片大小不能超过 640*360 px。
• 若您设置了水印框的宽度和高度，图片将缩放至水印框的宽高尺寸；若您未设置水印框的宽高，图片将按原始尺寸展示，但当原始尺寸大于视频画面尺寸时，图片将缩放至视频画面尺寸。
• 支持通过 offsetX 等参数设置图片水印位置，详细说明请参考设置水印位置。
• 设置添加图片水印后，若 SDK 返回 30003，可能有以下原因：
  • 没有传入任何图片或者图片张数大于 10。
  • wmAlpha 参数（整体透明度）的值小于 0 或大于 1。

示例代码

//图片水印
NERtcVideoStreamType streamType = kNERTCVideoStreamMain;//或kNERTCVideoStreamSub
NERtcVideoWatermarkConfig config;
config.watermark_type = NERtcVideoWatermarkConfig::kNERtcWatermarkTypeImage;
NERtcVideoWatermarkImageConfig image_watermarks;
image_watermarks.wm_alpha = 1.0f;
image_watermarks.wm_width = 100;
image_watermarks.wm_height = 100;
image_watermarks.offset_x = 0;
image_watermarks.offset_y = 0;
image_watermarks.fps = 0;
image_watermarks.loop = false;
strcpy(image_watermarks.image_paths[i], image_path);
config.image_watermarks = image_watermarks;
rtcEngine->setLocalVideoWatermarkConfigs(true, streamType, config);

设置文字水印

设置 watermarkType 参数为 kNERtcWatermarkTypeText，并通过 text_watermarks 参数配置文字水印，文字水印详细的参数说明如下表所示。

参数	参数说明
content	指定文字水印内容。 设置为空时，表示不添加文字水印。
font_name	字体的名称。如果系统或应用中未安装该字体，则使用系统默认字体。
font_size	字体大小。 单位为像素（pixel），默认值为 10，相当于 144 dpi 设备上的 10 x 15 磅。
font_color	字体颜色。 格式为 ARGB，默认值为 0xFFFFFFFF，即白色。
wm_alpha	整体水印透明度。 取值范围为 0.0 ~ 1.0，默认值为 1.0，表示不透明。
wm_width	水印框的宽度。 单位为像素（pixel），默认值为 0，表示没有水印框。
wm_height	水印框的高度。 单位为像素（pixel），默认值为 0，表示没有水印框。
wm_color	水印框内背景颜色。 仅支持 ARGB 格式，默认值为 0x88888888，即灰色。支持透明度设置。
offset_x	水印框左上角与视频画布左上角的水平距离。 单位为像素（pixel），默认值为 0。
offset_y	水印框左上角与视频画布左上角的垂直距离。 单位为像素（pixel），默认值为 0。

注意事项

• 只能添加 1 个文字水印。
• 文字水印的字符串长度没有限制。最终显示受字体大小和水印框大小的影响，超出水印框的部分不显示。
• 文字水印支持自动换行，当文字内容长度超过水印框宽度时，会自动换行。
• 支持通过 offsetX 等参数设置文字水印位置，详细说明请参考设置水印位置。
• 设置添加文字水印后，若 SDK 返回 30003，可能有以下原因：
  • 文字水印内容为空。
  • 字体文件的路径为空。
  • wmAlpha 参数（整体透明度）的值小于 0 或大于 1。

示例代码

//文字水印
NERtcVideoStreamType streamType = kNERTCVideoStreamMain;//或kNERTCVideoStreamSub
NERtcVideoWatermarkConfig config;
config.watermark_type = NERtcVideoWatermarkConfig::kNERtcWatermarkTypeText;
NERtcVideoWatermarkTextConfig text_watermarks;
strcpy(text_watermarks.content, content);
strcpy(text_watermarks.font_name, font_name);
text_watermarks.font_color = 0xFFFFFFFF;
text_watermarks.font_size = 15;
text_watermarks.wm_color = 0x88888888;
text_watermarks.wm_alpha = 1.0f;
text_watermarks.wm_width = 100;
text_watermarks.wm_height = 100;
text_watermarks.offset_x = 0;
text_watermarks.offset_y = 0;
config.text_watermarks = text_watermarks;
rtcEngine->setLocalVideoWatermarkConfigs(true, streamType, config);

设置时间戳水印

设置 watermarkType 参数为 kNERtcWatermarkTypeTimestamp ，并通过 timestamp_watermark 参数配置时间戳水印，时间戳水印详细的参数说明如下表所示。

参数	说明
font_name	字体文件的名称。 如果系统或应用中未安装该字体，则使用系统默认字体。
font_size	字体大小。 单位为像素（pixel），默认值为 10，相当于 144 dpi 设备上的 10 x 15 磅。
font_color	字体颜色。 默认值为 0xFFFFFFFF，即白色。
wm_alpha	整体水印透明度。 取值范围为 0.0 ~ 1.0，默认值为 1.0，表示不透明。
wm_width	水印框的宽度。 单位为像素（pixel），默认值为 0 表示没有水印框。
wm_height	水印框的高度。 单位为像素（pixel），默认值为 0 表示没有水印框。
wm_color	水印框内背景颜色。 仅支持 ARGB 格式，默认值为 0x88888888，即灰色。支持透明度设置。
offset_x	水印框左上角与视频画布左上角的水平距离。 单位为像素（pixel），默认值为 0。
offset_y	水印框左上角与视频画布左上角的垂直距离。 单位为像素（pixel），默认值为 0。

注意事项

• 只能添加 1 个时间戳水印。
• 时间戳水印的时间和当前时间相同，且实时变化。
• 支持通过 offsetX 等参数设置时间戳水印位置，详细说明请参考设置水印位置。
• 设置添加时间戳水印后，若 SDK 返回 30003，可能有以下原因：
  • 字体文件的路径为空。
  • wmAlpha 参数（整体透明度）的值小于 0 或大于 1。

示例代码

//时间戳水印
NERtcVideoStreamType streamType = kNERTCVideoStreamMain;//或kNERTCVideoStreamSub
NERtcVideoWatermarkConfig config;
config.watermark_type = NERtcVideoWatermarkConfig::kNERtcWatermarkTypeTimestamp;
NERtcVideoWatermarkTimestampConfig timestamp_watermark;
strcpy(timestamp_watermark.font_name, font_name);
timestamp_watermark.font_color = 0xFFFFFFFF;
timestamp_watermark.font_size = 15;
timestamp_watermark.wm_color = 0x88888888;
timestamp_watermark.wm_alpha = 1.0f;
timestamp_watermark.wm_width = 100;
timestamp_watermark.wm_height = 100;
timestamp_watermark.offset_x = 0;
timestamp_watermark.offset_y = 0;
config.timestamp_watermark = timestamp_watermark;
rtcEngine->setLocalVideoWatermarkConfigs(true, streamType, config);

相关参考

设置水印位置

添加水印时，可以通过 offsetX、offsetY、wmWidth 和 wmHeight 设置水印的位置和区域大小。

API 参考

方法	功能描述
setLocalVideoWatermarkConfigs	设置水印
onLocalVideoWatermarkState	是否成功设置水印的回调通知