tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ProcessMediaByProcedure

Last updated: 2024-03-27 16:08:31

    1. API Description

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

    This API is used to start a task flow on a video.
    There are two ways to create a task flow template:

    1. Create and modify a task flow template in the console;
    2. Create a task flow template using the CreateProcedureTemplate API.

    If event notifications are used, the event type for moderation tasks is ReviewAudioVideoComplete, and that for other tasks is ProcedureStateChanged.

    A maximum of 100 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: ProcessMediaByProcedure.
    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.
    ProcedureName Yes String Task flow template name.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    TasksPriority No Integer Task flow priority. The higher the value, the higher the priority. Value range: -10-10. If this parameter is left empty, 0 will be used.
    TasksNotifyMode No String Notification mode for task flow status change. Valid values: Finish, Change, None. If this parameter is left empty, Finish will be used.
    SessionContext No String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
    SessionId No String Identification code used for deduplication. If there is a request with the same identification code within 7 days, this request will return an error. The maximum length is 50 characters, without or with an empty string to indicate no deduplication.
    ExtInfo No String Reserved field for special purposes.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The task ID for the task type Procedure, if the task flow specified by ProcedureName includes one or more of MediaProcessTask, AiAnalysisTask, AiRecognitionTask, the task specified by this parameter will be executed.
    ReviewAudioVideoTaskId String The task ID for the task type ReviewAudioVideo, if the task flow specified by ProcedureName includes ReviewAudioVideoTask, the task specified by this parameter will be executed.
    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 Initiating a task to process a video according to a specified task flow template

    This example shows you how to initiate a task flow named TranscodeAndSnapshot for the video whose fileId is 5285485487985271487.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ProcessMediaByProcedure
&FileId=5285485487985271487
&ProcedureName=TranscodeAndSnapshot
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
        "TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca",
        "ReviewAudioVideoTaskId": ""
    }
}

    5. Developer Resources

    SDK

    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 Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.FileId The FileId does not exist.
    InvalidParameterValue.ProcedureName The task flow template name is invalid.
    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.
    InvalidParameterValue.SubAppId Incorrect parameter value: subapplication ID
    InvalidParameterValue.UniqueIdentifier The deduplication ID already exists on the same day. The request is removed due to duplication.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy