tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation

    Submitting Remuxing Job

    Last updated: 2022-07-27 15:17:14

      Feature Description

      This API (CreateMediaJobs) is used to submit a job.

      Request

      Sample request

      POST /jobs 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, 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

      This request requires the following request body:

      <Request>
<Tag>Segment</Tag>
<Input>
  <Object></Object>
</Input>
<Operation>
  <Segment>
    <Format>mp4</Format>
    <Duration>5</Duration>
  </Segment>
  <Output>
    <Region></Region>
    <Bucket></Bucket>
    <Object></Object>
  </Output>
</Operation>
<QueueId></QueueId>
<CallBack></CallBack>
</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 Job type: Segment String Yes
      Input Request Information of the media file to be processed Container Yes
      Operation Request Operation rule Container Yes
      QueueId Request Queue ID of the job String Yes
      CallBack Request Callback address String No

      Input has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required
      Object Request.Input Media filename String Yes

      Operation has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required
      Segment Request.Operation Remuxing parameter Container Yes
      Output Request.Operation Result output address Container Yes

      Segment has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required Constraints
      Format Request.Operation.Segment Container format String Yes aac, mp3, flac, mp4, ts, mkv, avi ,hls, m3u8
      Duration Request.Operation.Segment Remuxing duration in seconds String No The value must be an integer equal to or greater than 5.
      HlsEncrypt Request.Operation.Segment HLS encryption configuration Container No None

      HlsEncrypt has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required Default Value Constraints
      IsHlsEncrypt Request.Operation.Segment.HlsEncrypt Whether to enable HLS encryption String No false 1. Valid values: true, false
      2. Encryption is supported only when Segment.Format is HLS.
      UriKey Request.Operation.Segment.HlsEncrypt HLS encryption key String No None This parameter is valid only when IsHlsEncrypt is true.

      Output has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required
      Region Request.Operation.Output Bucket region String Yes
      Bucket Request.Operation.Output Result storage bucket String Yes
      Object Request.Operation.Output Output result filename. If Duration is configured and Format is not HLS or m3u8, the ${Number} parameter must be included in the filename and used as the output sequence number of each audio/video segment after custom remuxing. String Yes

      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>
<JobsDetail>
  <Code></Code>
  <Message></Message>
  <JobId></JobId>
  <State></State>
  <CreationTime></CreationTime>
  <StartTime></StartTime>
  <EndTime></EndTime>
  <QueueId></QueueId>
  <Tag>Segment</Tag>
  <Input>
    <Object></Object>
  </Input>
  <Operation>
    <Segment>
      <Format>mp4</Format>
      <Duration>5</Duration>
      <HlsEncrypt>
        <IsHlsEncrypt>false</IsHlsEncrypt>
        <UriKey></UriKey>
      </HlsEncrypt>
    </Segment>
    <Output>
      <Region></Region>
      <Bucket></Bucket>
      <Object></Object>
    </Output>
    <MediaInfo>
    </MeidaInfo>
  </Operation>
</JobsDetail>
</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
      JobsDetail Response Job details Container

      JobsDetail has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type
      Code Response.JobsDetail Error code, which is meaningful only if State is Failed String
      Message Response.JobsDetail Error description, which is meaningful only if State is Failed String
      JobId Response.JobsDetail Job ID String
      Tag Response.JobsDetail Job type: Segment String
      State Response.JobsDetail Job status. Valid values: Submitted, Running, Success, Failed, Pause, Cancel String
      CreationTime Response.JobsDetail Job creation time String
      StartTime Response.JobsDetail Job start time String
      EndTime Response.JobsDetail Job end time String
      QueueId Response.JobsDetail Queue ID of the job String
      Input Response.JobsDetail Input resource address of the job Container
      Operation Response.JobsDetail Operation rule Container

      Input has the following sub-nodes:
      Same as the Request.Input node in the request.

      Operation has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type
      Segment Response.JobsDetail.Operation Same as Request.Operation.Segment in the request. Container
      Output Response.JobsDetail.Operation File output address Container
      MediaInfo Response.JobsDetail.Operation Transcoding output video information. This node will not be returned when there is no output video. Container

      Output has the following sub-nodes:
      Same as the Request.Operation.Output node in the request.

      MediaInfo has the following sub-nodes:
      Same as the Response.MediaInfo node in the GenerateMediaInfo API.

      Error codes

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

      Samples

      Request 1

      POST /jobs 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: 166
Content-Type: application/xml
<Request>
<Tag>Segment</Tag>
<Input>
  <Object>test.mp4</Object>
</Input>
<Operation>
  <Segment>
    <Format>mp4</Format>
    <Duration>5</Duration>
  </Segment>
  <Output>
    <Region>ap-beijing</Region>
    <Bucket>examplebucket-1250000000</Bucket>
    <Object>test-trans${Number}</Object>
  </Output>
</Operation>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
</Request>

      Response 1

      HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<JobsDetail>
  <Code>Success</Code>
  <Message>Success</Message>
  <JobId>je8f65004eb8511eaaed4f377124a303c</JobId>
  <State>Submitted</State>
  <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
  <StartTime></StartTime>
  <EndTime></EndTime>
  <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
  <Tag>Segment</Tag>
  <Input>
    <Object>test.mp4</Object>
  </Input>
  <Operation>
    <Segment>
      <Format>mp4</Format>
      <Duration>5</Duration>
    </Segment>
    <Output>
      <Region>ap-beijing</Region>
      <Bucket>examplebucket-1250000000</Bucket>
      <Object>test-trans${Number}</Object>
    </Output>
  </Operation>
</JobsDetail>
</Response>

      Request 2

      POST /jobs 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: 166
Content-Type: application/xml
<Request>
<Tag>Segment</Tag>
<Input>
  <Object>test.mp4</Object>
</Input>
<Operation>
  <Segment>
    <Format>hls</Format>
    <Duration>5</Duration>
    <HlsEncrypt>
      <IsHlsEncrypt>true</IsHlsEncrypt>
      <UriKey>https://example.com/aes.key</UriKey>
    </HlsEncrypt>
  </Segment>
  <Output>
    <Region>ap-beijing</Region>
    <Bucket>examplebucket-1250000000</Bucket>
    <Object>test-trans</Object>
  </Output>
</Operation>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
</Request>

      Response 2

      HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<JobsDetail>
  <Code>Success</Code>
  <Message>Success</Message>
  <JobId>je8f65004eb8511eaaed4f377124a303c</JobId>
  <State>Submitted</State>
  <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
  <StartTime></StartTime>
  <EndTime></EndTime>
  <QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
  <Tag>Segment</Tag>
  <Input>
    <Object>test.mp4</Object>
  </Input>
  <Operation>
    <Segment>
      <Format>hls</Format>
      <Duration>5</Duration>
      <HlsEncrypt>
        <IsHlsEncrypt>true</IsHlsEncrypt>
        <UriKey>https://example.com/aes.key</UriKey>
      </HlsEncrypt>
    </Segment>
    <Output>
      <Region>ap-beijing</Region>
      <Bucket>examplebucket-1250000000</Bucket>
      <Object>test-trans</Object>
    </Output>
  </Operation>
</JobsDetail>
</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