水印
更新时间: 2024/09/18 16:26:13
出于信息安全、版权声明、防伪、宣传等目的,您可以为视频流画面添加编码水印,例如添加公司名称、标语等文字水印、录制时间等时间戳水印、以及 logo 等图片水印。
在教育场景中,视频水印功能可以为教学课件设置版权方 Logo 等各种类型的水印;在金融场景中,为了保证业务员的操作规范性和服务质量、信息存档,需要对业务办理的全过程进行实时录制,并相应打上水印标识以实现防伪、记录等目的。
功能介绍
NERTC SDK 支持以下三种视频水印设置:
- 静态图片水印:使用图片作为水印。
- 文字水印:使用一段文字信息作为水印,支持设置字体和字号。
- 动态时间戳水印:使用当前时间戳作为水印,显示格式为 “yyyy-MM-dd HH:mm:ss"。
前提条件
- V5.5.0 之前的版本,请联系网易云信技术支持,开通视频水印功能。
- V5.5.0 及之后版本,您可以直接使用视频水印功能,无需人工开通。
注意事项
- 视频水印相关方法作用于发布的视频流,并非画布;当画布被移除时,水印也不会自动移除。因此,对视频流截图时,图片里显示水印。
- 每次仅支持设置单个视频水印,再次调用
setLocalVideoWatermarkConfigs
方法设置视频水印时,会覆盖之前的水印设置。 - 设置镜像模式时,水印不受镜像效果影响。
- V5.3.0 版本开始不再支持画布水印相关接口(
setLocalCanvasWatermarkConfigs
和setRemoteCanvasWatermarkConfigs
),建议您使用本文中的编码水印,编码水印可以从源头保证数据的真实性。
示例项目源码
网易云信提供 视频截图和水印的示例项目源码 SnapshotWatermark,您可以参考该源码给视频添加水印。
API时序图
sequenceDiagram
participant 应用层
participant NERtcSDK
应用层->>NERtcSDK: setLocalVideoWatermarkConfigs 设置视频水印
NERtcSDK-->>应用层: onLocalVideoWatermarkState
设置图片水印
- 调用
setLocalVideoWatermarkConfigs
方法设置视频水印,水印在本地视频预览与视频通话过程中均生效。调用此方法时,您需要设置 type 和 config 参数,相关参数的说明如下:
参数 |
描述 |
---|---|
type | 设置显示水印的视频流类型,可以设置为主流(kNERtcStreamChannelTypeMainStream)或辅流(kNERtcStreamChannelTypeSubStream)。 |
config |
设置视频水印的类型,图片水印的参数设置如下: |
图片水印imageWaterMark
详细的参数说明如下表所示。
参数 | 参数说明 |
---|---|
fps | 播放帧率。 取值范围为 0 ~ 30,默认值为 0,表示不自动切换图片。 |
loop | 是否设置循环。 默认值为 true,表示循环。若设置为 false ,则水印图片组播放完毕后消失。 |
imagePaths | 图片绝对路径。 支持 PNG 和 JPG 格式的图片,支持设置最多 10 张图片。 |
wmAlpha | 整体水印透明度。 取值范围为 0.0 ~ 1.0,默认值为 1.0,表示不透明。 |
wmWidth | 水印框的宽度。 单位为像素(pixel),默认值为 0,表示按原始图宽。 |
wmHeight | 水印框的高度。 单位为像素(pixel),默认值为 0,表示按原始图高。
|
offsetX | 设置图片水印位置。图片水印左上角与视频画布左上角的水平距离。 单位为像素(pixel),默认值为 0。 详细说明请参考设置水印位置。 |
offsetY | 图片水印左上角与视频画布左上角的垂直距离。 单位为像素(pixel),默认值为 0。 |
setLocalVideoWatermarkConfigs
接口的设置在通话结束后仍然有效,直至销毁 SDK。- 图片水印的图片大小不能超过 640*360 px。
- 设置 config 为 null 时,表示取消水印。
- 若您成功设置水印后再次调整水印参数,但出现传参错误,SDK 会取消上一次水印并返回
onLocalVideoWatermarkState
水印状态回调。 - 设置添加图片水印后,若 SDK 返回 30003,可能有以下原因:
- 没有传入任何图片或者图片张数大于 10。
- wmAlpha 参数(整体透明度)的值小于 0 或大于 1。
-
启用该方法后,SDK 会触发水印启用成功与否的
onLocalVideoWatermarkState
回调,并提供相关错误原因说明,具体请参考NERtcConstants.NERtcLocalVideoWatermarkState
。如果状态码提示设备不支持,请联系网易云信技术支持获取帮助。
示例代码
//图片水印 只列出部分关键参数
NERtcVideoWatermarkConfig config =new NERtcVideoWatermarkConfig();
config.watermarkType = NERtcVideoWatermarkConfig.WatermarkType.kNERtcWatermarkTypeImage;
config.imageWatermark = new NERtcVideoWatermarkImageConfig();
config.imageWatermark.imagePaths.add("water1.png");
config.imageWatermark.imagePaths.add("water2.png");
config.imageWatermark.fps = 15;
//设置水印,设置成功后,建议关注 onLocalVideoWatermarkState 水印状态回调
int ret = NERtcEx.getInstance().setLocalVideoWatermarkConfigs(NERtcVideoStreamType.kNERtcVideoStreamTypeMain, config);
// 取消水印
int ret = NERtcEx.getInstance().setLocalVideoWatermarkConfigs(NERtcVideoStreamType.kNERtcVideoStreamTypeMain, null);
设置文字水印
只能添加 1 个文字水印。
- 调用
setLocalVideoWatermarkConfigs
方法设置视频水印,水印在本地视频预览与视频通话过程中均生效。调用此方法时,您需要设置 type 和 config 参数,相关参数的说明如下:
参数 |
描述 |
---|---|
type | 设置显示水印的视频流类型,可以设置为主流(kNERtcStreamChannelTypeMainStream)或辅流(kNERtcStreamChannelTypeSubStream)。 |
config |
设置视频水印的类型,文字水印的参数设置如下: |
textWatermark
的参数说明如下表所示。
参数 | 参数说明 |
---|---|
content | 指定文字水印内容。 设置为空时,表示不添加文字水印。
|
fontNameOrPath | 字体文件的绝对路径,建议使用自己的字体文件。https://android.googlesource.com/platform/frameworks/base.git/+/refs/heads/master/data/fonts/DroidSansFallbackFull.ttf 下载使用,但只提供中文字体文件。 |
fontSize | 字体大小。 单位为像素(pixel),默认值为 15。 |
fontColor | 字体颜色。 格式为 ARGB,默认值为 0xFFFFFFFF,即白色。 |
wmAlpha | 整体水印透明度。 取值范围为 0.0 ~ 1.0,默认值为 1.0,表示不透明。 |
wmWidth | 水印框的宽度。 单位为像素(pixel),默认值为 0,表示没有水印框。 |
wmHeight | 水印框的高度。 单位为像素(pixel),默认值为 0,表示没有水印框。 |
wmColor | 水印框内背景颜色。 仅支持 ARGB 格式,默认值为 0x88888888,即灰色。支持透明度设置。 |
offsetX | 水印框左上角与视频画布左上角的水平距离。 单位为像素(pixel),默认值为 0。 详细说明请参考设置水印位置。 |
offsetY | 水印框左上角与视频画布左上角的垂直距离。 单位为像素(pixel),默认值为 0。 |
setLocalVideoWatermarkConfigs
接口的设置在通话结束后仍然有效,直至销毁 SDK。- 设置 config 为 null 时,表示取消水印。
- 若您成功设置水印后再次调整水印参数,但出现传参错误,SDK 会取消上一次水印并返回
onLocalVideoWatermarkState
水印状态回调。 - 设置添加文字水印后,若 SDK 返回 30003,可能有以下原因:
- 文字水印内容为空。
- 字体文件的路径为空。
- wmAlpha 参数(整体透明度)的值小于 0 或大于 1。
-
启用该方法后,SDK 会触发水印启用成功与否的
onLocalVideoWatermarkState
回调,并提供相关错误原因说明,具体请参考NERtcConstants.NERtcLocalVideoWatermarkState
。如果状态码提示设备不支持,请联系网易云信技术支持获取帮助。
示例代码
//文字水印 只列出部分关键参数
NERtcVideoWatermarkConfig config = new NERtcVideoWatermarkConfig();
config.watermarkType = NERtcVideoWatermarkConfig.WatermarkType.kNERtcWatermarkTypeText;
config.textWatermark = new NERtcVideoWatermarkTextConfig();
config.textWatermark.content = "我是水印";
config.textWatermark.fontColor = Color.parseColor("#ffffffff");
config.textWatermark.fontNameOrPath = "xxxx.ttf";
config.textWatermark.fontSize = 15;
config.textWatermark.offsetX = 0;
config.textWatermark.offsetY = 0;
//设置水印 设置成功后,建议关注onLocalVideoWatermarkState水印状态回调
int ret = NERtcEx.getInstance().setLocalVideoWatermarkConfigs(NERtcVideoStreamType.kNERtcVideoStreamTypeMain, config);
// 取消水印
int ret = NERtcEx.getInstance().setLocalVideoWatermarkConfigs(NERtcVideoStreamType.kNERtcVideoStreamTypeMain, null);
设置时间戳水印
- 只能添加 1 个时间戳水印。
- 时间戳水印的时间和当前时间相同,且实时变化。
- 调用
setLocalVideoWatermarkConfigs
方法设置视频水印,水印在本地视频预览与视频通话过程中均生效。调用此方法时,您需要设置 type 和 config 参数,相关参数的说明如下:
参数 |
描述 |
---|---|
type | 设置显示水印的视频流类型,可以设置为主流(kNERtcStreamChannelTypeMainStream)或辅流(kNERtcStreamChannelTypeSubStream)。 |
config |
设置视频水印的类型,时间戳水印的参数设置如下: |
timestampWatermark
的参数说明如下表所示。
参数 | 说明 |
---|---|
fontNameOrPath | 字体文件的绝对路径,建议使用自己的字体文件。 |
fontSize | 字体大小。 单位为像素(pixel),默认值为 15。 |
fontColor | 字体颜色。 默认值为 0xFFFFFFFF,即白色。 |
wmAlpha | 整体水印透明度。 取值范围为 0.0 ~ 1.0,默认值为 1.0,表示不透明。 |
wmWidth | 水印框的宽度。 单位为像素(pixel),默认值为 0 表示没有水印框。 |
wmHeight | 水印框的高度。 单位为像素(pixel),默认值为 0 表示没有水印框。 |
wmColor | 水印框内背景颜色。 仅支持 ARGB 格式,默认值为 0x88888888,即灰色。支持透明度设置。 |
offsetX | 水印框左上角与视频画布左上角的水平距离。 单位为像素(pixel),默认值为 0。 详细说明请参考设置水印位置。 |
offsetY | 水印框左上角与视频画布左上角的垂直距离。 单位为像素(pixel),默认值为 0。 |
setLocalVideoWatermarkConfigs
接口设置在通话结束后仍然有效,直至销毁 SDK。- 设置 config 为 null 时,表示取消水印。
- 若您成功设置水印后再次调整水印参数,但出现传参错误,SDK 会取消上一次水印并返回
onLocalVideoWatermarkState
水印状态回调。 - 设置添加时间戳水印后,若 SDK 返回 30003,可能有以下原因:
- 字体文件的路径为空。
- wmAlpha 参数(整体透明度)的值小于 0 或大于 1。
-
启用该方法后,SDK 会触发水印启用成功与否的
onLocalVideoWatermarkState
回调,并提供相关错误原因说明,具体请参考NERtcConstants.NERtcLocalVideoWatermarkState
。如果状态码提示设备不支持,请联系网易云信技术支持获取帮助。
示例代码
//时间戳水印 只列出部分关键参数
NERtcVideoWatermarkConfig config = new NERtcVideoWatermarkConfig();
config.watermarkType = NERtcVideoWatermarkConfig.WatermarkType.kNERtcWatermarkTypeTimestamp;
config.timestampWatermark = new NERtcVideoWatermarkTimestampConfig();
config.timestampWatermark.fontColor = Color.parseColor("#ffffffff");
config.timestampWatermark.fontNameOrPath = "xxxx.ttf";
config.timestampWatermark.fontSize = 15;
config.timestampWatermark.offsetX = 0;
config.timestampWatermark.offsetY = 0;
//设置水印,设置成功后,建议关注 onLocalVideoWatermarkState 水印状态回调
int ret = NERtcEx.getInstance().setLocalVideoWatermarkConfigs(NERtcVideoStreamType.kNERtcVideoStreamTypeMain, config);
// 取消水印
int ret = NERtcEx.getInstance().setLocalVideoWatermarkConfigs(NERtcVideoStreamType.kNERtcVideoStreamTypeMain, null);
相关参考
设置水印位置
添加水印时,可以通过 offsetX、offsetY、wmWidth 和 wmHeight 设置水印的位置和区域大小。
API 参考
方法 | 功能描述 |
---|---|
setLocalVideoWatermarkConfigs |
设置水印 |
onLocalVideoWatermarkState |
是否成功设置水印的回调通知 |