# 直播水印 (/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## addVideoWatermark [#addvideowatermark] 添加本地视频水印。 ```ts abstract addVideoWatermark( watermarkUrl: string, options: WatermarkOptions ): number; ``` :::error[废弃] 弃用:该方法已废弃,请改用 [addVideoWatermarkWithConfig](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark#api_irtcengine_addvideowatermark3)。 ::: 该方法将一张 PNG 图片作为水印添加到本地发布的直播视频流上,同一直播频道中的用户、旁路直播观众和采集设备都能看到或采集到该水印图片。当前只支持在直播视频流中添加一个水印,后添加的水印会替换掉之前添加的水印。 水印坐标和 [setVideoEncoderConfiguration](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_setvideoencoderconfiguration) 方法中的设置有依赖关系: - 如果视频编码方向([OrientationMode](/zh-CN/api-reference/rtc/react-native/enum-orientationmode))固定为横屏或自适应模式下的横屏,那么水印使用横屏坐标。 - 如果视频编码方向([OrientationMode](/zh-CN/api-reference/rtc/react-native/enum-orientationmode))固定为竖屏或自适应模式下的竖屏,那么水印使用竖屏坐标。 - 设置水印坐标时,水印的图像区域不能超出 [setVideoEncoderConfiguration](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_setvideoencoderconfiguration) 方法中设置的视频尺寸,否则超出部分将被裁剪。 :::note 注: - 你需要在调用 [enableVideo](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_enablevideo) 方法之后再调用该方法。 - 如果你只是在旁路推流时添加水印,你可以使用该方法或 [startRtmpStreamWithTranscoding](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengine_startrtmpstreamwithtranscoding) 方法设置水印。 - 待添加水印图片必须是 PNG 格式。该方法支持所有像素格式的 PNG 图片:RGBA、RGB、Palette、Gray 和 Alpha_gray。 - 如果待添加的 PNG 图片的尺寸与你在该方法中设置的尺寸不一致,SDK 会对 PNG 图片进行缩放或裁剪,以与设置相符。 - 如果你已设置本地视频为镜像模式,那么此处的本地水印也为镜像。为避免本地用户看本地视频时的水印也被镜像,建议你不要对本地视频同时使用镜像和水印功能,请在应用层实现本地水印功能。 ::: ### 参数 [#参数] 待添加的水印图片的本地路径。该方法支持从本地绝对/相对路径添加水印图片。 待添加的水印图片的设置选项,详见 [WatermarkOptions](/zh-CN/api-reference/rtc/react-native/class-watermarkoptions)。 ### 返回值 [#返回值] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## addVideoWatermarkWithConfig [#addvideowatermarkwithconfig] 向本地视频流添加水印图像。 ```ts abstract addVideoWatermarkWithConfig(configs: WatermarkConfig): number; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: 你可以使用该方法在本地视频流中叠加水印图像,并通过 [WatermarkConfig](/zh-CN/api-reference/rtc/react-native/class-watermarkconfig) 设置水印在预览画面中的位置、大小和可见性。 ### 参数 [#参数-1] 水印配置。详见 [WatermarkConfig](/zh-CN/api-reference/rtc/react-native/class-watermarkconfig)。 ### 返回值 [#返回值-1] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-1] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## addVideoWatermarkEx [#addvideowatermarkex] 添加本地视频水印。 ```ts abstract addVideoWatermarkEx( watermarkUrl: string, options: WatermarkOptions, connection: RtcConnection ): number; ``` :::error[废弃] 弃用:该方法已废弃,请改用 [addVideoWatermarkWithConfigEx](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark#api_irtcengineex_addvideowatermarkex1)。 ::: 该方法将一张 PNG 图片作为水印添加到本地发布的直播视频流上,同一直播频道中的用户、旁路直播观众和采集设备都能看到或采集到该水印图片。当前只支持在直播视频流中添加一个水印,后添加的水印会替换掉之前添加的水印。 水印坐标和 [setVideoEncoderConfigurationEx](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengineex_setvideoencoderconfigurationex) 方法中的设置有依赖关系: - 如果视频编码方向([OrientationMode](/zh-CN/api-reference/rtc/react-native/enum-orientationmode))固定为横屏或自适应模式下的横屏,那么水印使用横屏坐标。 - 如果视频编码方向([OrientationMode](/zh-CN/api-reference/rtc/react-native/enum-orientationmode))固定为竖屏或自适应模式下的竖屏,那么水印使用竖屏坐标。 - 设置水印坐标时,水印的图像区域不能超出 [setVideoEncoderConfigurationEx](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengineex_setvideoencoderconfigurationex) 方法中设置的视频尺寸,否则超出部分将被裁剪。 :::note 注: - 你需要在调用 [enableVideo](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_enablevideo) 方法之后再调用本方法。 - 待添加水印图片必须是 PNG 格式。本方法支持所有像素格式的 PNG 图片:RGBA、RGB、Palette、Gray 和 Alpha_gray。 - 如果待添加的 PNG 图片的尺寸与你在本方法中设置的尺寸不一致,SDK 会对 PNG 图片进行缩放或裁剪,以与设置相符。 - 如果你已经使用 [startPreview](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_startpreview2) 方法开启本地视频预览,那么本方法的 `visibleInPreview` 可设置水印在预览时是否可见。 - 如果你已设置本地视频为镜像模式,那么此处的本地水印也为镜像。为避免本地用户看本地视频时的水印也被镜像,建议你不要对本地视频同时使用镜像和水印功能,请在应用层实现本地水印功能。 ::: ### 参数 [#参数-2] 待添加的水印图片的本地路径。该方法支持从本地绝对/相对路径添加水印图片。 待添加的水印图片的设置选项,详见 [WatermarkOptions](/zh-CN/api-reference/rtc/react-native/class-watermarkoptions)。 Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection)。 ### 返回值 [#返回值-2] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-2] - [IRtcEngineEx](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineex) ## addVideoWatermarkWithConfigEx [#addvideowatermarkwithconfigex] 向本地视频添加水印图像。 ```ts abstract addVideoWatermarkWithConfigEx( config: WatermarkConfig, connection: RtcConnection ): number; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 适用场景 [#适用场景] 该方法适用于多频道场景。 ### 参数 [#参数-3] 水印配置,详见 [WatermarkConfig](/zh-CN/api-reference/rtc/react-native/class-watermarkconfig)。 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection) 对象,详见 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection)。 ### 返回值 [#返回值-3] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-3] - [IRtcEngineEx](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineex) ## clearVideoWatermarkEx [#clearvideowatermarkex] 删除已添加的视频水印。 ```ts abstract clearVideoWatermarkEx(connection: RtcConnection): number; ``` ### 参数 [#参数-4] Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection)。 ### 返回值 [#返回值-4] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-4] - [IRtcEngineEx](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineex) ## clearVideoWatermarks [#clearvideowatermarks] 删除已添加的视频水印。 ```ts abstract clearVideoWatermarks(): number; ``` ### 返回值 [#返回值-5] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-5] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## removeVideoWatermark [#removevideowatermark] 从本地视频中移除水印图像。 ```ts abstract removeVideoWatermark(id: string): number; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: 该方法根据指定的唯一 ID,从本地视频流中移除之前添加的水印图像。 ### 参数 [#参数-5] 要移除的水印的 ID。该值需与添加水印时使用的 ID 相同。 ### 返回值 [#返回值-6] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-6] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## removeVideoWatermarkEx [#removevideowatermarkex] 从本地或远端视频流中移除指定的水印图像。 ```ts abstract removeVideoWatermarkEx( id: string, connection: RtcConnection ): number; ``` :::info[自从] 自 v4.6.2 版本新增。 ::: ### 适用场景 [#适用场景-1] 该方法适用于多频道场景。 ### 参数 [#参数-6] 水印 ID。 连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/react-native/class-rtcconnection)。 ### 返回值 [#返回值-7] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-7] - [IRtcEngineEx](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineex)