tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Infinite
    Documentation

    Searching for Screenshot Template

    Last updated: 2024-02-29 09:57:29

      Feature Description

      This API (DescribeMediaTemplates) is used to search for screenshot templates.
      

      Request

      Sample request

      GET /template HTTP/1.1
      Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
      Date: <GMT Date>
      Authorization: <Auth String>
      Content-Length: <length>
      Content-Type: application/xml
      
      Note:
      Authorization: Auth String (for more information, see Request Signature).
      When this feature is used by a sub-account, relevant permissions must be granted. For more information, see Authorization Granularity.

      Request headers

      This API only uses common request headers. For more information, see Common Request Headers.

      Request body

      The request body of this request is empty.

      Request parameters

      The parameters are as described below:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      tag
      None
      Template type: Snapshot
      String
      Yes
      category
      None
      Template category: Custom (default) or Official
      String
      No
      ids
      None
      Template ID. If you enter multiple IDs, separate them by comma.
      String
      No
      name
      None
      Template name prefix
      String
      No
      pageNumber
      None
      Page number
      Integer
      No
      pageSize
      None
      Number of entries per page
      Integer
      No

      Response

      Response headers

      This API only returns common response headers. For more information, see Common Response Headers.

      Response body

      The response body returns application/xml data. The following contains all the nodes:
      <Response>
          <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId>
          <TotalCount>1</TotalCount>
          <PageNumber>1</PageNumber>
          <PageSize>10</PageSize>
          <TemplateList>
              <TemplateId>A</TemplateId>
              <Name>TemplateName</Name>
              <Tag>Snapshot</Tag>
              <Snapshot>
                  <Width>1280</Width>
                  <Height></Height>
                  <Start>0</Start>
                  <TimeInterval></TimeInterval>
                  <Count></Count>
              </Snapshot>
              <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
              <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
          </TemplateList>
      </Response>
      The nodes are as described below:
      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
      RequestId
      Response
      Unique ID of the request.
      String
      TotalCount
      Response
      Total number of templates
      Int
      PageNumber
      Response
      Current page number. Same as pageNumber in the request.
      Int
      PageSize
      Response
      Number of entries per page. Same as pageSize in the request.
      Int
      TemplateList
      Response
      Template array
      Container
      TemplateList has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      TemplateId
      Response.TemplateList
      Template ID
      String
      Name
      Response.TemplateList
      Template name
      String
      BucketId
      Response.TemplateList
      Template bucket
      String
      Category
      Response.TemplateList
      Template category: Custom or Official
      String
      Tag
      Response.TemplateList
      Template type: Snapshot
      String
      UpdateTime
      Response.TemplateList
      Update time
      String
      CreateTime
      Response.TemplateList
      Creation time
      String
      Snapshot
      Response.TemplateList
      Template parameters
      Container
      Snapshot has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Default Value
      Constraints
      Mode
      TemplateList.Snapshot
      Screenshot mode
      String
      Yes
      Interval
      Valid values: {Interval, Average}
      Interval: Interval mode. Average: Average mode
      Interval mode: The Start, TimeInterval, and Count parameters take effect. If Count is set and TimeInterval is not set, all frames will be captured, and the total number of images captured is specified by Count.
      Average mode: The Start and Count parameters take effect, indicating to capture a total of Count images at an average interval from Start to the end of the video.
      Start
      TemplateList.Snapshot
      Start time
      String
      Yes
      0
      [0, video duration]
      Unit: second
      Supports the float format, accurate to the millisecond.
      TimeInterval
      TemplateList.Snapshot
      Screenshot time interval
      String
      No
      None
      (0, 3600]
      Unit: second
      Supports the float format, accurate to the millisecond.
      Count
      TemplateList.Snapshot
      Number of screenshots
      String
      Yes
      None
      (0, 10000]
      Width
      TemplateList.Snapshot
      Width
      String
      No
      Original video width
      Value range: [1, 4096]
      Unit: px
      If only Width is set, Height is calculated according to the original video aspect ratio.
      Height
      TemplateList.Snapshot
      Height
      String
      No
      Original video height
      Value range: [1, 4096]
      Unit: px
      If only Height is set, Width is calculated according to the original video aspect ratio.

      Error codes

      There are no special error messages for this request. For common error messages, see Error Codes.

      Samples

      Sample 1. Querying by template ID

      Request

      GET /template?ids=A,B,C 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:bucket-1250000000.ci.ap-beijing.myqcloud.com
      Content-Length: 0
      Content-Type: application/xml
      

      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: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
      
      <Response>
          <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzh****=</RequestId>
          <TemplateList>
              <TemplateId>A</TemplateId>
              <Name>TemplateName</Name>
              <Tag>Snapshot</Tag>
              <Snapshot>
                  <Width>1280</Width>
                  <Height></Height>
                  <Start>0</Start>
                  <TimeInterval></TimeInterval>
                  <Count></Count>
              </Snapshot>
              <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
              <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
          </TemplateList>
          <NonExistTIDs>
              <TemplateId>B</TemplateId>
              <TemplateId>C</TemplateId>
          </NonExistTIDs>
      </Response>
      Sample 2. Querying by paginated list

      Request

      GET /template?page_size=10&page_number=1 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:bucket-1250000000.ci.ap-beijing.myqcloud.com
      Content-Length: 0
      Content-Type: application/xml
      

      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: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
      
      <Response>
          <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzh****=</RequestId>
          <TotalCount>1</TotalCount>
          <PageNumber>1</PageNumber>
          <PageSize>10</PageSize>
          <TemplateList>
              <TemplateId>A</TemplateId>
              <Name>TemplateName</Name>
              <Tag>Snapshot</Tag>
              <Snapshot>
                  <Width>1280</Width>
                  <Height></Height>
                  <Start>0</Start>
                  <TimeInterval></TimeInterval>
                  <Count></Count>
              </Snapshot>
              <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
              <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
          </TemplateList>
      </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
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy