# 在录制文件中添加水印 (/zh-CN/realtime-media/local-server-recording/build/legacy/watermark) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). 在使用合流录制模式时,你可在录制视频文件中添加水印,如公司 Logo、时间戳或特定文字信息,以实现防伪、版权声明、宣传或记录等目的。 从 v3.0.0 起,本地服务端录制 SDK 支持文字、动态时间戳和静态图片三种水印,你可按需选择。 - 文字水印:使用一段文字作为水印,可设置字体和字号。 - 动态时间戳水印:使用录制服务器的当前时间作为水印,显示形式为 `2019:06:18 14:30:35`。 - 静态图片水印:使用一张本地 PNG 图片作为水印。 ## 设置水印 [#设置水印] 录制 SDK 通过 `VideoMixingLayout` 中的 `wm_num` 和 `wm_configs` 成员对水印进行配置,其中: - `wm_num` 设置水印的总个数。SDK 最多支持设置 15 个水印,其中文字水印最多 10 个,时间戳水印最多 1 个,图片水印最多 4 个。 - `wm_configs` 为水印的具体配置,是由多个 `WatermarkConfig` 组成的数组。一个 `WatermarkConfig` 对应一个水印。`WatermarkConfig` 的个数需与 `wm_num` 参数中设置的水印个数保持一致。 - `WatermarkConfig` 中,通过 `type` 参数指定该水印的类型,通过 `config` 参数定义该水印的具体设置。 录制 SDK 通过 `VideoMixingLayout` 中的 `literalWms`、`timestampWms` 和 `imageWms` 成员分别对文字、时间戳、图片类型的水印进行配置。 ### 设置文字水印 [#设置文字水印] 添加文字水印时,设置以下参数: - `type` 参数设置为 `WATERMARK_TYPE_LITERA`。 - 设置 `config` 中的 `wm_litera` 参数添加文字内容。 - 设置 `config` 中的 `font_size` 指定字号。如不设置,字号默认值为 10(相当于 144 dpi 设备上的 10 × 15 磅)。 - 设置 `config` 中的 `font_file_path` 指定字体文件路径。支持 ttf,otf 等字体格式。如不设置,使用默认字体 NotoSansMonoCJKsc-Regular。 - 设置 `config` 中的 `offset_x`,`offset_y`,`wm_width`,`wm_height` 参数设置水印的水平位置、垂直位置、宽度、高度。详见[设置水印大小和位置](#size)。 通过 `literalWms` 参数设置文字水印。`literalWms` 是由多个 `LiteraWatermarkConfig` 组成的数组,一个 `LiteraWatermarkConfig` 对应一个文字水印。 `LiteraWatermarkConfig` 中包含以下设置: - 设置 `wmLitera` 参数添加文字内容。 - 设置 `fontFilePath` 参数指定字体文件路径。支持 ttf,otf 等字体格式。如不设置,使用默认字体 NotoSansMonoCJKsc-Regular。 - 设置 `fontSize` 参数指定文字的字号。如不设置,默认值为 10(相当于 144 DPI 设备上的 10 × 15 磅)。 - 通过 `offsetX`,`offsetY`,`wmWidth`,`wmHeight` 四个参数设置水印的水平位置、垂直位置、宽度、高度,详见[设置水印大小和位置](#size)。 :::info[信息] - 最多可添加 10 个文字水印。 - 仅支持 **UTF-8** 编码。 - 支持字符取决于字体。默认字体为 NotoSansMonoCJKsc-Regular,支持的语言和字符详见[字体介绍](https://www.google.com/get/noto/help/cjk/)。 - 字符串长度没有限制。文字内容的最终显示受字号和水印框大小的影响,超出水印框的部分不显示。 - 支持自动换行,当文字内容长度超过水印框宽度时,会自动换行。也支持换行符 `\n`。 - 文字颜色为黑色或白色,会根据视频画布的颜色自动调整。若视频背景较暗,则颜色为白色;若视频背景较亮,则颜色为黑色。当视频背景不均匀时,颜色为黑白相间。 ::: ### 设置时间戳水印 [#设置时间戳水印] 添加时间戳水印时,设置以下参数: - `type` 参数设置为 `WATERMARK_TYPE_TIMESTAMP`。 - 设置 `config` 中的 `font_size` 参数指定时间戳的字号。如不设置,字号默认值为 10(相当于 144 dpi 设备上的 10 × 15 磅)。 - 设置 `config` 中的 `offset_x`,`offset_y`,`wm_width`,`wm_height` 参数设置水印的水平位置、垂直位置、宽度、高度。详见[设置水印大小和位置](#size)。 通过 `timestampWms` 参数设置时间戳水印。`timestampWms` 是由 `TimestampWatermarkConfig` 组成的数组,一个 `TimestampWatermarkConfig` 对应一个时间戳水印。 `TimestampWatermarkConfig` 中包含以下设置: - 设置 `fontSize` 参数指定时间戳的字号。如不设置,默认值为 10(相当于 144 DPI 设备上的 10 × 15 磅)。 - 通过 `offsetX`,`offsetY`,`wmWidth`,`wmHeight` 四个参数设置水印的水平位置、垂直位置、宽度、高度,详见[设置水印大小和位置](#size)。 :::info[信息] - 只能添加 1 个时间戳水印。 - 时间戳显示录制服务器的当前时间,会动态变化,显示形式为 `2019:06:18 14:30:35`。 - 时间戳颜色为黑色或白色,会根据视频画布的颜色自动调整。若视频背景较暗,则颜色为白色;若视频背景较亮,则颜色为黑色。当视频背景不均匀时,颜色为黑白相间。 ::: ### 设置图片水印 [#设置图片水印] 添加图片水印时,设置以下参数: - `type` 设置为 `WATERMARK_TYPE_IMAGE`。 - 设置 `config` 中的 `image_path` 指定图片路径。 - 设置 `config` 中的 `offset_x`,`offset_y`,`wm_width`,`wm_height` 参数设置水印的水平位置、垂直位置、宽度、高度。详见[设置水印大小和位置](#size)。 通过 `imageWms` 参数设置图片水印。`imageWms` 是由多个 `ImageWatermarkConfig` 组成的数组,一个 `ImageWatermarkConfig` 对应一个图片水印。 `ImageWatermarkConfig` 中包含以下设置: - 设置 `imagePath` 参数指定图片路径,仅支持本地 PNG 图片。 - 通过 `offsetX`,`offsetY`,`wmWidth`,`wmHeight` 四个参数设置水印的水平位置、垂直位置、宽度、高度,详见[设置水印大小和位置](#size)。 :::info[信息] - 最多可添加 4 个图片水印。 - 仅支持本地 PNG 图片。 - 建议图片分辨率不超过 480p。 - 如果图片小于水印框,图片居中显示,不拉伸;如果图片大于水印框,图片等比缩小至合适水平,再居中显示。 ::: ### 设置水印大小和位置 [#设置水印大小和位置] 无论添加哪种水印,你都必须通过 `config` 中的 `offset_x`,`offset_y`,`wm_width`,`wm_height` 四个参数设置水印的水平位置、垂直位置、宽度、高度。 ![设置水印大小和位置](https://web-cdn.agora.io/docs-files/1564471864622) 如上图所示,以**视频画布左上角**为原点,`offset_x` 和 `offset_y` 分别代表**水印框左上角**到原点的水平距离和垂直距离,`wm_width` 和 `wm_height` 分别代表水印框的**宽度**和**高度**。这四个参数均为绝对值,单位为像素,默认值为 0。 无论添加哪种水印,你都必须通过 `offsetX`,`offsetY`,`wmWidth`,`wmHeight` 四个参数设置水印的水平位置、垂直位置、宽度、高度。 ![设置水印大小和位置](https://web-cdn.agora.io/docs-files/1564544792118) 如上图所示,以**视频画布左上角**为原点,`offsetX` 和 `offsetY` 分别代表**水印框左上角**到原点的水平距离和垂直距离,`wmWidth` 和 `wmHeight` 分别代表水印框的**宽度**和**高度**。这四个参数均为绝对值,单位为像素,默认值为 0。 :::info[信息] - 水印框完全透明,无颜色。 - 如果水印框超出画布范围,则水印框与画布的交集区域会作为显示区域。 ::: ## 添加水印 [#添加水印] 你可通过以下方法添加水印: - 在调用 `setVideoMixingLayout` 方法设置合流布局时,设置 `wm_num` 和 `wm_configs` 参数添加水印。 - 直接调用 `updateWatermarkConfigs` 方法,设置 `wm_num` 和 `configs` 参数添加水印。 - 调用 `setVideoMixingLayout` 方法设置合流布局时,设置 `literalWms`、`timestampWms` 和 `imageWms` 参数分别添加文字水印、时间戳水印或图片水印。 - 直接调用 `updateWatermarkConfigs` 方法设置 `literaWms`、`timestampWms` 和 `imgWms` 参数分别添加文字水印、时间戳水印或图片水印。 ## 更新和删除水印 [#更新和删除水印] 调用 `setVideoMixingLayout` 或 `updateWatermarkConfigs` 方法均可更改水印的个数和具体设置,也可删除已添加的水印。 举例来说,假设视频中已有 1 个图片水印和 1 个文字水印。如想删除文字水印,可以将 `wm_num` 改为 1,传入原先的图片水印的设置,再调用 `updateWatermarkConfigs` 方法。 如想删除全部已添加的水印,只能调用 `updateWatermarkConfigs` 方法,将 `wm_num` 设为 0,`configs` 设置为空。调用 `setVideoMixingLayout` 更新合流布局时,如果没有水印信息, 即不对水印进行任何修改,因此不能删除所有已添加的水印。 举例来说,假设视频中已有 1 个图片水印和 1 个文字水印。如想删除文字水印,可以调用 `setVideoMixingLayout` 或 `updateWatermarkConfigs` 方法只传入原先的图片水印的设置。 如想删除全部已添加的水印,只能调用 `updateWatermarkConfigs` 方法。调用 `setVideoMixingLayout` 更新合流布局时,如果没有水印信息,即不对水印进行任何修改,不能删除所有已添加的水印。 ## 示例代码 [#示例代码] 参考如下示例代码,了解如何调用 `setVideoMixingLayout` 方法添加 1 个图片水印、1 个时间戳水印和 1 个文字水印。 ```cpp tab="C++" tabGroup="zh-cn-realtime-media-recording-local-server-recording-build-recording-modes-legacy-watermark-1" agora::linuxsdk::VideoMixingLayout layout; //TO DO: Set other video mixing layout configuration here. //Watermark configuration. agora::linuxsdk::WatermarkConfig config[3]; config[0].type = agora::linuxsdk::WATERMARK_TYPE_IMAGE; config[0].config.image.image_path = "path-to-image.png"; config[0].config.image.offset_x = 20; config[0].config.image.offset_y = 20; config[0].config.image.wm_width = 200; config[0].config.image.wm_height = 300; config[1].type = agora::linuxsdk::WATERMARK_TYPE_TIMESTAMP; config[1].config.timestamp.font_size = 10; config[1].config.timestamp.offset_x = 20; config[1].config.timestamp.offset_y = 400; config[1].config.timestamp.wm_width = 200; config[1].config.timestamp.wm_height = 20; config[2].type = agora::linuxsdk::WATERMARK_TYPE_LITERA; config[2].config.litera.font_size = 10; config[2].config.litera.wm_litera = "test watermark"; config[2].config.litera.font_file_path = "path-to-font-file.otf"; config[2].config.litera.offset_x = 20; config[2].config.litera.offset_y = 500; config[2].config.litera.wm_width = 200; config[2].config.litera.wm_height = 20; layout.wm_num = 3; layout.wm_configs = config; int res = m_enigne->setVideoMixingLayout(layout); ``` ```java tab="Java" tabGroup="zh-cn-realtime-media-recording-local-server-recording-build-recording-modes-legacy-watermark-1" /* * RecordingSDKInstance is the instance of the RecordingSDK class. */ Common ei = new Common(); Common.VideoMixingLayout layout = ei.new VideoMixingLayout(); layout.timestampWms = new TimestampWatermarkConfig[1]; layout.timestampWms[0] = ei.new TimestampWatermarkConfig(); layout.timestampWms[0].fontSize = 10; layout.timestampWms[0].offsetX = 10; layout.timestampWms[0].offsetY = 110; layout.timestampWms[0].wmWidth = 200; layout.timestampWms[0].wmHeight = 100; layout.literalWms = new LiteraWatermarkConfig[1]; layout.literalWms[0] = ei.new LiteraWatermarkConfig(); layout.literalWms[0].wmLitera = "test watermark"; layout.literalWms[0].fontSize = 10; layout.literalWms[0].fontFilePath = "path-to-font-file.otf"; layout.literalWms[0].offsetX = 10; layout.literalWms[0].offsetY = 10; layout.literalWms[0].wmWidth = 300; layout.literalWms[0].wmHeight = 100; layout.imageWms = new ImageWatermarkConfig[1]; layout.imageWms[0] = ei.new ImageWatermarkConfig(); layout.imageWms[0].imagePath = "path-to-image.png"; layout.imageWms[0].offsetX = 10; layout.imageWms[0].offsetY = 220; layout.imageWms[0].wmWidth = 400; layout.imageWms[0].wmHeight = 400; RecordingSDKInstance.setVideoMixingLayout(layout); ```