修改水印模板 - UpdateWatermarkTemplate
功能介绍
修改水印模板接口,修改后实时生效
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/watermark/templates/{id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
|
id |
是 |
String |
模板ID,在创建成功后返回 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必填,携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必填,请求的发生时间。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必填,携带项目ID信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
水印模板名称 |
|
type |
否 |
Integer |
水印类型,0图片,1文字,2图文共存 |
|
description |
否 |
String |
模板注释 |
|
picture_url |
否 |
String |
图片下载路径 校验规则:图片URL长度大于0,最大长度2048,能够正常按URL格式解析,必须是 http 或 https 协议。(OTT 场景限制只支持https) 图片格式: .png/.jpg/.PNG/.JPG结尾 |
|
width |
否 |
Number |
1)整数型代表水印图片宽的像素值,范围0或[8,4096],单位px。 2)小数型代表相对输出视频分辨率宽的比率,范围[0,1) 建议宽高只设置一项,另外一项会自适应缩放,避免变形。宽高全部设置为0表示水印图片原始宽高 百分比限制最多保留小数点后4位,width和height 只支持同时为像素或是百分比,不支持一个像素,一个百分比 |
|
height |
否 |
Number |
水印图片高,值有两种形式: 1)整数型代表水印图片高的像素值,范围0或[8,4096],单位px。 2)小数型代表相对输出视频分辨率高的比率,范围[0,1) 建议宽高只设置一项,另外一项会自适应缩放,避免变形。宽高全部设置为0表示水印图片原始宽高 百分比限制最多保留小数点后4位,width和height 只支持同时为像素或是百分比,不支持一个像素,一个百分比 |
|
location |
否 |
WatermarkLocation object |
水印位置 |
|
text |
否 |
WordWaterMarkInfo object |
文字水印信息 |
|
scene |
否 |
String |
业务属性,cloud_live:云直播,默认值;media_live:媒体直播,不支持修改 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
format |
是 |
String |
水印文字内容,必填 字幕内容1-64 type为1或2时必填,type为0时非必填 |
|
font_color |
否 |
String |
参数校验:首位为#、除#外为6位或8位,每位字符由 0-9、a~f、A~F 组成【务必校验,错误时转码默认白色】 |
|
font_size |
否 |
Integer |
字体大小 |
|
font |
否 |
String |
字体,缺省值 空,可选值:harmonyRegular(鸿蒙)、douyu2.0(斗鱼追光体) |
|
time_zone |
否 |
String |
时区,【取值参考 UTC-1200 至 UTC+1200,前三位UTC,第四位+或-,五六位表示小时,七八位固定00】 |
|
shadow_color |
否 |
String |
缺省值 none,参数校验:首位为#、除#外为6位或8位,每位字符由 0-9、a~f、A~F 组成【务必校验,错误时转码默认黑色】 |
|
location |
是 |
WatermarkLocation object |
location位置必填 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
location |
否 |
String |
水印位置。 包含如下选项:
|
|
x_offset |
否 |
Number |
水印相对输出视频的水平偏移量。 说明:值有两种形式: 1)整数型代表偏移像素,范围[1,4096],单位px。 2)小数型代表水平偏移量与输出分辨率宽的比率,范围[0,1) 百分比限制最多保留小数点后4位 |
|
y_offset |
否 |
Number |
水印相对输出视频的垂直偏移量 说明: 值有两种形式: 1)整数型代表偏移像素,范围[1,4096],单位px。 2)小数型代表垂直偏移量与输出分辨率高的比率,范围[0,1) 百分比限制最多保留小数点后4位 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
水印模板名称 |
|
type |
Integer |
水印类型,0图片,1文字,2图文共存 |
|
description |
String |
模板注释 |
|
picture_url |
String |
图片下载路径 校验规则:图片URL长度大于0,最大长度2048,能够正常按URL格式解析,必须是 http 或 https 协议。(OTT 场景限制只支持https) 图片格式: .png/.jpg/.PNG/.JPG结尾 |
|
width |
Number |
1)整数型代表水印图片宽的像素值,范围0或[8,4096],单位px。 2)小数型代表相对输出视频分辨率宽的比率,范围[0,1) 建议宽高只设置一项,另外一项会自适应缩放,避免变形。宽高全部设置为0表示水印图片原始宽高 百分比限制最多保留小数点后4位,width和height 只支持同时为像素或是百分比,不支持一个像素,一个百分比 |
|
height |
Number |
水印图片高,值有两种形式: 1)整数型代表水印图片高的像素值,范围0或[8,4096],单位px。 2)小数型代表相对输出视频分辨率高的比率,范围[0,1) 建议宽高只设置一项,另外一项会自适应缩放,避免变形。宽高全部设置为0表示水印图片原始宽高 百分比限制最多保留小数点后4位,width和height 只支持同时为像素或是百分比,不支持一个像素,一个百分比 |
|
location |
WatermarkLocation object |
水印位置 |
|
text |
WordWaterMarkInfo object |
文字水印信息 |
|
scene |
String |
业务属性,cloud_live:云直播,默认值;media_live:媒体直播,不支持修改 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
format |
String |
水印文字内容,必填 字幕内容1-64 type为1或2时必填,type为0时非必填 |
|
font_color |
String |
参数校验:首位为#、除#外为6位或8位,每位字符由 0-9、a~f、A~F 组成【务必校验,错误时转码默认白色】 |
|
font_size |
Integer |
字体大小 |
|
font |
String |
字体,缺省值 空,可选值:harmonyRegular(鸿蒙)、douyu2.0(斗鱼追光体) |
|
time_zone |
String |
时区,【取值参考 UTC-1200 至 UTC+1200,前三位UTC,第四位+或-,五六位表示小时,七八位固定00】 |
|
shadow_color |
String |
缺省值 none,参数校验:首位为#、除#外为6位或8位,每位字符由 0-9、a~f、A~F 组成【务必校验,错误时转码默认黑色】 |
|
location |
WatermarkLocation object |
location位置必填 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
location |
String |
水印位置。 包含如下选项:
|
|
x_offset |
Number |
水印相对输出视频的水平偏移量。 说明:值有两种形式: 1)整数型代表偏移像素,范围[1,4096],单位px。 2)小数型代表水平偏移量与输出分辨率宽的比率,范围[0,1) 百分比限制最多保留小数点后4位 |
|
y_offset |
Number |
水印相对输出视频的垂直偏移量 说明: 值有两种形式: 1)整数型代表偏移像素,范围[1,4096],单位px。 2)小数型代表垂直偏移量与输出分辨率高的比率,范围[0,1) 百分比限制最多保留小数点后4位 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
PUT https://{endpoint}/v1/{project_id}/watermark/templates/e89b76xxxxxx3425ui80af501cdxxxxxx
{
"name" : "MyWatermarkTemplate",
"type" : 0,
"description" : "my demo template",
"picture_url" : "http://example.com/picture",
"width" : 0.1,
"height" : 0.1,
"location" : {
"location" : "TOPLEFT",
"x_offset" : 20,
"y_offset" : 10
}
}
响应示例
状态码:200
修改水印模板操作成功
{
"name" : "string",
"type" : 1,
"description" : "string",
"picture_url" : "string",
"width" : 4096,
"height" : 4096,
"location" : {
"location" : "string",
"x_offset" : 4096,
"y_offset" : 4096
}
}
状态码:400
修改水印模板操作失败
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
}
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; public class UpdateWatermarkTemplateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); UpdateWatermarkTemplateRequest request = new UpdateWatermarkTemplateRequest(); request.withId("{id}"); WatermarkTemplate body = new WatermarkTemplate(); WatermarkLocation locationbody = new WatermarkLocation(); locationbody.withLocation(WatermarkLocation.LocationEnum.fromValue("TOPLEFT")) .withXOffset(java.math.BigDecimal.valueOf(20)) .withYOffset(java.math.BigDecimal.valueOf(10)); body.withLocation(locationbody); body.withHeight(java.math.BigDecimal.valueOf(0.1)); body.withWidth(java.math.BigDecimal.valueOf(0.1)); body.withPictureUrl("http://example.com/picture"); body.withDescription("my demo template"); body.withType(0); body.withName("MyWatermarkTemplate"); request.withBody(body); try { UpdateWatermarkTemplateResponse response = client.updateWatermarkTemplate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateWatermarkTemplateRequest() request.id = "{id}" locationbody = WatermarkLocation( location="TOPLEFT", x_offset=20, y_offset=10 ) request.body = WatermarkTemplate( location=locationbody, height=0.1, width=0.1, picture_url="http://example.com/picture", description="my demo template", type=0, name="MyWatermarkTemplate" ) response = client.update_watermark_template(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateWatermarkTemplateRequest{} request.Id = "{id}" locationLocation:= model.GetWatermarkLocationLocationEnum().TOPLEFT xOffsetLocation:= float32(20) yOffsetLocation:= float32(10) locationbody := &model.WatermarkLocation{ Location: &locationLocation, XOffset: &xOffsetLocation, YOffset: &yOffsetLocation, } heightWatermarkTemplate:= float32(0.1) widthWatermarkTemplate:= float32(0.1) pictureUrlWatermarkTemplate:= "http://example.com/picture" descriptionWatermarkTemplate:= "my demo template" typeWatermarkTemplate:= int32(0) request.Body = &model.WatermarkTemplate{ Location: locationbody, Height: &heightWatermarkTemplate, Width: &widthWatermarkTemplate, PictureUrl: &pictureUrlWatermarkTemplate, Description: &descriptionWatermarkTemplate, Type: &typeWatermarkTemplate, Name: "MyWatermarkTemplate", } response, err := client.UpdateWatermarkTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
修改水印模板操作成功 |
|
400 |
修改水印模板操作失败 |
错误码
请参见错误码。