tencent cloud

Feedback

Searching for Transcoding Templates

Last updated: 2021-12-31 17:05:22

    Feature Description

    This API (DescribeMediaTemplates) is used to search for transcoding 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, please see Request Signature.)

    Request headers

    This API only uses Common Request Headers.

    Request body

    The request body of this request is empty.

    Request parameters

    The nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type Required
    tag None Task type: Transcode String Yes
    category None Template category: Custom (default) or Official String Yes
    ids None Template ID. If you enter multiple IDs, separate them with commas (,). String No
    name None Template name prefix String No
    pageNumber None Page number Integer No
    pageSize None Records per page Integer No

    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>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <TemplateList>
          <TemplateId>A</TemplateId>
          <Name>TemplateName</Name>
          <Tag>Transcode</Tag>
          <TransTpl>
              <Container>
                  <Format>mp4</Format>
              </Container>
              <Video>
                  <Codec>H.264</Codec>
                  <Profile>high</Profile>
                  <Bitrate>1000</Bitrate>
                  <Crf></Crf>
                  <Width>1280</Width>
                  <Height></Height>
                  <Fps>30</Fps>
                  <Gop></Gop>
                  <Preset>medium</Preset>
                  <ScanMode></ScanMode>
                  <Bufsize>0</Bufsize>
                  <Maxrate>0</Maxrate>
               </Video>
              <Audio>
                  <Codec>aac</Codec>
                  <Samplerate>44100</Samplerate>
                  <Bitrate>128</Bitrate>
                  <Channels>4</Channels>
              </Audio>
              <TransConfig>
                  <AdjDarMethod>scale</AdjDarMethod>
                  <IsCheckReso>false</IsCheckReso>
                  <ResoAdjMethod>1</ResoAdjMethod>
              </TransConfig>
              <TimeInterval>
                  <Start>0</Start>
                  <Duration>60</Duration>
              </TimeInterval>
          </TransTpl>
          <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
          <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
      </TemplateList>
    </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
    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 records 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 Task type: Transcode String
    UpdateTime Response.TemplateList Update time String
    CreateTime Response.TemplateList Creation time String
    TransTpl Response.TemplateList Template parameters Container

    TransTpl has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    TimeInterval Response.TemplateList.TransTpl Time interval Container
    Container Response.TemplateList.TransTpl Container format Container
    Video Response.TemplateList.TransTpl Video information Container
    Audio Response.TemplateList.TransTpl Audio information Container
    TransConfig Response.TemplateList.TransTpl Transcoding configuration Container

    Container has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required
    Format Request.Container Container format: mp4, flv, hls, ts String Yes

    Video has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required Default Value Constraints
    Codec Response.TemplateList.
    TransTpl.Video
    Codec format String No Original video codec H.264
    Width Response.TemplateList.
    TransTpl.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 proportion.
  • Height Response.TemplateList.
    TransTpl.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 proportion.
  • Fps Response.TemplateList.
    TransTpl.Video
    Frame rate String No Original video frame rate
  • Value range: (0, 60]
  • Unit: fps
  • If the frame rate is greater than 60, set this parameter to 60.
    This parameter is optional. If it is not set, the video is played at the speed as per the original timestamp. This parameter specifies the frame rate for animated image playback.
  • Remove Response.TemplateList.
    TransTpl.Video
    Whether to delete the video stream String No false true, false
    Profile Response.TemplateList.
    TransTpl.Video
    Encoding format String No high
  • Valid values: baseline, main, high
  • baseline: suitable for mobile devices
  • main: suitable for standard resolution devices
  • high: suitable for high resolution devices
  • Only H.264 supports this parameter.
  • Bitrate Response.TemplateList.
    TransTpl.Video
    Bitrate of the video output file String No Original video bitrate
  • Value range: [10, 50000]
  • Unit: Kbps
  • Crf Response.TemplateList.
    TransTpl.Video
    Bit rate, which is a quality control factor String No Null
  • Value range: [0, 51]
  • If Crf is set, the setting of Bitrate becomes invalid.
  • Crf is not set by default.
  • Gop Response.TemplateList.
    TransTpl.Video
    Maximum number of frames between two key frames String No Null Value range:
  • [0, 100000]
  • Gop is not set by default.
  • Preset Response.TemplateList.
    TransTpl.Video
    Video algorithm preset String No medium
  • Only H.264 supports this parameter.
  • Valid values: veryfast, fast, medium, slow, slower
  • Bufsize Response.TemplateList.
    TransTpl.Video
    Buffer size String No 0
  • Value range: [1000, 128000]
  • Unit: Kb
  • The default value is 0, indicating that buffer is not used.
  • Maxrate Response.TemplateList.
    TransTpl.Video
    Peak video bitrate String No 0
  • Value range: [10, 50000]
  • Unit: Kbps
  • The default value is 0, indicating that this parameter is not used.
  • HlsTsTime Response.TemplateList.
    TransTpl.Video
    HLS segment time String No 5
  • Value range: (0, Video duration]
  • Unit: second
  • Pixfmt Response.TemplateList.
    TransTpl.Video
    Video color format String No yuv420p Valid values: yuv420p, yuv422p, yuv444p, yuvj420p, yuvj422p, yuvj444p
    LongShortMode Response.TemplateList.
    TransTpl.Video
    Long and short sides adaptive String No false true, false

    TimeInterval has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required Default Value Constraints
    Start Response.TemplateList.
    TransTpl.TimeInterval
    Start time String No 0
  • [0, Video duration]
  • Unit: second
  • Supports the float format, accurate to milliseconds.
  • Duration Response.TemplateList.
    TransTpl.TimeInterval
    Duration String No Video duration
  • [0, Video duration]
  • Unit: second
  • Supports the float format, accurate to milliseconds.
  • Audio has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required Default Value Constraints
    Codec Response.TemplateList.
    TransTpl.Audio
    Codec format String No aac Valid values: aac, mp3
    Samplerate Response.TemplateList.
    TransTpl.Audio
    Sample rate String No 44100
  • Unit: Hz
  • 44100, 32000, 44100, 48000, 96000
  • If the container format is FLV and the audio codec format is MP3, the sample rate cannot be 32000, 48000, or 96000. If the audio codec format is MP3, the sample rate cannot be 96000.
  • Bitrate Response.TemplateList.
    TransTpl.Audio
    Original audio bitrate String No 128
  • Unit: Kbps
  • Value range: [8, 1000]
  • Channels Response.TemplateList.
    TransTpl.Audio
    Number of sound channels String No None
  • 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.
  • Remove Response.TemplateList.
    TransTpl.Audio
    Whether to delete the audio stream String No None Valid values: true, false

    TransConfig has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required Default Value Constraints
    AdjDarMethod Response.TemplateList.
    TransTpl.TransConfig
    Resolution adjustment mode String No none
  • Valid values: scale, crop, pad, none
  • If the aspect ratio of the output video is different from that of the original video, the resolution is adjusted according to this parameter.
  • IsCheckReso Response.TemplateList.
    TransTpl.TransConfig
    Whether to check the resolution String No false
  • true, false
  • If the value is false, transcoding is performed based on settings.
  • ResoAdjMethod Response.TemplateList.
    TransTpl.TransConfig
    Resolution adjustment mode String No 0
  • Valid values: 0, 1. 0 indicates to use the original video resolution. 1 indicates to return the transcoding failure message.
  • This parameter is valid only when IsCheckReso is true.
  • IsCheckVideoBitrate Response.TemplateList.
    TransTpl.TransConfig
    Whether to check the video bitrate String No false
  • true, false
  • If the value is false, transcoding is performed based on settings.
  • VideoBitrateAdjMethod Response.TemplateList.
    TransTpl.TransConfig
    Video bitrate adjustment mode String No 0
  • Valid values: 0, 1. 0 indicates to use the original video bitrate. 1 indicates to return the transcoding failure message.
  • This parameter is valid only when IsCheckVideoBitrate is true.
  • IsCheckAudioBitrate Response.TemplateList.
    TransTpl.TransConfig
    Whether to check the audio bitrate String No false
  • true, false
  • If the value is false, transcoding is performed based on settings.
  • AudioBitrateAdjMethod Response.TemplateList.
    TransTpl.TransConfig
    Audio bitrate adjustment mode String No 0
  • Valid values: 0, 1. 0 indicates to use the original audio bitrate. 1 indicates to return the transcoding failure message.
  • This parameter is valid only when IsCheckAudioBitrate is true.
  • The AdjDarMethod parameter is illustrated as follows:

    Error codes

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

    Examples

    Example 1: query 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=28e9a4986df11bed0255e97ff90500557e0e****
    Host: examplebucket-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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    <Response>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
      <TemplateList>
          <TemplateId>A</TemplateId>
          <Name>TemplateName</Name>
          <Tag>Transcode</Tag>
          <TransTpl>
              <Container>
                  <Format>mp4</Format>
              </Container>
              <Video>
                  <Codec>H.264</Codec>
                  <Profile>high</Profile>
                  <Bitrate>1000</Bitrate>
                  <Crf></Crf>
                  <Width>1280</Width>
                  <Height></Height>
                  <Fps>30</Fps>
                  <Gop></Gop>
                  <Preset>medium</Preset>
                  <ScanMode></ScanMode>
                  <Bufsize>0</Bufsize>
                  <Maxrate>0</Maxrate>
               </Video>
              <Audio>
                  <Codec>aac</Codec>
                  <Samplerate>44100</Samplerate>
                  <Bitrate>128</Bitrate>
                  <Channels>4</Channels>
              </Audio>
              <TransConfig>
                  <AdjDarMethod>scale</AdjDarMethod>
                  <IsCheckReso>false</IsCheckReso>
                  <ResoAdjMethod>1</ResoAdjMethod>
              </TransConfig>
              <TimeInterval>
                  <Start>0</Start>
                  <Duration>60</Duration>
              </TimeInterval>
          </TransTpl>
          <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>
    

    Example 2: query by paginated list

    Request

    GET /template?pageSize=10&pageNumber=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=28e9a4986df11bed0255e97ff90500557e0e****
    Host: examplebucket-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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    <Response>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <TemplateList>
          <TemplateId>A</TemplateId>
          <Name>TemplateName</Name>
          <Tag>Transcode</Tag>
          <TransTpl>
              <Container>
                  <Format>mp4</Format>
              </Container>
              <Video>
                  <Codec>H.264</Codec>
                  <Profile>high</Profile>
                  <Bitrate>1000</Bitrate>
                  <Crf></Crf>
                  <Width>1280</Width>
                  <Height></Height>
                  <Fps>30</Fps>
                  <Gop></Gop>
                  <Preset>medium</Preset>
                  <ScanMode></ScanMode>
                  <Bufsize>0</Bufsize>
                  <Maxrate>0</Maxrate>
              </Video>
              <Audio>
                  <Codec>aac</Codec>
                  <Samplerate>44100</Samplerate>
                  <Bitrate>128</Bitrate>
                  <Channels>4</Channels>
              </Audio>
              <TransConfig>
                  <AdjDarMethod>scale</AdjDarMethod>
                  <IsCheckReso>false</IsCheckReso>
                  <ResoAdjMethod>1</ResoAdjMethod>
              </TransConfig>
              <TimeInterval>
                  <Start>0</Start>
                  <Duration>60</Duration>
              </TimeInterval>
          </TransTpl>
          <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.

    Technical Support

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

    7x24 Phone Support