跳到主要内容

水印处理

SDK 从 5.2.5 版本开始支持该功能。

融云支持在直播中在视频流上添加水印。添加水印有两种控制方式,本文仅介绍方案一:

  • 方案一:使用客户端 SDK 提供的 setWatermark 方法添加图片水印。客户端发布的视频流即带有图片水印,因此订阅分流或合流的直播观众均会看到带水印的视频流。
  • 方案二:使用服务端 API 的 /rtc/mcu/config 接口,在服务端处理,添加时间戳水印、文字水印或图片水印。这种方式支持为单人视频流或合流视频添加水印,但只有订阅合流的观众可看到带水印的视频流。本文不介绍服务端的处理方案,如有需要,请参见服务端文档直播合流
提示

方案一适用于实现 App 客户端用户自主添加个性化水印;方案二更适用于由 App 添加统一风格的水印。 客户端与服务端添加的水印相互独立。如果同时使用,则订阅合流的观众可能会看到水印叠加。

设置水印

RCRTCEngine 内置了设置水印的接口,通过调用 setWatermark 方法即可实现为相机、自定义文件、共享桌面采集到的视频流添加水印的功能。每一道视频流水印设置是独立的。

方法

/**
* 设置水印
* @param path 水印图片的本地路径
* @param positionX 水印的位置,x坐标,参数取值范围 0 ~ 1,浮点型
* @param positionY 水印的位置,y坐标,参数取值范围 0 ~ 1,浮点型
* @param zoom 图片缩放系数,参数取值范围 0 \< zoom ≦ 1
* SDK 内部会根据视频分辨率计算水印实际的像素位置和尺寸。
* @return 接口调用状态码 0: 成功, 非0: 失败
*/
setWatermark(path: string, positionX: number, positionY: number, zoom: number): number;
参数类型必填说明
pathString水印图片的本地路径
positionXnumber水印的位置,x坐标,浮点型。注意:参数取值范围 0 ~ 1,SDK 内部会根据视频分辨率计算水印实际的像素位置。
positionYnumber水印的位置,y坐标,浮点型。注意:参数取值范围 0 ~ 1,SDK 内部会根据视频分辨率计算水印实际的像素位置。
zoomnumber水印的缩放比,注意:参数取值范围 0 < zoom ≦ 1,SDK 内部会根据视频分辨率计算水印实际的大小
  • zoom:水印的缩放比,取值范围 0 < zoom ≦ 1。例如,水印图片的宽度 480 × 0.2 = 96,高度根据图片原始宽高比等比例缩放。 例如,当前视频的编码分辨率是 480(宽) × 640(高),且 position 参数被您设置为(0.1,0.1)、zoom 设置为 0.2。那么水印的左上坐标点就是(480 × 0.1,640 × 0.1),即(48,64),水印的宽度是 480 × 0.2 = 96,水印的高度会根据水印图片的宽高比由 SDK 自动算出。

清除水印

通过调用 RCRTCEngine 对象的 removeWatermark 方法移除客户端设置的水印。

方法

// 清除客户端设置的水印
/**
* 移除水印
* @return 接口调用状态码 0: 成功, 非0: 失败
*/
removeWatermark(): number;

示例代码

//添加水印的回调
engine.setOnWatermarkSetListener(({code,message}) => {
if (code == 0){
// 水印设置成功
}
});

//添加水印
let path = '***'
engine.setWatermark(path, 0.2, 0.2, 0.2)

//清除水印的回调
engine.setOnWatermarkRemovedListener(({code,message}) => {
if (code == 0) {
//水印清除成功
}
};
//清除水印
engine.removeWatermark();

注意事项

  • 添加水印图片不宜过大。建议图片宽高均不超过 200px,否则会影响图片在安卓原生层转 Bitmap 的生成。

  • 禁止程序循环反复调用添加/清除水印接口。

  • 安卓端水印功能需要在 manifest.jsonApp权限配置 中勾选下方两项外部存储读写权限:

    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />