All Products
Search
Document Center

ApsaraVideo Media Processing:QueryWaterMarkTemplateList

Last Updated:Mar 03, 2024

Queries watermark templates.

Operation description

The details of the watermark templates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
WaterMarkTemplateIdsstringYes

The type of the watermark. Valid values:

  • Image, and
  • Text.
Note Only watermarks of the Image type are supported.
3780bd69b2b74540bc7b1096f564****

Response parameters

ParameterTypeDescriptionExample
object

The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:

  • Width: the width edge.
  • Height: the height edge.
  • Long: the long edge.
  • Short: the short edge.
RequestIdstring

The horizontal offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal.

  • Integer: the vertical offset. This indicates the absolute position. Unit: pixel.
  • Decimal: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.
17079AF5-6276-51A9-B755-D26594C93F3C
NonExistWidsarray

The width of the watermark image in the output video. The value can be an integer or a decimal.

  • Integer: the width of the watermark image. This indicates the absolute position. Unit: pixel.
  • Decimal: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.
string

The height of the watermark image in the output video. The value can be an integer or a decimal.

  • Integer: the height of the watermark image. This indicates the absolute position. Unit: pixel.
  • Decimal: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.
72dfa5e679ab4be9a3ed9974c736****
WaterMarkTemplateListobject []

The vertical offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal.

  • Integer: the vertical offset. This indicates the absolute position. Unit: pixel.
  • Decimal: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.
Typestring

The status of the watermark template. Valid values: Valid values:

  • Normal: The watermark template is normal.
  • Deleted: The watermark template is deleted.
Image
RatioReferobject

The horizontal offset. Unit: pixel.

Dxstring

The width of the watermark image. Unit: pixel.

0.51
Widthstring

The height of the watermark image. Unit: pixel.

0.36
Heightstring

The timeline of the watermark.

0.33
Dystring

The beginning of the time range during which the watermark is displayed.

  • Unit: seconds.
  • Default value: 0.
0.4
ReferPosstring

The display duration of the watermark. Default value: ToEND. The default value indicates that the watermark is displayed until the video ends.

TopRight
Statestring

The name of the watermark template.

Normal
Dxstring

The vertical offset. Unit: pixel.

100
Widthstring

The ID of the watermark template.

8
Heightstring

You can call this operation to query up to 10 watermark templates at a time.

QPS limit

You can call this API operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit.

8
Timelineobject

The status of the watermark template. Valid values: Valid values:

  • Normal: The watermark template is normal.
  • Deleted: The watermark template is deleted.
Startstring

The height of the watermark image. Unit: pixel.

0
Durationstring

The horizontal offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal.

  • Integer: the vertical offset. This indicates the absolute position. Unit: pixel.
  • Decimal: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.
10
Namestring

The width of the watermark image in the output video. The value can be an integer or a decimal.

  • Integer: the width of the watermark image. This indicates the absolute position. Unit: pixel.
  • Decimal: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.
example-watermark
Dystring

The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence:

  • Width: the width edge.
  • Height: the height edge.
  • Long: the long edge.
  • Short: the short edge.
100
Idstring

The vertical offset. Unit: pixel.

3780bd69b2b74540bc7b1096f564****

Examples

Sample success responses

JSONformat

{
  "RequestId": "17079AF5-6276-51A9-B755-D26594C93F3C",
  "NonExistWids": {
    "String": [
      "72dfa5e679ab4be9a3ed9974c736****"
    ]
  },
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.4"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "10"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "3780bd69b2b74540bc7b1096f564****"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history