1. 接口描述
接口请求域名: cme.tencentcloudapi.com 。
使用 视频合成协议 合成视频,支持导出视频到 CME 云媒资或者云点播媒资。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ExportVideoByEditorTrackData。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Platform | 是 | String | 平台 Id,指定访问的平台。关于平台概念,请参见文档 平台。 示例值:1000000009 |
Definition | 是 | Integer | 导出视频预设配置 Id,推荐优先使用下面的默认预设配置 Id,有其他需求可通过接口定制预设配置。 示例值:10 |
ExportDestination | 是 | String | 导出目标,指定导出视频的目标媒资库,可取值有: 示例值:VOD |
TrackData | 是 | String | 轨道数据,用于描述待导出视频的内容。关于轨道数据的格式请查看 视频合成协议。文档中也描述了如何在页面上查看一个剪辑项目的轨道数据,该能力可以帮助开发者更方便地构造自己的轨道数据。 |
AspectRatio | 否 | String | 轨道数据对应的画布宽高比,配合预设配置中的视频短边尺寸,可决定导出画面的尺寸。例: 示例值:16:9 |
CoverData | 否 | String | 视频封面图片文件(如 jpeg, png 等)进行 Base64 编码后的字符串,仅支持 gif、jpeg、png 三种图片格式,原图片文件不能超过2 M大 小。 |
CMEExportInfo | 否 | CMEExportInfo | 导出的多媒体创作引擎媒体信息。当导出目标为 CME 时必填。 |
VODExportInfo | 否 | VODExportInfo | 导出的云点播媒资信息。当导出目标为 VOD 时必填。 |
ExportExtensionArgs | 否 | VideoExportExtensionArgs | 视频导出扩展参数。可以覆盖导出模板中的参数,灵活的指定导出规格及参数。 |
Operator | 否 | String | 操作者。如不填,默认为 cmeid_system ,表示平台管理员操作,无权限限制。如果指定操作者,轨道数据中使用的媒资该操作者需要拥有使用权限。示例值:9b92a8e7-a5ef-4e28-d72e-4eff571fabf0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务 Id。 示例值:125009388839-tfusion-0a54392053f84053942f9308c49404d7 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用视频编辑轨道数据导出视频到云点播
使用视频编辑轨道数据导出视频到云点播,并指定操作者。
输入示例
POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportVideoByEditorTrackData
<公共请求参数>
{
"Platform": "1000000009",
"Definition": 10,
"ExportDestination": "VOD",
"TrackData": "{\"id\":\"baa03b1c-6773-4459-a7b3-7f1e8b9e5b56\",\"type\":\"video\",\"items\":[{\"id\":\"f244311c-ca04-447a-b49a-1226356d46ba\",\"start_time\":0,\"duration\":3000,\"type\":\"image\",\"asset_id\":\"6503fd9d17509729a6100011\",\"filter_asset_id\":\"\",\"operations\":[{\"type\":\"image_rotate\",\"params\":{\"angle\":0}}],\"width\":540,\"height\":540,\"position\":{\"x\":480,\"y\":300},\"section\":{\"from\":0,\"to\":3000}}]}",
"VODExportInfo": {
"Name": "在线编辑视频",
"ClassId": 10
},
"ExportExtensionArgs": {
"FrameRate": 30
},
"Operator": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0"
}
输出示例
{
"Response": {
"TaskId": "1250093889-tfusion-0a54392053f84053942f9308c49404d7",
"RequestId": "0a543920-53f8-4053-942f-9308c49404d7"
}
}
示例2 使用视频编辑轨道数据导出视频到云点播并发布到企鹅号
使用视频编辑轨道数据导出视频到云点播,并将导出的视频发布到企鹅号。
输入示例
POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportVideoByEditorTrackData
<公共请求参数>
{
"Platform": "1000000009",
"Definition": 10,
"ExportDestination": "VOD",
"TrackData": "{\"id\":\"baa03b1c-6773-4459-a7b3-7f1e8b9e5b56\",\"type\":\"video\",\"items\":[{\"id\":\"f244311c-ca04-447a-b49a-1226356d46ba\",\"start_time\":0,\"duration\":3000,\"type\":\"image\",\"asset_id\":\"6503fd9d17509729a6100011\",\"filter_asset_id\":\"\",\"operations\":[{\"type\":\"image_rotate\",\"params\":{\"angle\":0}}],\"width\":540,\"height\":540,\"position\":{\"x\":480,\"y\":300},\"section\":{\"from\":0,\"to\":3000}}]}",
"AspectRatio": "16:9",
"VODExportInfo": {
"Name": "在线编辑视频",
"ClassId": 10,
"ThirdPartyPublishInfos": [
{
"ChannelMaterialId": "5fd8ad3d628dc30001bd0895",
"PenguinMediaPlatformPublishInfo": {
"Title": "企鹅视频",
"Description": "新闻",
"Tags": [
"娱乐"
],
"Category": 100
}
}
]
},
"Operator": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0"
}
输出示例
{
"Response": {
"TaskId": "e86c730b-97c8-4e7d-b4a1-f5b28291e2b3",
"RequestId": "181xxxxxx01-FusionCME-c85bf7f3b9b4c594fbd558800a6fecb7t"
}
}
示例3 使用视频编辑轨道数据导出视频到多媒体创作引擎媒资库
使用视频编辑轨道数据导出视频到多媒体创作引擎媒资库。
输入示例
POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportVideoByEditorTrackData
<公共请求参数>
{
"Platform": "1000000009",
"Definition": 1,
"ExportDestination": "CME",
"AspectRatio": "16:9",
"TrackData": "{\"id\":\"baa03b1c-6773-4459-a7b3-7f1e8b9e5b56\",\"type\":\"video\",\"items\":[{\"id\":\"f244311c-ca04-447a-b49a-1226356d46ba\",\"start_time\":0,\"duration\":3000,\"type\":\"image\",\"asset_id\":\"6503fd9d17509729a6100011\",\"filter_asset_id\":\"\",\"operations\":[{\"type\":\"image_rotate\",\"params\":{\"angle\":0}}],\"width\":540,\"height\":540,\"position\":{\"x\":480,\"y\":300},\"section\":{\"from\":0,\"to\":3000}}]}",
"CMEExportInfo": {
"Owner": {
"Type": "PERSON",
"Id": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0"
},
"Name": "新建项目",
"ClassPath": "/成片"
},
"Operator": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0"
}
输出示例
{
"Response": {
"RequestId": "e86c730b-97c8-4e7d-b4a1-f5b28291e2b3",
"TaskId": "181xxxxxx01-FusionCME-c85bf7f3b9b4c594fbd558800a6fecb5t"
}
}
示例4 使用视频编辑轨道数据导出视频到云点播并指定导出视频宽高比
使用视频编辑轨道数据导出视频到云点播,同时指定导出视频宽高比且指定操作者。
输入示例
POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportVideoByEditorTrackData
<公共请求参数>
{
"Platform": "1000000009",
"Definition": 10,
"ExportDestination": "VOD",
"AspectRatio": "16:9",
"TrackData": "{\"id\":\"baa03b1c-6773-4459-a7b3-7f1e8b9e5b56\",\"type\":\"video\",\"items\":[{\"id\":\"f244311c-ca04-447a-b49a-1226356d46ba\",\"start_time\":0,\"duration\":3000,\"type\":\"image\",\"asset_id\":\"6503fd9d17509729a6100011\",\"filter_asset_id\":\"\",\"operations\":[{\"type\":\"image_rotate\",\"params\":{\"angle\":0}}],\"width\":540,\"height\":540,\"position\":{\"x\":480,\"y\":300},\"section\":{\"from\":0,\"to\":3000}}]}",
"VODExportInfo": {
"Name": "在线编辑视频",
"ClassId": 10
},
"Operator": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0"
}
输出示例
{
"Response": {
"TaskId": "181xxxxxx01-FusionCME-c85bf7f3b9b4c594fbd558800a6fecb5t",
"RequestId": "e86c730b-97c8-4e7d-b4a1-f5b28291e2b3"
}
}
示例5 使用视频编辑轨道数据导出视频到多媒体创作引擎媒资库并发布到企鹅号
使用视频编辑轨道数据导出视频到多媒体创作引擎媒资库并发布到企鹅号。
输入示例
POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportVideoByEditorTrackData
<公共请求参数>
{
"Platform": "1000000009",
"Definition": 1,
"ExportDestination": "CME",
"AspectRatio": "16:9",
"TrackData": "{\"id\":\"baa03b1c-6773-4459-a7b3-7f1e8b9e5b56\",\"type\":\"video\",\"items\":[{\"id\":\"f244311c-ca04-447a-b49a-1226356d46ba\",\"start_time\":0,\"duration\":3000,\"type\":\"image\",\"asset_id\":\"6503fd9d17509729a6100011\",\"filter_asset_id\":\"\",\"operations\":[{\"type\":\"image_rotate\",\"params\":{\"angle\":0}}],\"width\":540,\"height\":540,\"position\":{\"x\":480,\"y\":300},\"section\":{\"from\":0,\"to\":3000}}]}",
"CMEExportInfo": {
"Owner": {
"Type": "PERSON",
"Id": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0"
},
"Name": "新建项目",
"ClassPath": "/成片",
"ThirdPartyPublishInfos": [
{
"ChannelMaterialId": "5fd8ad3d628dc30001bd0895",
"PenguinMediaPlatformPublishInfo": {
"Title": "企鹅视频",
"Description": "新闻",
"Tags": [
"娱乐"
],
"Category": 100
}
}
]
},
"Operator": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0"
}
输出示例
{
"Response": {
"RequestId": "e86c730b-97c8-4e7d-b4a1-f5b28291e2b3",
"TaskId": "181xxxxxx01-FusionCME-c82bf7f3b9b4c594fbd558800a6fe7c5t"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.CreateTask | 发起预处理任务失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Platform | 平台参数非法。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Definition | 模板 ID 无效。 |
InvalidParameterValue.ExportDestination | 导出目标不合法。 |
InvalidParameterValue.MaterialId | 媒体 ID 无效。 |
InvalidParameterValue.Platform | 平台参数取值错误。 |
InvalidParameterValue.ThirdyPartyPublishChannelId | 发布通道 ID 无效。 |
InvalidParameterValue.TrackData | 轨道数据无效。 |
InvalidParameterValue.VodSubAppid | 绑定的点播子应用无效。 |
LimitExceeded.BillItemStorage | 存储空间不足,请查看会员权益,购买资源包或会员版本后继续使用。 |
LimitExceeded.BillItemVideoEditExportDuration | 您已达到导出视频时长上限,若还需使用,请升级会员版本或购买资源包。 |
OperationDenied.PermissionDeny | 权限不足,请检查对应操作者的权限。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Platform | 平台不存在。 |
UnauthorizedOperation | 未授权操作。 |