Preprocesses a video by using the production studio feature.
Operation description
- During video preprocessing, videos are transcoded to meet the playback requirements of the production studio. Therefore, you are charged for video preprocessing. For more information about billing, see Billing of production studios.
- You can obtain the preprocessing result in the TranscodeComplete event notification. If Preprocess=true is returned in the event notification, the video is transcoded.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vod:SubmitPreprocessJobs | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| VideoId | string | Yes | The ID of the video. You can use one of the following methods to obtain the ID:
| d3e680e618708efbf2cae7cc9312**** |
| PreprocessType | string | Yes | The preprocessing type. Set the value to LivePreprocess. LivePreprocess specifies that the video is preprocessed in the production studio. | LivePreprocess |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"PreprocessJobs": {
"PreprocessJob": [
{
"JobId": "bb396607fd11fee9effbb99c4****"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history
Common errors
The following table describes the common errors that this operation can return.
| Error code | Error message | HTTP status code | Description |
|---|---|---|---|
| InvalidVideo.NotFound | The video does not exist. | 404 | The error message returned because the video does not exist. |
| NoSuchResource | The specified resource %s does not exist. | 404 | The error message returned because the specified resource does not exist. |
| Forbidden.IllegalStatus | Status of the video is illegal. | 400 | The error message returned because the video status is invalid. You can preprocess a video only in the UploadSucces, Normal, Checking, or Transcoding state. |