All Products
Search
Document Center

ApsaraVideo Media Processing:SearchWaterMarkTemplate

Last Updated:Mar 03, 2024

Searches for watermark templates.

Operation description

The total number of returned entries.

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
PageSizelongNo

The number of entries returned on each page.

10
PageNumberlongNo

The ID of the request.

1
StatestringNo

The number of the returned page.

Normal

Response parameters

ParameterTypeDescriptionExample
object

The details of the watermark templates.

TotalCountlong

The type of the watermark. Valid values:

  • Image: an image watermark.
  • Text: a text watermark.
Note Only watermarks of the Image types are supported.
1
PageSizelong

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.
10
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.
FC029D04-8F47-57FF-A759-23383C15617D
PageNumberlong

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.
1
WaterMarkTemplateListobject []

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.
Typestring

The position of the watermark. Valid values:

  • TopRight: the upper-right corner.
  • TopLeft: the upper-left corner.
  • BottomRight: the lower-right corner.
  • BottomLeft: the lower-left corner.
Image
RatioReferobject

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

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

The horizontal offset. Unit: pixel.

0.51
Widthstring

The width of the watermark image. Unit: pixel.

0.36
Heightstring

The height of the watermark image. Unit: pixel.

0.33
Dystring

The timeline of the watermark.

0.2
ReferPosstring

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

  • Unit: seconds.
  • Default value: 0.
TopRight
Statestring

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

Normal
Dxstring

The name of the watermark template.

100
Widthstring

The vertical offset. Unit: pixel.

8
Heightstring

The ID of the watermark template.

8
Timelineobject

You can call this operation to query watermark templates in the specified state. If you do not specify the state, all watermark templates are queried by default.

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.

Startstring

The total number of returned entries.

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.
ToEND
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.

88c6ca184c0e4578645b665e2a12****

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "FC029D04-8F47-57FF-A759-23383C15617D",
  "PageNumber": 1,
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.2"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "ToEND"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "88c6ca184c0e4578645b665e2a12****"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history