阅读本文,您可以获取 Java SDK 直播水印的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 Java SDK 的安装及初始化操作。
本节为您介绍直播水印相关接口的功能和调用示例。
您可以调用 CreateWatermarkPreset 接口添加水印配置。详细的参数说明可参见 CreateWatermarkPreset 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; public class CreateWatermarkPresetDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); CreateWatermarkPresetBody body = new CreateWatermarkPresetBody(); // 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 body.setApp("live"); // 需要添加水印的直播画面方向,支持 2 种取值。 // <li> vertical:竖屏; </li> // <li> horizontal:横屏。 </li> // note: // 该参数属于历史版本参数,预计将于未来移除。建议使用预览背景高度(PreviewHeight)、预览背景宽度(PreviewWidth)参数代替。 body.setOrientation("vertical"); // 水印图片编码字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:[<mediatype>];[base64],<data>。 // <li> mediatype:图片类型,支持 png、jpg、jpeg 格式; </li> // <li> data:base64 编码的图片字符串。 </li> body.setPicture("data:image/png;base64,iVBORw0KGg****mCC"); // 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]。 body.setPosX(0); // 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]。 body.setPosY(0); // 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。与水印相对高度字段冲突,请选择其中一个传参。 body.setRelativeWidth(0.1); // 域名空间,即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,查看直播流使用的域名所属的域名空间。 body.setVhost("push.example.com"); // 水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入,同时传入时,以水印图片编码字符串参数为准。 body.setPictureUrl("https://test-image.jpg"); // 水印图片预览背景高度,单位为 px。 body.setPreviewHeight(1080); // 水印图片预览背景宽度,单位为 px。 body.setPreviewWidth(1920); // 水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。与水印相对宽度字段冲突,请选择其中一个传参。 body.setRelativeHeight(0.1); // 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。 // note: // <li> 默认为空,表示对指定的 AppName 下所有转码流均使用当前水印配置。 </li> // <li> 指定流名称时,表示仅对 AppName 下指定流名称的转码流使用当前水印配置。 </li> body.setStream("example_stream"); try { CreateWatermarkPresetRes resp = service.createWatermarkPreset(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 DeleteWatermarkPreset 接口删除水印配置。详细的参数说明可参见 DeleteWatermarkPreset 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; public class DeleteWatermarkPresetDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); DeleteWatermarkPresetBody body = new DeleteWatermarkPresetBody(); // 应用名称,您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口,查看待删除水印配置的 App 取值。 body.setApp("live"); // 域名空间,您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口,查看待删除水印配置的 Vhost 取值。 body.setVhost("push.example.com"); // 流名称,您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口,查看待删除水印配置的 Stream 取值。 body.setStream("example_stream"); try { DeleteWatermarkPresetRes resp = service.deleteWatermarkPreset(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 UpdateWatermarkPreset 接口更新水印配置。详细的参数说明可参见 UpdateWatermarkPreset 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; public class UpdateWatermarkPresetDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); UpdateWatermarkPresetBody body = new UpdateWatermarkPresetBody(); // 应用名称,您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口,查看待更新水印配置的 App 取值。 body.setApp("live"); // 直播画面方向,支持 2 种取值。 // <li> vertical:竖屏; </li> // <li> horizontal:横屏。 </li> // note: // 该参数属于历史版本参数,预计将于未来移除。建议使用预览背景高度(PreviewHeight)、预览背景宽度(PreviewWidth)参数代替。 body.setOrientation("vertical"); // 水印图片编码字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片使用 data URI 协议,格式为:data:[<mediatype>];[base64],<data>。 // <li> mediatype:图片类型,支持 png、jpg、jpeg 格式; </li> // <li> data:base64 编码的图片字符串。 </li> // warning // 如果水印图片不更新,请勿在更新配置时传入该参数,否则会造成水印无法显示。 body.setPicture("data:image/png;base64,iVBORw0KGg****mCC"); // 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]。 body.setPosX(0); // 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]。 body.setPosY(0); // 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。与水印相对高度字段冲突,请选择其中一个传参。 body.setRelativeWidth(0.1); // 域名空间,您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口,查看待更新水印配置的 Vhost 取值。 body.setVhost("push.example.com"); // 水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入。同时传入时,以水印图片编码字符串参数为准。 // warning // 如果水印图片不更新,请勿在更新配置时传入该参数,否则会造成水印无法显示。 body.setPictureUrl("https://test-image.jpg"); // 水印图片预览背景高度,单位为 px。 body.setPreviewHeight(1080); // 水印图片预览背景宽度,单位为 px。 body.setPreviewWidth(1080); // 水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。与水印相对宽度字段冲突,请选择其中一个传参。 body.setRelativeHeight(0.1); // 流名称,您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口,查看待更新水印配置的 Stream 取值。 body.setStream("example_stream"); try { UpdateWatermarkPresetRes resp = service.updateWatermarkPreset(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 ListWatermarkPreset 接口查询水印配置。详细的参数说明可参见 ListWatermarkPreset 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; public class ListWatermarkPresetDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); ListWatermarkPresetBody body = new ListWatermarkPresetBody(); // 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 body.setApp("live"); // 域名空间,即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,查看直播流使用的域名所属的域名空间。 body.setVhost("testVhost"); // 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。 // note: // <li> 默认为空,表示查询的 AppName 级别对所有转码流生效的配置。 </li> // <li> 指定流名称时,表示查询仅对 AppName 下指定流名称的转码流生效的配置。 </li> body.setStream("testStream"); try { ListWatermarkPresetRes resp = service.listWatermarkPreset(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 ListVhostWatermarkPreset 接口查询水印配置列表。详细的参数说明可参见 ListVhostWatermarkPreset 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; public class ListVhostWatermarkPresetDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); ListVhostWatermarkPresetBody body = new ListVhostWatermarkPresetBody(); // 域名空间,即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,查看直播流使用的域名所属的域名空间。 body.setVhost("push.example.com"); try { ListVhostWatermarkPresetRes resp = service.listVhostWatermarkPreset(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 CreateWatermarkPresetV2 接口添加水印模板。详细的参数说明可参见 CreateWatermarkPresetV2 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; public class CreateWatermarkPresetV2Demo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); CreateWatermarkPresetV2Body body = new CreateWatermarkPresetV2Body(); // 水印图片对应的 HTTP 地址。 // note: // Picture 与 PictureUrl 字段二选一必传,同时传入时,以 Picture 参数为准。 body.setPictureUrl("https://example.com/watermark-image.jpg"); // 水印图片预览背景宽度,单位为 px。 body.setPreviewWidth(1920); // 水印图片预览背景高度,单位为 px。 body.setPreviewHeight(1080); // 水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。 // note: // RelativeWidth 与 RelativeHeight 二选一必传。 body.setRelativeHeight(0.1); // 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:image/[<mediatype>];[base64],<data>。 // <li> mediatype:图片类型,支持 png、jpg、jpeg 格式; </li> // <li> data:base64 编码的图片字符串。 </li> // note: // Picture 与 PictureUrl 字段二选一必传,同时传入时,以 Picture 参数为准。 body.setPicture("data:image/png;base64,iVBORw0KGg****mCC"); // 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1],默认为 0。 body.setPosX(0); // 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1],默认为 0。 body.setPosY(0); // 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。 // note: // RelativeWidth 与 RelativeHeight 二选一必传。 body.setRelativeWidth(0.1); // 水印模板的名称标识,不可重复,默认传空将由系统为您自动生成。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_) 和短横线(-)组成,长度为 1 到 20 个字符。 body.setPresetName("watermark001"); try { CreateWatermarkPresetV2Res resp = service.createWatermarkPresetV2(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 UpdateWatermarkPresetV2 接口更新水印模板。详细的参数说明可参见 UpdateWatermarkPresetV2 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; public class UpdateWatermarkPresetV2Demo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); UpdateWatermarkPresetV2Body body = new UpdateWatermarkPresetV2Body(); // 水印图片对应的 HTTP 地址。 // note: // Picture 与 PictureUrl 字段二选一必传,同时传入时,以 Picture 参数为准。 body.setPictureUrl("https://example.com/watermark-image.jpg"); // 水印图片预览背景宽度,单位为 px。 body.setPreviewWidth(1920); // 水印图片预览背景高度,单位为 px。 body.setPreviewHeight(1080); // 水印相对高度,水印高度占直播转码流画面宽度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。 // note: // RelativeWidth 与 RelativeHeight 二选一必传。 body.setRelativeHeight(0.1); // 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:image/[<mediatype>];[base64],<data>。 // <li> mediatype:图片类型,支持 png、jpg、jpeg 格式; </li> // <li> data:base64 编码的图片字符串。 </li> // note: // Picture 与 PictureUrl 字段二选一必传,同时传入时,以 Picture 参数为准。 body.setPicture("data:image/png;base64,iVBORw0KGg****mCC"); // 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]。 body.setPosX(0); // 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]。 body.setPosY(0); // 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。 // note: // RelativeWidth 与 RelativeHeight 二选一必传。 body.setRelativeWidth(0.1); // 水印模板的名称,您可以调用 [ListWatermarkPresetDetail](https://www.volcengine.com/docs/6469/1323353) 接口获取。 // note: // PresetName 和 ID 二选一必填。 body.setPresetName("watermark001"); // 水印模板的 ID,您可以调用 [ListWatermarkPresetDetail](https://www.volcengine.com/docs/6469/1323353) 接口获取。 // note: // PresetName 和 ID 二选一必填。 body.setID(12344567); try { UpdateWatermarkPresetV2Res resp = service.updateWatermarkPresetV2(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 DeleteWatermarkPresetV2 接口删除水印模板。详细的参数说明可参见 DeleteWatermarkPresetV2 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; public class DeleteWatermarkPresetV2Demo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); DeleteWatermarkPresetV2Body body = new DeleteWatermarkPresetV2Body(); // 水印模板的名称,您可以调用 [ListWatermarkPresetDetail](https://www.volcengine.com/docs/6469/1323353) 接口获取。 // note: // PresetName 和 ID 二选一必填。 body.setPresetName("watermark001"); // 水印模板的 ID,您可以调用 [ListWatermarkPresetDetail](https://www.volcengine.com/docs/6469/1323353) 接口获取。 // note: // PresetName 和 ID 二选一必填。 body.setID(12344567); try { DeleteWatermarkPresetV2Res resp = service.deleteWatermarkPresetV2(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 ListWatermarkPresetDetail 接口查询水印模版列表。详细的参数说明可参见 ListWatermarkPresetDetail 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.*; import com.volcengine.service.live.v20230101.LiveService; import java.util.ArrayList; import java.util.List; public class ListWatermarkPresetDetailDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); ListWatermarkPresetDetailBody body = new ListWatermarkPresetDetailBody(); // 水印模板 ID 列表,默认为空,表示查询结果不对模板 ID 进行筛选。 List<Long> PresetIDList = new ArrayList<>(); PresetIDList.add((long) 12344567); body.setPresetIDList(PresetIDList); // 水印模板名称列表,默认为空,表示查询结果不对模板名称进行筛选。 List<String> PresetNameList = new ArrayList<>(); PresetNameList.add("watermark001"); body.setPresetNameList(PresetNameList); try { ListWatermarkPresetDetailRes resp = service.listWatermarkPresetDetail( body ); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }