On this page

Show all

Help Center/ Video On Demand/ API Reference/ Media file processing/ Media asset processing

Media asset processing

Updated on 2025-01-14 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

Transcodes, captures snapshots of, or encrypts a video. You can start one or multiple operations at a time.

URI

POST /v1.0/{project_id}/asset/process

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
asset_id	Yes	String	Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified.
template_group_name	No	String	Name of a transcoding template group NOTE: If this parameter is specified, the specified transcoding template is used to transcode the uploaded audio/video. You can configure a transcoding template on the VOD console. For details, see Transcoding Settings in VOD User Guide.
auto_encrypt	No	Integer	Whether to automatically encrypt a file Possible values are: 0: not encrypted 1: encrypted Default value: 0 A file must be encrypted and transcoded at the same time. When encryption is required, the transcoding parameter cannot be empty and the output file must be in HLS format.
thumbnail	No	Thumbnail object	Snapshot parameters
subtitle_id	No	Array of integers	Subtitle file ID. NOTE: This parameter takes effect only when the APIs for Uploading a Media Asset to VOD and Updating a Video are called and the request parameter subtitles is specified. If this parameter is not specified, the last uploaded subtitle is displayed in the video stream by default. Subtitle files in a video stream can only be SRT.

**Table 4** Thumbnail
Parameter	Mandatory	Type	Description
type	Yes	String	Snapshot capturing mode. The options are as follows: time: Snapshots are captured by interval. dots: Snapshots are captured at a specified time point. quantity: Snapshots are captured based on the specified quantity and video duration.
quantity	No	Integer	This parameter is mandatory when type is set to quantity. Snapshots are captured based on the specified quantity and video duration. Value range: an integer between 1 and 10
quantity_time	No	Integer	This parameter is optional when type is set to quantity. Snapshots are captured based on the specified quantity at a specified interval. Value range: an integer between 0 and 2,147,483,647
time	No	Integer	Interval for sampling, in seconds. type is set to time. Default value: 12 Value range: an integer between 0 and 100
dots	No	Array of integers	This parameter is mandatory when type is set to dots. The array of time points when a snapshot is captured is used.
cover_position	No	Integer	The value indicates which snapshot is specified as the thumbnail. The default value is 1.
format	No	Integer	Snapshot file format Possible values are: 1: jpg The default value is 1.
aspect_ratio	No	Integer	Aspect ratio Possible values are: 0: adaptive (the original aspect ratio is retained) 1: 16:9 Default value: 0
max_length	No	Integer	The longest side of a snapshot. Unit: pixel The width of the snapshot is scaled proportionally with the longest side and input video pixel. Default value: 480

Response Parameters

Status code: 202

**Table 5** Response body parameters
Parameter	Type	Description
asset_id	String	Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Example Requests

Media file transcoding.

POST https://{endpoint}/v1.0/{project_id}/asset/process

Content-Type: application/json
{
  "asset_id": "b4f39691d66cc0ef75d62ee567146e11",
  "template_group_name": "test",
  "auto_encrypt": 0,
  "thumbnail": {
    "type": "time",
    "time": 12
  },
  "subtitle_id": [
    1
  ]
}

Example Responses

Status code: 202

The information is returned when the request succeeds.

{
  "asset_id" : "b4f39691d66cc0ef75d62ee567146e11"
}

Status code: 403

The information is returned when the request fails.

{
  "error_code" : "VOD.10062",
  "error_msg" : "Media asset or resource does not exist, please check."
}

Status Codes

Status Code	Description
202	The information is returned when the request succeeds.
403	The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: Media file processing

Previous topic: Updates a video

Next topic: Cancels a media asset transcoding task

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot