获取水印贴片模板--视频点播-火山引擎

文档中心

立即注册

导航

获取水印贴片模板

最近更新时间：2024.07.08 21:16:46首次发布时间：2023.07.04 21:04:36

此接口支持通过模板 ID 并设置排序维度和排序方式来获取水印贴片模板列表。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListWatermarkTemplate&Version=2023-07-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`ListWatermarkTemplate`	接口名称。当前 API 的名称为 `ListWatermarkTemplate`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceName	String	是	`YourSpaceName`	点播空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
TemplateId	String	否	`YourTemplateId`	模板 ID。你可在 CreateWatermarkTemplate 接口的返回参数中获取。
Name	String	否	`YourName`	模板名称。
Limit	Integer	否	`30`	每页包含的模板个数。取值范围为 (0,100]。默认为 30。
Offset	Integer	否	`10`	获取第几页的模板。需大于等于 0。
OrderByKey	String	否	`created_at`	排序维度。取值如下： `created_at`：创建时间 `updated_at`：更新时间
Order	String	否	`asc`	排序方式。取值如下： `asc`：升序 `desc`：降序

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Data	Array of LogoTemplate	`-`	水印模板信息。
Limit	Integer	`30`	具体返回个数。
Total	Long	`100`	水印模板列表总数。
Offset	Integer	`10`	偏移量。

LogoTemplate

参数	类型	示例值	描述
TemplateId	String	`0ed5b668e51***e45a6989d6f9`	模板 ID。
SpaceName	String	`test`	点播空间名称。
Name	String	`createTest`	模板名称。
Description	String	`a test`	模板描述。
CreatedAt	String	`2023-06-28T01:56:42Z`	创建时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
UpdatedAt	String	`2023-06-28T01:56:42Z`	更新时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
LogoType	String	`aa`	水印类型。
Logos	Array of AdaptLogo	`-`	明水印设置，最大数组长度 20。
Concats	Array of AdaptConcat	`-`	贴片设置，最大数组长度 20。
HiddenWatermark	Object of HiddenWatermarkAdd	`-`	暗水印设置。

AdaptLogo

参数	类型	示例值	描述
Logos	Array of LogoDefinition	`-`	水印设置，最大数组长度 20。
AnchorSize	Object of AnchorSize	`-`	水印的适配尺寸。如果待处理的视频尺寸与适配尺寸不匹配，系统会选择最接近的适配尺寸来应用水印。

LogoDefinition

参数	类型	示例值	描述
Type	String	`Image`	水印类型。取值如下： `Image`：图片。 `Video`：视频。 `Text`：文本。
TextLogoDefinition	Object of TextLogoDefinition	`-`	文本水印设置。注意当 `Type` 取值为 `Text` 时，该参数 `TextLogoDefinition` 必填。
ImageLogoDefinition	Object of ImageLogoDefinition	`-`	图片水印设置。注意当 `Type` 取值为 `Image` 时，该参数 `ImageLogoDefinition` 必填。
VideoLogoDefinition	Object of VideoLogoDefinition	`-`	视频水印设置。注意当 `Type` 取值为 `Video` 时，该参数 `VideoLogoDefinition` 必填。

TextLogoDefinition

参数	类型	示例值	描述
Content	String	`update logo api test`	文本水印内容。
FontType	String	`simkai`	水印字体，取值为 `simkai`。
FontSize	Integer	`13`	水印文字大小，正值。
FontColor	String	`#27ae60ff`	水印颜色，取值用 16 进制色彩表示。
StartTime	Integer	`0`	水印开始时间，非负值。单位为毫秒。
EndTime	Integer	`999`	水印结束时间，非负值。单位为毫秒。
Locate	String	`Center`	水印位置。取值如下： `TopLeft`：表示坐标原点位于视频图像左上角，水印原点为水印的左上角。 `TopRight`：表示坐标原点位于视频图像的右上角，水印原点为水印的右上角。 `Center`：表示坐标原点位于视频图像的中心，水印原点为水印的中心。 `BottomLeft`：表示坐标原点位于视频图像的左下角，水印原点为水印的左下角。 `BottomRight`：表示坐标原点位于视频图像的右下角，水印原点为水印的右下角。
PosX	Integer	`0`	水印原点距离视频图像坐标原点的水平偏移。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
PosY	Integer	`0`	水印原点距离视频图像坐标原点的垂直偏移。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
SizeX	Integer	`0`	水印宽度。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
SizeY	Integer	`0`	水印高度。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
PosRatioX	Double	`0.1`	水印原点距离视频图像坐标原点的水平偏移。取值为视频宽度的比例，例如 `0.1` 表示水平偏移量为视频宽度 * 0.1 再取整。默认值为 0，取值范围为 [0,1]。注意该参数与 `PosX`、`PosY` 参数互斥。
PosRatioY	Double	`0.1`	水印原点距离视频图像坐标原点的垂直偏移。取值为视频高度的比例，默认值为 0，取值范围为 [0,1]，例如，0.1 表示垂直偏移量为视频高度 * 0.1 再取整。注意该参数与 `PosX`、`PosY` 参数互斥。
SizeRatioX	Double	`0.1`	水印宽度。取值为视频宽度的比例，例如 0.1 表示水印宽度为视频宽度 * 0.1 再取整。默认为 0，取值范围为 [0,1]。注意该参数与 `SizeX`、`SizeY` 参数互斥。
SizeRatioY	Double	`0.1`	水印高度。取值为视频高度的比例，例如，0.1 表示水印高度为视频高度 * 0.1 再取整。默认为 0，取值范围为 [0,1]。注意该参数与 `SizeX`、`SizeY` 参数互斥。

