tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Infinite
    Documentation
    Download PDF

    Updating a Watermark Template

    Last updated: 2021-12-31 17:05:21
    Download PDF

      Feature Description

      This API (UpdateMediaTemplate) is used to update a watermark template.

      Request

      Sample request

      PUT /template/<TemplateId> HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>
      Note：

      Authorization: Auth String (For more information, please see Request Signature.)

      Request headers

      This API only uses Common Request Headers.

      Request body

      This request requires the following request body:

      <Request>
  <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
  <Tag>Watermark</Tag>
  <Name>TemplateName</Name>
  <Watermark>
      <Type>Text</Type>
      <LocMode>Absolute</LocMode>
      <Dx>128</Dx>
      <Dy>128</Dy>
      <Pos>TopRight</Pos>
      <StartTime>0</StartTime>
      <EndTime>100.5</EndTime>
      <Text>
          <Text>Watermark content</Text>
          <FontSize>30</FontSize>
          <FontType></FontType>
          <FontColor>0xRRGGBB</FontColor>
          <Transparency>30</Transparency>
      </Text>
  </Watermark>
</Request>

      The nodes are described as follows:

      Node Name (Keyword) Parent Node Description Type Required
      Request None Request container Container Yes

      Request has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required
      Tag Request Task type: Watermark String Yes
      Name Request Template name. The value can contain only Chinese characters, letters, digits, underscores (_), hyphens (-), and asterisks (*). String Yes
      Watermark Request Watermark information Container Yes

      Watermark has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required Default Value Constraints
      Type Request.Watermark Watermark type String Yes None
    • Text: text watermark
    • Image: image watermark
      		•
      Pos Request.Watermark Reference position String Yes None
    • TopRight: top right
    • TopLeft: top left
    • BottomRight: bottom right
    • BottomLeft: bottom left
      		•
      LocMode Request.Watermark Offset mode String Yes None
    • Relativity: proportionally
    • Absolute: fixed position
      		•
      Dx Request.Watermark Horizontal offset String Yes None 1. Image watermark with Background being true: If locMode is Relativity, the unit is %, and the value range is [-300, 0]. If locMode is Absolute, the unit is px, and the value range is [-4096, 0].
      2. Image watermark with Background being false: If locMode is Relativity, the unit is %, and the value range is [0, 100]. If locMode is Absolute, the unit is px, and the value range is [0, 4096].
      3. Text watermark: If locMode is Relativity, the unit is %, and the value range is [0, 100]. If locMode is Absolute, the unit is px, and the value range is [0, 4096].
      Dy Request.Watermark Vertical offset String Yes None 1. Image watermark with Background being true: If locMode is Relativity, the unit is %, and the value range is [-300, 0]. If locMode is Absolute, the unit is px, and the value range is [-4096, 0].
      2. Image watermark with Background being false: If locMode is Relativity, the unit is %, and the value range is [0, 100]. If locMode is Absolute, the unit is px, and the value range is [0, 4096].
      3. Text watermark: If locMode is Relativity, the unit is %, and the value range is [0, 100]. If locMode is Absolute, the unit is px, and the value range is [0, 4096].
      StartTime Request.Watermark Watermark start time String No 0
    • [0, Video duration]
    • Unit: second
    • Supports the float format, accurate to milliseconds.
      		•
      EndTime Request.Watermark Watermark end time String No Video end time
    • [0, Video duration]
    • Unit: second
    • Supports the float format, accurate to milliseconds.
      		•
      Image Request.Watermark Image watermark node Container No None None
      Text Request.Watermark Text watermark node Container No None None

      Image has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required Default Value Constraints
      Url Request.Watermark.
      Image      		 Watermark image address String Yes None If the watermark image is a private object, the URL must contain a signature.
      Mode Request.Watermark.
      Image      		 Dimension mode String Yes None
    • Original: original size
    • Proportion: scaled proportionally
    • Fixed: fixed size
      		•
      Width Request.Watermark.
      Image      		 Width String No None
    • If Mode is Original, the watermark image width cannot be set.
    • If Mode is Proportion, the unit is %, the background image value range is [100, 300], and the foreground image value range is [1, 100].
    • If Mode is Fixed, the unit is px, and the value range is [8, 4096]. If only Width is set, Height is calculated according to the original video proportion.
      		•
      Height Request.Watermark.
      Image      		 Height String No None
    • If Mode is Original, the watermark image height cannot be set.
    • If Mode is Proportion, the unit is %, the background image value range is [100, 300], and the foreground image value range is [1, 100].
    • If Mode is Fixed, the unit is px, and the value range is [128, 4096]. If only Height is set, the watermark image width is calculated according to the original video proportion.
      		•
      Transparency Request.Watermark.
      Image      		 Transparency String Yes None Value range: [0, 100]; unit: %
      Background Request.Watermark.
      Image      		 Whether it is a background image String No false true, false

      Text has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required Default Value Constraints
      FontSize Request.Watermark.
      Text      		 Font size String Yes None Value range: [0, 100]; unit: px
      FontType Request.Watermark.
      Text      		 Font type String Yes None See the table below.
      FontColor Request.Watermark.
      Text      		 Font color String Yes None Format: 0xRRGGBB
      Transparency Request.Watermark.
      Text      		 Transparency String Yes None Value range: [0, 100]; unit: %
      Text Request.Watermark.
      Text      		 Watermark content String Yes None The value can be up to 64 characters in length and contain only Chinese characters, letters, digits, underscores (_), hyphens (-), and asterisks (*).

      FontType has the following sub-nodes:

      Font Name Supported Language Description
      simfang.ttf Chinese/English FangSong
      simhei.ttf Chinese/English SimHei
      simkai.ttf Chinese/English KaiTi
      simsun.ttc Chinese/English SimSun
      STHeiti-Light.ttc Chinese/English STHeiti-Light
      STHeiti-Medium.ttc Chinese/English STHeiti-Medium
      youyuan.TTF Chinese/English YouYuan
      ariblk.ttf English None
      arial.ttf English None
      ahronbd.ttf English None
      Helvetica.dfont English None
      HelveticaNeue.dfont English None

      Response

      Response headers

      This API only returns Common Response Headers.

      Response body

      The response body returns application/xml data. The following contains all the nodes:

      <Response>
  <Template>
      <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
      <Tag>Watermark</Tag>
      <Name>TemplateName</Name>
      <Watermark>
          <Type>Text</Type>
          <LocMode>Absolute</LocMode>
          <Dx>128</Dx>
          <Dy>128</Dy>
          <Pos>TopRight</Pos>
          <StartTime>0</StartTime>
          <EndTime>100.5</EndTime>
          <Text>
              <Text>Watermark content</Text>
              <FontSize>30</FontSize>
              <FontType></FontType>
              <FontColor>0xRRGGBB</FontColor>
              <Transparency>30</Transparency>
          </Text>
      </Watermark>
      <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
      <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
  </Template>
