tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Infinite
    Documentation

    Searching for Splicing Template

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

      Feature Description

      This API (DescribeMediaTemplates) is used to search for splicing 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.

      Request headers

      Common request headers

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

      Non-common request headers

      This request operation does not use any non-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: Concat
      String
      Yes
      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

      Common response headers

      This response contains common response headers. For more information, see Common Response Headers.

      Non-common response headers

      This response does not use any non-common response header.

      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>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
              <Tag>Concat</Tag>
              <Name>TemplateName</Name>
              <ConcatTemplate>
                  <ConcatFragment>
                      <Mode>Start</Mode>
                      <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/start.mp4</Url>
                  </ConcatFragment>
                  <ConcatFragment>
                      <Mode>End</Mode>
                      <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/end.mp4</Url>
                  </ConcatFragment>
                  <Audio>
                      <Codec>mp3</Codec>
                      <Samplerate></Samplerate>
                      <Bitrate></Bitrate>
                      <Channels></Channels>
                  </Audio>
                  <Video>
                      <Codec>H.264</Codec>
                      <Bitrate>1000</Bitrate>
                      <Width>1280</Width>
                      <Height></Height>
                      <Fps>30</Fps>
                  </Video>
                  <Container>
                      <Format>mp4</Format>
                  </Container>
              </ConcatTemplate>
              <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
      String
      Tag
      Response.TemplateList
      Template type: Concat
      String
      UpdateTime
      Response.TemplateList
      Update time
      String
      CreateTime
      Response.TemplateList
      Creation time
      String
      ConcatTemplate
      Response.TemplateList
      Watermark information
      Container
      ConcatTemplate has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Default Value
      Constraints
      ConcatFragment
      Response.TemplateList.ConcatTemplate
      Splicing node
      Container
      Yes
      None
      None
      Audio
      Response.TemplateList.ConcatTemplate
      Reference position
      String
      Yes
      None
      None
      Video
      Response.TemplateList.ConcatTemplate
      Video parameters
      Container
      Yes
      None
      None
      Container
      Response.TemplateList.ConcatTemplate
      Container format
      Container
      Yes
      None
      None
      ConcatFragment has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Default Value
      Constraints
      Url
      Response.TemplateList.ConcatTemplate.ConcatFragment
      Splicing object address
      String
      Yes
      None
      Same as the address of the bucket object file.
      Mode
      Response.TemplateList.ConcatTemplate.ConcatFragment
      Node type
      String
      Yes
      None
      Start
      End
      Audio has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Default Value
      Constraints
      Codec
      Request.ConcatTemplate.Audio
      Codec format
      String
      Yes
      Original codec of the file
      Valid values: aac, mp3
      Samplerate
      Request.ConcatTemplate.Audio
      Sample rate
      String
      No
      Original sample rate of the file
      Unit: Hz
      Valid values: 11025, 22050, 32000, 44100, 48000, 96000
      Different container formats support different MP3 sample rates, as shown in the table below.
      Bitrate
      Request.ConcatTemplate.Audio
      Audio bitrate
      String
      No
      Original audio bitrate of the file
      Unit: Kbps
      Value range: [8, 1000]
      Channels
      Request.ConcatTemplate.Audio
      Number of sound channels
      String
      No
      Original number of sound channels of the file
      If Codec is aac, the value can be 1, 2, 4, 5, 6, or 8.
      If Codec is mp3, the value can be 1 or 2.
      Y indicates supported, and N indicates unsupported.
      Container Format/Audio Sample Rate
      11025
      22050
      32000
      44100
      48000
      96000
      mp3
      Y
      Y
      Y
      Y
      Y
      N
      Container has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Format
      Request.ConcatTemplate.Container
      Container format: mp4, flv, hls, ts, mp3, aac
      String
      Yes
      Video has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Default Value
      Constraints
      Codec
      Request.ConcatTemplate.Video
      Codec format
      String
      Yes
      H.264
      H.264
      Width
      Request.ConcatTemplate.Video
      Width
      String
      No
      Original video width
      Value range: [128, 4096]
      Unit: px
      If only Width is set, Height is calculated according to the original video aspect ratio.
      Height
      Request.ConcatTemplate.Video
      Height
      String
      No
      Original video height
      Value range: [128, 4096]
      Unit: px
      If only Height is set, Width is calculated according to the original video aspect ratio.
      Fps
      Request.ConcatTemplate.Video
      Frame rate
      String
      No
      Original video frame rate
      Value range: (0, 60]
      Unit: fps
      Bitrate
      Request.ConcatTemplate.Video
      Bitrate of the video output file
      String
      No
      Original video bitrate
      Value range: [10, 50000]
      Unit: Kbps
      Crf
      Request.ConcatTemplate.Video
      Bitrate, which is a quality control factor
      String
      No
      Original video bitrate
      Value range: (0, 51]
      If Crf is set, the setting of Bitrate becomes invalid.
      If Bitrate is empty, 25 is used for this parameter by default.
      Remove
      Request.ConcatTemplate.Video
      Whether to delete the video stream
      String
      No
      false
      Valid values: true, false
      Rotate
      Request.Video
      Rotation angle
      String
      No
      None
      1. Value range: [0, 360) 2. Unit: degree

      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=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR98****-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
      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>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
              <Tag>Concat</Tag>
              <Name>TemplateName</Name>
              <ConcatTemplate>
                  <ConcatFragment>
                      <Mode>Start</Mode>
                      <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/start.mp4</Url>
                  </ConcatFragment>
                  <ConcatFragment>
                      <Mode>End</Mode>
                      <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/end.mp4</Url>
                  </ConcatFragment>
                  <Audio>
                      <Codec>mp3</Codec>
                      <Samplerate></Samplerate>
                      <Bitrate></Bitrate>
                      <Channels></Channels>
                  </Audio>
                  <Video>
                      <Codec>H.264</Codec>
                      <Bitrate>1000</Bitrate>
                      <Width>1280</Width>
                      <Height></Height>
                      <Fps>30</Fps>
                  </Video>
                  <Container>
                      <Format>mp4</Format>
                  </Container>
              </ConcatTemplate>
              <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=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR98****-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
      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>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
              <Tag>Concat</Tag>
              <Name>TemplateName</Name>
              <ConcatTemplate>
                  <ConcatFragment>
                      <Mode>Start</Mode>
                      <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/start.mp4</Url>
                  </ConcatFragment>
                  <ConcatFragment>
                      <Mode>End</Mode>
                      <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/end.mp4</Url>
                  </ConcatFragment>
                  <Audio>
                      <Codec>mp3</Codec>
                      <Samplerate></Samplerate>
                      <Bitrate></Bitrate>
                      <Channels></Channels>
                  </Audio>
                  <Video>
                      <Codec>H.264</Codec>
                      <Bitrate>1000</Bitrate>
                      <Width>1280</Width>
                      <Height></Height>
                      <Fps>30</Fps>
                  </Video>
                  <Container>
                      <Format>mp4</Format>
                  </Container>
              </ConcatTemplate>
              <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