Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to initiate an audio and video quality regeneration task for on-demand audio-video media.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: EnhanceMediaQuality. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Definition | Yes | Integer | Audio-visual quality rebirth template ID. For typical usage scenarios, VOD provides multiple preset templates (https://www.tencentcloud.com/document/product/266/102586?from_cn_redirect=1#50604b3f-0286-4a10-a3f7-18218116aff7). |
| FileId | No | String | Media file ID, the globally unique identifier of the file in VOD, assigned by the VOD backend after successful upload. You can obtain this field in the video upload completion event notification (https://www.tencentcloud.com/document/product/266/7830?from_cn_redirect=1) or the VOD console (https://console.tencentcloud.com/vod/media). |
| MediaStoragePath | No | String | Media storage path. Only sub-apps in FileID + Path mode can initiate tasks through MediaStoragePath. Either FileId or MediaStoragePath must be provided. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD services after December 25, 2023, when accessing resources in VOD applications (whether the default application or a newly created application), this field must be set to the app ID. |
| OutputConfig | No | EnhanceMediaQualityOutputConfig | Media file configuration after audio and video quality revival. |
| SessionId | No | String | An identifier for deduplication. If there has been a request with the same identifier within the past 3 days, an error will be returned for the current request. The maximum length is 50 characters. Leaving it blank or using a null string indicates no deduplication is required. |
| SessionContext | No | String | Source context, used to pass through user request information. The audio and video quality revival completion callback will return the value of this field. Maximum length: 1000 characters. |
| TasksPriority | No | Integer | Task priority. The higher the value, the higher the priority. The value range is from -10 to 10. If this is not specified, the default value is 0. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Audio and video quality regeneration task ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to initiate an audio and video quality regeneration task for a video with fileId 5285485487985271487.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnhanceMediaQuality
<Common request parameters>
{
"FileId": "5285485487985271487",
"Definition": 100
}{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-EnhanceMediaQuality-bffb15f07530b57bc1aabb01fac74bcc"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
| InvalidParameterValue.SessionId | Duplicate recognition code. Request deduplicated. |
| InvalidParameterValue.SessionIdTooLong | SessionId is too long. |
피드백