ImageLogoDefinition

参数	类型	示例值	描述
Mid	String	`-`	素材 ID。您可通过素材上传完成事件获取到素材 ID。注意仅当素材格式（`Format` 参数）取值为 `jpg`、`jpeg`、`gif`、`png` 时，该参数有效。
PosX	Integer	`0`	水印原点距离视频图像坐标原点的水平偏移。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
PosY	Integer	`0`	水印原点距离视频图像坐标原点的垂直偏移。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
SizeX	Integer	`0`	水印宽度。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
SizeY	Integer	`0`	水印高度。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
Locate	String	`Center`	水印位置。取值如下： `TopLeft`：表示坐标原点位于视频图像左上角，水印原点为水印的左上角。 `TopRight`：表示坐标原点位于视频图像的右上角，水印原点为水印的右上角。 `Center`：表示坐标原点位于视频图像的中心，水印原点为水印的中心。 `BottomLeft`：表示坐标原点位于视频图像的左下角，水印原点为水印的左下角。 `BottomRight`：表示坐标原点位于视频图像的右下角，水印原点为水印的右下角。
StartTime	Integer	`0`	开始时间，非负值。单位为毫秒。
EndTime	Integer	`999`	结束时间，非负值。单位为毫秒。
LoopTimes	Integer	`0`	水印循环播放的次数。取值如下： `-1`：循环多次，直至视频结尾。 `0`：不加循环，即播放 1 次。 `N` (N>=1) ：加 N 次循环，播放 N+1 次。注意当图片格式为 `gif` 时，该参数才生效。
RepeatLast	Boolean	`false`	是否延续动图水印的最后一帧直至视频结束。取值如下： `false`：否 `true`：是注意当图片格式为 `gif` 时，该参数才生效。
PosRatioX	Double	`0.1`	水印原点距离视频图像坐标原点的水平偏移。取值为视频宽度的比例，例如 `0.1` 表示水平偏移量为视频宽度 * 0.1 再取整。默认值为 0，取值范围为 [0,1]。注意该参数与 `PosX`、`PosY` 参数互斥。
PosRatioY	Double	`0.1`	水印原点距离视频图像坐标原点的垂直偏移。取值为视频高度的比例，默认值为 0，取值范围为 [0,1]，例如，0.1 表示垂直偏移量为视频高度 * 0.1 再取整。注意该参数与 `PosX`、`PosY` 参数互斥。
SizeRatioX	Double	`0.1`	水印宽度。取值为视频宽度的比例，例如 0.1 表示水印宽度为视频宽度 * 0.1 再取整。默认为 0，取值范围为 [0,1]。注意该参数与 `SizeX`、`SizeY` 参数互斥。
SizeRatioY	Double	`0.1`	水印高度。取值为视频高度的比例，例如，0.1 表示水印高度为视频高度 * 0.1 再取整。默认为 0，取值范围为 [0,1]。注意该参数与 `SizeX`、`SizeY` 参数互斥。
Transparency	Integer	`0`	水印透明度，取值范围为 [0,100]。默认为 0，表示完全不透明；100 表示完全透明。

VideoLogoDefinition

