最近更新时间：2024.04.15 11:37:03
首次发布时间：2023.12.28 21:21:53
阅读本文，您可以获取 Python SDK 直播水印的接口调用示例，实现快速开发。
说明
本文的调用示例包含接口的全部参数。由于参数间可能存在互斥关系，在调用时，请您参考注释，进行调整。
调用接口前，请先完成 Python SDK 的安装及初始化操作
本节为您介绍直播水印相关接口的功能和调用示例。
您可以调用 CreateWatermarkPreset 接口添加水印。详细的参数说明可参见 CreateWatermarkPreset 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == '__main__': # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET']) body = {} # 应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。 body["App"] = "live" # 需要添加水印的直播画面方向，支持 2 种取值。 # <li> vertical：竖屏； </li> # <li> horizontal：横屏。 </li> # note： # 该参数属于历史版本参数，预计将于未来移除。建议使用预览背景高度（PreviewHeight）、预览背景宽度（PreviewWidth）参数代替。 body["Orientation"] = "vertical" # 水印图片字符串，图片最大 2MB，最小 100Bytes，最大分辨率为 1080×1080。图片 Data URL 格式为：`data:[<mediatype>];[base64],<data>`。 # <li> `mediatype`：图片类型，支持 png、jpg、jpeg 格式； </li> # <li> `data`：base64 编码的图片字符串。 </li> body["Picture"] = "data:image/png;base64,iVBORw0KGg****mCC" # 水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1]。 body["PosX"] = 0 # 垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1]。 body["PosY"] = 0 # 水印相对宽度，水印宽度占直播转码流画面宽度的比例，取值范围为 [0,1]，水印高度会随宽度等比缩放。与水印相对高度字段冲突，请选择其中一个传参。 body["RelativeWidth"] = 0.1 # 域名空间名称，由 1 到 60 位数字、字母、下划线及"-"和"."组成。 body["Vhost"] = "push.example.com" # 水印图片对应的 HTTP 地址。与水印图片字符串字段二选一传入，同时传入时，以水印图片字符串参数为准。 body["PictureUrl"] = "https://test-image.jpg" # 水印图片预览背景高度，单位为 px。 body["PreviewHeight"] = 1080 # 水印图片预览背景宽度，单位为 px。 body["PreviewWidth"] = 1920 # 水印相对高度，水印高度占直播转码流画面高度的比例，取值范围为 [0,1]，水印宽度会随高度等比缩放。与水印相对宽度字段冲突，请选择其中一个传参。 body["RelativeHeight"] = 0.1 resp = service.create_watermark_preset(body) print(resp)
您可以调用 DeleteWatermarkPreset 接口删除水印。详细的参数说明可参见 DeleteWatermarkPreset 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == '__main__': # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET']) body = {} # 应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。 body["App"] = "live" # 域名空间名称，由 1 到 60 位数字、字母、下划线及"-"和"."组成。 body["Vhost"] = "push.example.com" resp = service.delete_watermark_preset(body) print(resp)
您可以调用 UpdateWatermarkPreset 接口更新水印。详细的参数说明可参见 UpdateWatermarkPreset 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == '__main__': # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET']) body = {} # 应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。 body["App"] = "live" # 直播画面方向，支持 2 种取值。 # <li> vertical：竖屏； </li> # <li> horizontal：横屏。 </li> # note： # 该参数属于历史版本参数，预计将于未来移除。建议使用预览背景高度（PreviewHeight）、预览背景宽度（PreviewWidth）参数代替。 body["Orientation"] = "vertical" # 水印图片链接，图片最大 2MB，最小 100Bytes，最大分辨率为 1080×1080。图片使用 data URI 协议，格式为：`data:[<mediatype>];[base64],<data>`。 # <li> `mediatype`：图片类型，支持 png、jpg、jpeg 格式； </li> # <li> `data`：base64 编码的图片字符串。 </li> # warning # 如果水印图片不更新，请勿在更新配置时传入该参数，否则会造成水印无法显示。 # ::: body["Picture"] = "data:image/png;base64,iVBORw0KGg****mCC" # 水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1]。 body["PosX"] = 0 # 垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1]。 body["PosY"] = 0 # 水印相对宽度，水印宽度占直播转码流画面宽度的比例，取值范围为 [0,1]，水印高度会随宽度等比缩放。与水印相对高度字段冲突，请选择其中一个传参。 body["RelativeWidth"] = 0.1 # 域名空间名称，由 1 到 60 位数字、字母、下划线及"-"和"."组成。 body["Vhost"] = "live.example.com" # 水印图片对应的 HTTP 地址。与水印图片字符串字段二选一传入。同时传入时，以水印图片字符串参数为准。 # warning # 如果水印图片不更新，请勿在更新配置时传入该参数，否则会造成水印无法显示。 # ::: body["PictureUrl"] = "https://test-image.jpg" # 水印图片预览背景高度，单位为 px。 body["PreviewHeight"] = 1080 # 水印图片预览背景宽度，单位为 px。 body["PreviewWidth"] = 1080 # 水印相对高度，水印高度占直播转码流画面高度的比例，取值范围为 [0,1]，水印宽度会随高度等比缩放。与水印相对宽度字段冲突，请选择其中一个传参。 body["RelativeHeight"] = 0.1 resp = service.update_watermark_preset(body) print(resp)
您可以调用 ListWatermarkPreset 接口查询水印。详细的参数说明可参见 ListWatermarkPreset 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == '__main__': # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET']) body = {} # 应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。 body["App"] = "live" # 域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成。 body["Vhost"] = "testVhost" resp = service.list_watermark_preset(body) print(resp)
您可以调用 ListVhostWatermarkPreset 接口查询水印列表。详细的参数说明可参见 ListVhostWatermarkPreset 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == '__main__': # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET']) body = {} # 域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成。 body["Vhost"] = "push.example.com" resp = service.list_vhost_watermark_preset(body) print(resp)