</Response>

      The nodes are described as follows:

      Node Name (Keyword) Parent Node Description Type
      Response None Response container Container

      Response has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type
      TemplateId Response Template ID String
      Watermark Response Watermark information. Same as Watermark in the request body. Container

      Error codes

      No special error message will be returned for this request. For the common error messages, please see Error Codes.

      Examples

      Request

      PUT /template/<TemplateId> HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml
<Request>
  <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
  <Tag>Watermark</Tag>
  <Name>TemplateName</Name>
  <Watermark>
      <Type>Text</Type>
      <LocMode>Absolute</LocMode>
      <Dx>128</Dx>
      <Dy>128</Dy>
      <Pos>TopRight</Pos>
      <StartTime>0</StartTime>
      <EndTime>100.5</EndTime>
      <Text>
          <Text>Watermark content</Text>
          <FontSize>30</FontSize>
          <FontType></FontType>
          <FontColor>0xRRGGBB</FontColor>
          <Transparency>30</Transparency>
      </Text>
  </Watermark>
</Request>

      Response

      HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
  <Template>
      <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
      <Tag>Watermark</Tag>
      <Name>TemplateName</Name>
      <Watermark>
          <Type>Text</Type>
          <LocMode>Absolute</LocMode>
          <Dx>128</Dx>
          <Dy>128</Dy>
          <Pos>TopRight</Pos>
          <StartTime>0</StartTime>
          <EndTime>100.5</EndTime>
          <Text>
              <Text>Watermark content</Text>
              <FontSize>30</FontSize>
              <FontType></FontType>
              <FontColor>0xRRGGBB</FontColor>
              <Transparency>30</Transparency>
          </Text>
      </Watermark>
      <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
      <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
  </Template>
</Response>
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      tencent
      Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy