tencent cloud



Last updated: 2024-03-27 16:09:46

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    Initiate a Remaster task for audio and video media in VOD

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    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.
    FileId Yes String Media file ID, that is, the globally unique identifier of the file on VOD, which is assigned by the VOD backend after successful upload. This field can be obtained from video upload completion event notification or vod console.
    Definition Yes Integer Remaster template ID, please contact Tencent Cloud for details
    SubAppId No Integer VOD Subapplication ID. If you want to access resources in the Subapplication, enter the Subapplication ID in this field; otherwise, you do not need to fill in this field.
    OutputConfig No EnhanceMediaQualityOutputConfig Configuration of media files after Remaster
    SessionId No String The identification code used for deduplication. If there has been a request with the same identification code within three days, this request will return an error. Up to 50 characters, without or with an empty string means no deduplication
    SessionContext No String Source context, used to pass through user request information, Remaster completion callback will return this field value, up to 1000 characters
    TasksPriority No Integer The priority of the task, the higher the value, the higher the priority, the range is -10 to 10, not filled in means 0

    3. Output Parameters

    Parameter Name Type Description
    TaskId String Remaster 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.

    4. Example

    Example1 Initiate a Remaster task

    Initiate a Remaster task for the video with fileId 5285485487985271487

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: EnhanceMediaQuality
    <Common request parameters>
        "FileId": "5285485487985271487",
        "Definition": 10

    Output Example

        "Response": {
            "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
            "TaskId": "125xxx65-EnhanceMediaQuality-bffb15f07530b57bc1aabb01fac74bcc"

    5. Developer Resources


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    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 Incorrect parameter value.
    InvalidParameterValue.SessionContextTooLong SessionContext is too long.
    InvalidParameterValue.SessionId The deduplication ID already exists. The request is removed due to duplication.
    InvalidParameterValue.SessionIdTooLong SessionId is too long.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support