参数	类型	示例值	描述
Mid	String	`-`	素材 ID。您可通过素材上传完成事件获取到素材 ID。注意仅当素材格式（`Format` 参数）取值为 `mov` 时，该参数有效。
StartTime	Integer	`0`	开始时间，非负值。单位为毫秒。
EndTime	Integer	`000`	结束时间，非负值。单位为毫秒。
LoopTimes	Integer	`10`	水印循环播放的次数。取值如下： `-1`：循环多次，直至视频结尾。 `0`：不加循环，即播放 1 次。 `N` (N>=1) ：加 N 次循环，播放 N+1 次。
RepeatLast	Boolean	`true`	是否延续水印的最后一帧直至视频结束。取值如下： `false`：否 `true`：是
Locate	String	`Center`	水印位置。取值如下： `TopLeft`：表示坐标原点位于视频图像左上角，水印原点为水印的左上角。 `TopRight`：表示坐标原点位于视频图像的右上角，水印原点为水印的右上角。 `Center`：表示坐标原点位于视频图像的中心，水印原点为水印的中心。 `BottomLeft`：表示坐标原点位于视频图像的左下角，水印原点为水印的左下角。 `BottomRight`：表示坐标原点位于视频图像的右下角，水印原点为水印的右下角。
PosX	Integer	`0`	水印原点距离视频图像坐标原点的水平偏移。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
PosY	Integer	`0`	水印原点距离视频图像坐标原点的垂直偏移。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
SizeX	Integer	`0`	水印宽度。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
SizeY	Integer	`0`	水印高度。取值为像素值，单位为 px。默认值为 0，取值范围为大于等于 0。
PosRatioX	Double	`0.1`	水印原点距离视频图像坐标原点的水平偏移。取值为视频宽度的比例，例如 `0.1` 表示水平偏移量为视频宽度 * 0.1 再取整。默认值为 0，取值范围为 [0,1]。注意该参数与 `PosX`、`PosY` 参数互斥。
PosRatioY	Double	`0.1`	水印原点距离视频图像坐标原点的垂直偏移。取值为视频高度的比例，默认值为 0，取值范围为 [0,1]，例如，0.1 表示垂直偏移量为视频高度 * 0.1 再取整。注意该参数与 `PosX`、`PosY` 参数互斥。
SizeRatioX	Double	`0.1`	水印宽度。取值为视频宽度的比例，例如 0.1 表示水印宽度为视频宽度 * 0.1 再取整。默认为 0，取值范围为 [0,1]。注意该参数与 `SizeX`、`SizeY` 参数互斥。
SizeRatioY	Double	`0.1`	水印高度。取值为视频高度的比例，例如，0.1 表示水印高度为视频高度 * 0.1 再取整。默认为 0，取值范围为 [0,1]。注意该参数与 `SizeX`、`SizeY` 参数互斥。
Transparency	Integer	`0`	水印透明度，取值范围为 [0,100]。默认为 0，表示完全不透明；100 表示完全透明。

AnchorSize

参数	类型	示例值	描述
Width	Integer	`1280`	水印适配宽度，单位为 px。
Height	Integer	`720`	水印适配高度，单位为 px。

AdaptConcat

参数	类型	示例值	描述
Concats	Array of ConcatDefinition	`-`	贴片设置，最大数组长度 2。
AnchorSize	Object of AnchorSize	`-`	贴片的适配尺寸。如果待处理的视频尺寸与适配尺寸不匹配，系统会选择最接近的适配尺寸来应用贴片。

ConcatDefinition

参数类型示例值描述

参数	类型	示例值	描述
Mid	String	`i0022jqp2***bn2m41tg0`	素材 ID。您可通过素材上传完成事件获取到素材 ID。注意仅当素材格式（`Format` 参数）取值为 `mp4` 时，该参数有效。
Type	String	`Video`	贴片类型。当前仅支持取值为 `Video`，表示视频类型。
Position	String	`Head`	贴片位置。取值如下： `Head`：视频头部 `Tail`：视频尾部

Mid

String

i0022jqp2***bn2m41tg0

素材 ID。您可通过素材上传完成事件获取到素材 ID。

注意

仅当素材格式（Format 参数）取值为 mp4 时，该参数有效。

Type String Video 贴片类型。当前仅支持取值为 Video，表示视频类型。

Position

String

Head

贴片位置。取值如下：

Head：视频头部
Tail：视频尾部

HiddenWatermarkAdd

参数	类型	示例值	描述
Type	String	`text`	暗水印类型。目前仅支持 `text` 文字水印。
Content	String	`custom content`	暗水印内容。

请求示例

https://vod.volcengineapi.com?Action=ListWatermarkTemplate&Version=2023-07-01&SpaceName=YourSpaceName&TemplateId=YourTemplateId&Name=YourName&Limit=YourLimit&Offset=YourOffset&OrderByKey=YourOrderByKey&Order=YourOrder

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220726*******************051B513A",
        "Action": "ListWatermarkTemplate",
        "Version": "2023-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Limit": 1,
        "Total": 100,
        "Data": [
            {
                "TemplateId": "0ed5b668e51***e45a6989d6f9",
                "SpaceName": "test",
                "Name": "createTest",
                "Description": "a test",
                "Type": "Normal",
                "CreatedAt": "2023-06-28T01:56:42Z",
                "UpdatedAt": "2023-06-28T01:56:42Z",
                "LogoType": "aa",
                "Logos": [
                    {
                        "AnchorSize": {
                            "Width": 1280,
                            "Height": 720
                        },
                        "Logos": [
                            {
                                "Type": "Text",
                                "TextLogoDefinition": {
                                    "Content": "update logo api test",
                                    "FontType": "simkai",
                                    "FontSize": 13,
                                    "FontColor": "#27ae60ff",
                                    "StartTime": 0,
                                    "EndTime": 999,
                                    "Locate": "Center",
                                    "PosX": 0,
                                    "PosY": 0,
                                    "SizeX": 0,
                                    "SizeY": 0
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。