Creates an editing task.

Usage notes

You can call this operation to create an editing task by specifying the ID of the production studio and the ID of the episode.

You will not receive a notification after the editing task is created. You can call the GetEditingJobInfo operation to query the status of the editing task.

Limits on QPS

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes EditShowAndReplace

The operation that you want to perform. Set the value to EditShowAndReplace.

CasterId String Yes 53200b81-b761-4c10-842a-a0726d97****

The ID of the production studio.

  • If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID of the production studio.
  • If the production studio was created in the ApsaraVideo Live console, obtain the ID of the production studio on the Production Studio Management page. To go to the Production Studio Management page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane.
Note You can find the created production studio on the Production Studio Management page and view the ID in the Name column.
ShowId String Yes 42200b81-b761-4c10-842a-a0726d97****

The ID of the episode to be edited.

Note You can obtain the episode ID by checking the value of the response parameter ShowId of the AddShowIntoShowList operation.
UserData String No 900a2b2r8-13c2-****-88f2-75e4a07c1ed9

The data of user.
StorageInfo String No null

The storage information of the episode. The following parameters are included:

  • StorageLocation: the storage location of ApsaraVideo VOD.
  • FileName: the name of the video-on-demand (VOD) file.
Note You must specify the storage location within the account that is used to access both ApsaraVideo VOD and ApsaraVideo Live. For more information about how to obtain the storage location, see Manage VOD resources.
StartTime Float No 2.0

The start time of the editing task. Unit: seconds.

Note
  • The valid values range from 0 to the value indicated by the total length of the episode.
  • By default, the editing task starts from the beginning of the episode. Default value: 0.0.
  • If you want to edit a VOD file from the 2nd second to the 5th second, set the StartTime parameter to 2.0 and the EndTime parameter to 5.0.
EndTime Float No 5.0

The end time of the editing task. Unit: seconds.

Note
  • The valid values range from 0 to the value indicated by the total length of the episode.
  • By default, this parameter is set to the value that indicates the total length of the episode. The editing period cannot exceed the total length of the episode.
  • If you want to edit a VOD file from the 2nd second to the 5th second, set the StartTime parameter to 2.0 and the EndTime parameter to 5.0.

Response parameters

Parameter Type Example Description
JobInfo String null

The information about the editing task. The following parameters are included:

  • vodId: the ID of the VOD file.
  • mediaid: the ID of the media file.
  • jobId: the ID of the editing task.
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=EditShowAndReplace
&CasterId=53200b81-b761-4c10-842a-a0726d97****
&ShowId=42200b81-b761-4c10-842a-a0726d97****
&<Common request parameters>

Sample success responses

XML format 

<EditShowAndReplaceResponse> 
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
  <JobInfo>
        <vodId>3e34733b40b9a96ccf5c1ff6f69****</vodId>
        <mediaid>eb1861d2c9a842340e989dd56****</mediaid>
        <jobId>7d2fbc380b0e08e55fe98733764****</jobId>
  </JobInfo>
</EditShowAndReplaceResponse>

JSON format 

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "JobInfo": {
        "vodId": "3e34733b40b9a96ccf5c1ff6f69****",
        "mediaid": "eb1861d2c9a842340e989dd56****",
        "jobId": "7d2fbc380b0e08e55fe98733764****"
    }
}

Error codes

For a list of error codes, visit the API Error Center.