直播水印

  • Unreal Blueprint

更新时间不可用

AddVideoWatermark

添加本地视频水印。

C++
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int AddVideoWatermark(const FString& watermarkUrl, const FWatermarkOptions& options);

详情

该方法将一张 PNG 图片作为水印添加到本地发布的直播视频流上,同一直播频道中的用户、旁路直播观众和采集设备都能看到或采集到该水印图片。当前只支持在直播视频流中添加一个水印,后添加的水印会替换掉之前添加的水印。

水印坐标和 SetVideoEncoderConfiguration 方法中的设置有依赖关系:

  • 如果视频编码方向(EUABT_ORIENTATION_MODE)固定为横屏或自适应模式下的横屏,那么水印使用横屏坐标。
  • 如果视频编码方向(EUABT_ORIENTATION_MODE)固定为竖屏或自适应模式下的竖屏,那么水印使用竖屏坐标。
  • 设置水印坐标时,水印的图像区域不能超出 SetVideoEncoderConfiguration 方法中设置的视频尺寸,否则超出部分将被裁剪。

注意:

  • 你需要在调用 EnableVideo 方法之后再调用该方法。
  • 如果你只是在旁路推流时添加水印,你可以使用该方法或 StartRtmpStreamWithTranscoding 方法设置水印。
  • 待添加水印图片必须是 PNG 格式。该方法支持所有像素格式的 PNG 图片:RGBA、RGB、Palette、Gray 和 Alpha_gray。
  • 如果待添加的 PNG 图片的尺寸与你在该方法中设置的尺寸不一致,SDK 会对 PNG 图片进行缩放或裁剪,以与设置相符。
  • 如果你已设置本地视频为镜像模式,那么此处的本地水印也为镜像。为避免本地用户看本地视频时的水印也被镜像,建议你不要对本地视频同时使用镜像和水印功能,请在应用层实现本地水印功能。

参数

参数名描述
watermarkUrl

待添加的水印图片的本地路径。该方法支持从本地绝对/相对路径添加水印图片。

options

待添加的水印图片的设置选项,详见 FWatermarkOptions。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

AddVideoWatermarkEx

添加本地视频水印。

C++
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int AddVideoWatermarkEx(const FString& watermarkUrl, const FWatermarkOptions& options, const FRtcConnection& connection);

详情

该方法将一张 PNG 图片作为水印添加到本地发布的直播视频流上,同一直播频道中的用户、旁路直播观众和采集设备都能看到或采集到该水印图片。当前只支持在直播视频流中添加一个水印,后添加的水印会替换掉之前添加的水印。

水印坐标和 SetVideoEncoderConfigurationEx 方法中的设置有依赖关系:

  • 如果视频编码方向(EUABT_ORIENTATION_MODE)固定为横屏或自适应模式下的横屏,那么水印使用横屏坐标。
  • 如果视频编码方向(EUABT_ORIENTATION_MODE)固定为竖屏或自适应模式下的竖屏,那么水印使用竖屏坐标。
  • 设置水印坐标时,水印的图像区域不能超出 SetVideoEncoderConfigurationEx 方法中设置的视频尺寸,否则超出部分将被裁剪。

注意:

  • 你需要在调用 EnableVideo 方法之后再调用本方法。
  • 待添加水印图片必须是 PNG 格式。本方法支持所有像素格式的 PNG 图片:RGBA、RGB、Palette、Gray 和 Alpha_gray。
  • 如果待添加的 PNG 图片的尺寸与你在本方法中设置的尺寸不一致,SDK 会对 PNG 图片进行缩放或裁剪,以与设置相符。
  • 如果你已经使用 StartPreview 方法开启本地视频预览,那么本方法的 visibleInPreview 可设置水印在预览时是否可见。
  • 如果你已设置本地视频为镜像模式,那么此处的本地水印也为镜像。为避免本地用户看本地视频时的水印也被镜像,建议你不要对本地视频同时使用镜像和水印功能,请在应用层实现本地水印功能。

参数

参数名描述
watermarkUrl

待添加的水印图片的本地路径。该方法支持从本地绝对/相对路径添加水印图片。

options

待添加的水印图片的设置选项,详见 FWatermarkOptions。

connection

Connection 信息。详见 FUABT_RtcConnection。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

ClearVideoWatermarks

删除已添加的视频水印。

C++
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int ClearVideoWatermarks();

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

ClearVideoWatermarkEx

删除已添加的视频水印。

C++
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int ClearVideoWatermarkEx(const FRtcConnection& connection);

参数

参数名描述
connection

Connection 信息。详见 FUABT_RtcConnection。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类