1. 接口描述
接口请求域名: cme.tencentcloudapi.com 。
使用视频剪辑模板直接导出视频。
默认接口请求频率限制:20次/秒。
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 |
必选 |
类型 |
描述 |
Action |
是 |
String |
公共参数,本接口取值:ExportVideoByTemplate。 |
Version |
是 |
String |
公共参数,本接口取值:2019-10-29。 |
Region |
否 |
String |
公共参数,本接口不需要传递此参数。 |
Platform |
是 |
String |
平台 Id,指定访问的平台。关于平台概念,请参见文档 平台。 示例值:1000000009 |
TemplateId |
是 |
String |
视频编辑模板 Id。 示例值:60097a8a8ea83d00017b484b |
Definition |
是 |
Integer |
导出视频预设配置 Id,推荐优先使用下面的默认预设配置 Id,有其他需求可通过接口定制预设配置。 10:分辨率为 480P,输出视频格式为 MP4;11:分辨率为 720P,输出视频格式为 MP4;12:分辨率为 1080P,输出视频格式为 MP4。 示例值:10 |
ExportDestination |
是 |
String |
导出目标,指定导出视频的目标媒资库,可取值有: CME:多媒体创作引擎,即导出为多媒体创作引擎媒资库,此导出目标在云点播媒资库依然可见;VOD:云点播,即导出为云点播媒资库,此导出目标在多媒体创作引擎媒资库将不可见。 示例值:VOD |
SlotReplacements.N |
否 |
Array of SlotReplacementInfo |
需要替换的素材信息。 |
CMEExportInfo |
否 |
CMEExportInfo |
导出的多媒体创作引擎媒资信息。当导出目标为 CME 时必填。 |
VODExportInfo |
否 |
VODExportInfo |
导出的云点播媒资信息。当导出目标为 VOD 时必填。 |
ExportExtensionArgs |
否 |
VideoExportExtensionArgs |
视频导出扩展参数。可以覆盖导出模板中的参数,灵活的指定导出规格及参数。 |
Operator |
否 |
String |
操作者。如不填,默认为 cmeid_system ,表示平台管理员操作,无权限限制。如果指定操作者,则操作者需要有替换媒体及剪辑模板的权限。 示例值:60097a8a8ea83d00017b484b |
3. 输出参数
参数名称 |
类型 |
描述 |
TaskId |
String |
导出任务 Id。 示例值:1250000000-tfusion-32f87637061242508eb10d6e4ecd0cd6 |
RequestId |
String |
唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用剪辑模板导出视频到云点播
输入示例
https://cme.tencentcloudapi.com/?Action=ExportVideoByTemplate
&Platform=1000000009
&TemplateId=60498a50adaf8f000164a07b@prod@12500000
&SlotReplacements.0.Id=1
&SlotReplacements.0.ReplacementType=VIDEO
&SlotReplacements.0.MediaReplacementInfo.MediaType=CMEMaterialId
&SlotReplacements.0.MediaReplacementInfo.MaterialId=5fc4ad7f69ec74000179072345
&SlotReplacements.0.MediaReplacementInfo.StartTimeOffset=0
&Definition=10
&ExportDestination=VOD
&VODExportInfo.Name=测试视频
&VODExportInfo.ClassId=10000
&Operator=user_id_9394392053f8405394299d8
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": "1250000000-tfusion-32f87637061242508eb10d6e4ecd0cd6",
"RequestId": "0b480791-97d7-4e4a-8740-e2128b871df6"
}
}
示例2 使用剪辑模板导出视频到多媒体创作引擎媒资
输入示例
POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportVideoByTemplate
<公共请求参数>
{
"Platform": "1000000009",
"TemplateId": "60498a50adaf8f000164a07b@prod@12500000",
"SlotReplacements": [
{
"Id": 1,
"ReplacementType": "IMAGE",
"MediaReplacementInfo": {
"MediaType": "CMEMaterialId",
"MaterialId": "becff2c5e7d77a9e0353"
}
}
],
"Definition": 10,
"ExportDestination": "CME",
"CMEExportInfo": {
"Owner": {
"Type": "PERSON",
"Id": "1a69f09d-1a28-4437-a71a"
},
"Name": "模版测试1009",
"ClassPath": "/媒资"
},
"ExportExtensionArgs": {
"VideoBitrate": 102400,
"FrameRate": 30
},
"Operator": "user_id_9394392053f8405394299d8"
}
输出示例
{
"Response": {
"TaskId": "1250000000-tfusion-32f87637061242508eb10d6e4ecd0cd7",
"RequestId": "323d0791-97d7-4e4a-8740-e2128b031df7"
}
}
示例3 使用剪辑模板导出视频到云点播并发布到企鹅号
输入示例
https://cme.tencentcloudapi.com/?Action=ExportVideoByTemplate
&Platform=1000000009
&TemplateId=60498a50adaf8f000164a07b@prod@12500000
&SlotReplacements.0.Id=1
&SlotReplacements.0.ReplacementType=VIDEO
&SlotReplacements.0.MediaReplacementInfo.MediaType=CMEMaterialId
&SlotReplacements.0.MediaReplacementInfo.MaterialId=5fc4ad7f69ec74000179072345
&SlotReplacements.0.MediaReplacementInfo.StartTimeOffset=0
&Definition=10
&ExportDestination=VOD
&VODExportInfo.Name=测试视频
&VODExportInfo.ClassId=10000
&VODExportInfo.ThirdPartyPublishInfos.0.ChannelMaterialId=5fd8ad3d628dc30001bd0895
&VODExportInfo.ThirdPartyPublishInfos.0.PenguinMediaPlatformPublishInfo.Title=企鹅视频
&VODExportInfo.ThirdPartyPublishInfos.0.PenguinMediaPlatformPublishInfo.Description=新闻
&VODExportInfo.ThirdPartyPublishInfos.0.PenguinMediaPlatformPublishInfo.Tags.0=娱乐
&VODExportInfo.ThirdPartyPublishInfos.0.PenguinMediaPlatformPublishInfo.Category=100
&Operator=user_id_9394392053f8405394299d8
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": "1250000000-tfusion-32f87637061242508eb10d6e4ecd0cd8",
"RequestId": "323d0791-97d7-4e4a-8740-e2128b031df8"
}
}
示例4 使用剪辑模板导出视频到多媒体创作引擎媒资并发布到企鹅号
输入示例
https://cme.tencentcloudapi.com/?Action=ExportVideoByTemplate
&Platform=1000000009
&TemplateId=60498a50adaf8f000164a07b@prod@12500000
&SlotReplacements.0.Id=1
&SlotReplacements.0.ReplacementType=VIDEO
&SlotReplacements.0.MediaReplacementInfo.MediaType=CMEMaterialId
&SlotReplacements.0.MediaReplacementInfo.MaterialId=5fc4ad7f69ec74000179072345
&SlotReplacements.0.MediaReplacementInfo.StartTimeOffset=0
&Definition=10
&ExportDestination=CME
&CMEExportInfo.Owner.Type=PERSION
&CMEExportInfo.Owner.Id=119993993939390
&CMEExportInfo.Name=测试视频
&CMEExportInfo.ClassPath=/成片
&CMEExportInfo.ThirdPartyPublishInfos.0.ChannelMaterialId=5fd8ad3d628dc30001bd0895
&CMEExportInfo.ThirdPartyPublishInfos.0.PenguinMediaPlatformPublishInfo.Title=企鹅视频
&CMEExportInfo.ThirdPartyPublishInfos.0.PenguinMediaPlatformPublishInfo.Description=新闻
&CMEExportInfo.ThirdPartyPublishInfos.0.PenguinMediaPlatformPublishInfo.Tags.0=娱乐
&CMEExportInfo.ThirdPartyPublishInfos.0.PenguinMediaPlatformPublishInfo.Category=100
&Operator=user_id_9394392053f8405394299d8
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": "1250000000-tfusion-32f87637061242508eb10d6e4ecd0cd8",
"RequestId": "89dle791-97d7-4e4a-8740-e2128b038ad9"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 |
描述 |
AuthFailure |
CAM签名/鉴权错误。 |
FailedOperation |
操作失败。 |
InternalError |
内部错误。 |
InternalError.CreateTask |
发起预处理任务失败。 |
InvalidParameter |
参数错误。 |
InvalidParameter.Platform |
平台参数非法。 |
InvalidParameterValue.ClassPath |
分类路径不合法。 |
InvalidParameterValue.Definition |
模板 ID 无效。 |
InvalidParameterValue.ExportDestination |
导出目标不合法。 |
InvalidParameterValue.MaterialId |
媒体 ID 无效。 |
InvalidParameterValue.MediaReplacementInfo |
媒体替换信息无效。 |
InvalidParameterValue.Platform |
平台参数取值错误。 |
InvalidParameterValue.ReplacementType |
轨道素材替换类型无效或不匹配。 |
InvalidParameterValue.TrackData |
轨道数据无效。 |
InvalidParameterValue.VideoEditTemplateIdNotExist |
视频编辑模板不存在。 |
LimitExceeded |
超过配额限制。 |
LimitExceeded.BillItemStorage |
存储空间不足,请查看会员权益,购买资源包或会员版本后继续使用。 |
LimitExceeded.BillItemVideoEditExportDuration |
您已达到导出视频时长上限,若还需使用,请升级会员版本或购买资源包。 |
OperationDenied.PermissionDeny |
权限不足,请检查对应操作者的权限。 |
ResourceNotFound |
资源不存在。 |
ResourceNotFound.Platform |
平台不存在。 |