本文旨在介绍在智能图文匹配成片-体育赛事集锦场景下的合成参数、SDK调用示例。
注意:在此接口中,所有媒资的OSS URL中的区域(region)必须与调用OpenAPI服务地址中的区域(region)保持一致。
支持的区域:华东2(上海)。
在实际使用过程中,请将文档所有参数示例中的 [your-bucket]、[your-region-id]、[your-file-name]、[your-file-path]、媒资ID(例如:“****9d46c8b4548681030f6e****”)等参数替换为您的实际值。
为了更好地阅读本文,建议您在阅读本文之前先通过智能一键成片操作指南了解【智能图文匹配成片-体育赛事集锦】相关的概念与使用流程。
使用说明
将完整体育赛事视频进行智能混剪,一键批量合成视频接口说明,请参见SubmitSportsHighlightsJob - 提交体育集锦任务,API关键参数详见下文InputConfig 参数说明、OutputConfig 参数说明。
获取批量智能一键成片作业的详细信息,请参见GetBatchMediaProducingJob - 获取批量智能一键成片任务信息。
InputConfig 参数说明
用户可通过配置InputConfig,指定视频素材、口播、背景音乐、贴纸等基础素材的参数配置。
参数 | 类型 | 说明 | 示例值 | 是否必填 |
SportsCategory | String | 体育赛事类型 篮球:basketball 乒乓球:pingpong | basketball | 是 |
InputMedia | String | 输入的体育赛事素材。支持MediaId 或 MediaURL
| ****9d46c8b4548681030f6e**** | 是 |
FaceRegister | List<FaceInfo> | 人物标识,数组长度小于等于5。 | 详见参数示例 | 否 |
SlowMotionLogoRegister | 慢镜头标识。如果成片中需包含慢镜头,需提供源片中慢镜头之前出现的logo标识信息。数组长度小于等于5。 | 详见参数示例 | 否 | |
TransferNameRegister | List<TransferNameInfo> | 名称转写标识,将记分牌中的队名缩写转写为完整队名。数组长度小于等于10。 | 详见参数示例 | 是 |
FaceInfo 参数说明
字段 | 类型 | 描述 | 示例值 | 必填 |
FaceUrls | List<String> |
| ["http://[your-bucket].oss-[your-region-id].aliyuncs.com/test1.png","http://[your-bucket].oss-[your-region-id].aliyuncs.com/test1.png""] | 是 |
Name | String | 人物名称,必须与输入视频中记分牌显示的人名一致 | 张三 | 是 |
SlowMotionLogoRegister 参数说明
字段 | 类型 | 描述 | 示例值 | 必填 |
SlowMotionLogoUrls | List<String> |
| ["http://[your-bucket].oss-[your-region-id].aliyuncs.com/test1.png","http://[your-bucket].oss-[your-region-id].aliyuncs.com/test1.png""] | 是 |
TransferNameInfo 参数说明
字段 | 类型 | 描述 | 示例值 | 必填 |
OriginalName | String | 赛事记分牌中的队名缩写 | Rockets | 是 |
TransferName | String | 完整队名 | Houston Rockets | 是 |
参数示例
{
"SportsCategory": "Basketball",
"InputMedia": "http://[your-bucket].oss-[your-region-id].aliyuncs.com/[your-file-path]/[your-file-name]_{index}.mp4",
"FaceRegister": [
{
"FaceUrls": ["http://testcdn.com/front.jpg", "http://testcdn.com/side.jpg"],
"Name": "James"
}
],
"SlowMotionLogoRegister": {
"SlowMotionLogoUrls": ["http://testcdn.com/logo1.jpg", "http://testcdn.com/logo2.jpg"]
},
"TransferNameRegister": [
{
"OriginalName": "IND",
"TransferName": "印第安纳步行者"
}
]
}
EditingConfig 参数说明
暂不支持配置EditingConfig相关参数
OutputConfig 参数说明
用户可通过配置OutputConfig,指定成片输出地址、名称规则、成片的宽高、输出成片数量等合成参数配置。
参数 | 类型 | 说明 | 示例值 | 必填 |
MediaURL | String | 输出视频地址,必须要有占位符{index}。 | 规则:http://[your-bucket].oss-[your-region-id].aliyuncs.com/[your-file-path]/[your-file-name]_{index}.mp4 示例:http://example.oss-cn-shanghai.aliyuncs.com/example/example_{index}.mp4 | 当GeneratePreviewOnly=true时,且成片输出到OSS时必填 |
StorageLocation | String | 指定输出到VOD的媒资文件存储地址。 | 规则:[your-vod-bucket].oss-[your-region-id].aliyuncs.com 示例:outin-****6c886b4549d481030f6e****.oss-cn-shanghai.aliyuncs.com | 当GeneratePreviewOnly=true时,且成片输出到VOD时必填 |
FileName | String | 输出文件名称,必须要有占位符{index}。 | 规则:[your-file-name]__{index}.mp4 示例:example_{index}.mp4 | 当GeneratePreviewOnly=true时,且成片输出到VOD时必填 |
GeneratePreviewOnly | Boolean |
| false | 否,默认false |
Count | Integer | 输出视频数,当前支持Count=1,后续可能支持输出多个视频。 | 1 | 否,默认1 |
Width | Integer | 成片宽,px | 1080 | 是 |
Height | Integer | 成片高,px | 1920 | 是 |
JSONObject | 输出视频流相关配置,Crf、Codec等 | {"Crf": 27} | 否 |
参数示例
{
"MediaURL": "http://[your-bucket].oss-[your-region-id].aliyuncs.com/xxx_{index}.mp4",
"Count": 1,
"Width": 1080,
"Height": 1920,
"Video": {"Crf": 27},
"GeneratePreviewOnly":false
}
SDK调用示例
前提条件
您已安装IMS服务端SDK,详情请参见准备工作。
代码示例
API调用入参详情
结果示例
体育赛事集锦成片
处理逻辑
根据SportsCategory判断体育赛事类型:篮球-basketball、乒乓球-pingpong。
通过人物标识参数FaceRegister,来设置成片结果中需要出现的运动员镜头。
通过慢镜头标识参数SlowMotionLogoRegister,来设置成片结果中需要包含的慢镜头回放。
通过名称转写设置参数TransferNameRegister,将记分牌中的队名缩写转写为完整队名。
相关文档
- 本页导读 (1)
- 使用说明
- InputConfig 参数说明
- FaceInfo 参数说明
- SlowMotionLogoRegister 参数说明
- TransferNameInfo 参数说明
- 参数示例
- EditingConfig 参数说明
- OutputConfig 参数说明
- 参数示例
- SDK调用示例
- 前提条件
- 代码示例
- 结果示例
- 处理逻辑
- 相关文档