提交剪辑任务--视频点播-火山引擎

文档中心

立即注册

导航

提交剪辑任务

最近更新时间：2024.06.20 19:49:34首次发布时间：2022.03.03 12:45:34

此接口用于设置任务产物的上传空间、具体的视频剪辑等参数后，提交视频剪辑任务。

使用说明

提交剪辑任务后，您可通过以下方式获取视频剪辑任务相关信息：

调用 GetDirectEditProgress 查询视频剪辑任务进度。
调用 GetDirectEditResult 查询视频剪辑任务详情。
调用 CancelDirectEditTask 取消视频剪辑任务。
配置视频剪辑完成事件回调，详见回调设置。

注意事项

计费说明：视频剪辑计费价格请参见按量计费。
提交剪辑任务前，请确保您的空间已绑定点播 CDN 域名。

请求说明

请求方式：POST
请求地址：https://vod.volcengineapi.com?Action=SubmitDirectEditTaskAsync&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`SubmitDirectEditTaskAsync`	接口名称。当前 API 的名称为 `SubmitDirectEditTaskAsync`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数	类型	是否必选	示例值	描述
Uploader	String	是	`edit_tob`	任务产物的上传空间。视频剪辑任务完成后输出的产物会被上传至此空间。
Application	String	是	`VideoTrackToB`	剪辑任务类型。当前仅支持设为 `VideoTrackToB`。
EditParam	JSONMap	是	`-`	详见视频剪辑参数。
Priority	Integer	否	`0`	剪辑任务优先级，默认为 0。优先级越高，任务将会越快被执行。
CallbackArgs	String	否	`YourCallbackArgs`	可自定义的字段，回调时会透传返回。长度限制为 64 KB。说明如您设置的自定义字段大小超过 100B，请提交工单联系技术支持特定配置。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ReqId	String	`3b5fece1a47******443a6aeea5abc`	异步剪辑任务 ID

请求示例

POST https://vod.volcengineapi.com?Action=SubmitDirectEditTaskAsync&Version=2018-01-01
{
    "Application": "VideoTrackToB",
    "CallbackArgs": "",
    "Uploader":"edit_tob",
    "CreateAt": "2022-02-28T16:38:49+08:00",
    "EditParam": {
        "Canvas": {
            "Height": 2160,
            "Width": 3840
        },
        "Output": {
            "Alpha": false,
            "Codec": {
                "AudioBitrate": 128,
                "AudioCodec": "aac",
                "Crf": 23,
                "Preset": "slow",
                "VideoCodec": "h264"
            },
            "DisableAudio": false,
            "DisableVideo": false,
            "Fps": 30
        },
        "Track": [
            [
                {
                    "TargetTime": [
                        0,
                        195000
                    ],
                    "Type": "video"
                }
            ],
        ],
        "Upload": {
            "SpaceName": "edit_tob",
            "VideoName": "编辑测试项目 2022年8月28日"
            "FileName":"demo/.mp4"
        },
        "Uploader":"edit_tob"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220228******09170404E144",
        "Action": "SubmitDirectEditTaskAsync",
        "Version": "2018-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "ReqId": "3b5fece1a47******443a6aeea5abc"
    }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码	错误码	错误信息	说明
500	1000	-	内部错误
500	1001	-	数据库写入错误
400	1010	-	参数错误
500	1014	-	下游服务错误

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：