Media asset processing
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
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
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
asset_id |
Yes |
String |
Media ID |
template_group_name |
No |
String |
Name of a transcoding template groupIf 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:
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> This parameter is valid only when the parameter subtitles is specified during Creating a Media File. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Snapshot capturing mode Possible values are:
|
time |
No |
Integer |
This parameter is mandatory when type is set to time, indicating that the interval for sampling. Value range: an integer between 1 and 12 Unit: second |
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:
The default value is 1. |
aspect_ratio |
No |
Integer |
Aspect ratio Possible values are:
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. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
asset_id |
String |
Media ID |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
POST https://{endpoint}/v1.0/{project_id}/asset/process { "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.
Feedback
Was this page helpful?
Provide feedbackFor any further questions, feel free to contact us through the chatbot.
Chatbot