本文旨在介绍如何使用SubmitSegmentationJob - 提交拆条任务进行智能拆条,以及介绍通过GetSmartHandleJob - 获取智能任务结果获取智能拆条任务结果的返回参数。计费相关说明详见智能拆条计费说明。
注意:在此接口中,所有媒资的OSS URL中的区域(region)必须与调用OpenAPI服务地址中的区域(region)保持一致。
支持的区域:华东2(上海)、华北2(北京)、华东1(杭州)、华南1(深圳)、美国(西部)、新加坡。
使用说明
智能拆条的OpenAPI请参阅SubmitSegmentationJob - 提交拆条任务,关键参数详见下文中JobParams 参数说明、InputConfig 参数说明、OutputConfig 参数说明。
查询智能拆条任务的结果,请调用GetSmartHandleJob - 获取智能任务结果获取,任务返回结果中的关键参数详见AiResult 参数说明。
JobParams 参数说明
用户可通过配置JobParams,指定视频分镜拆条的策略。
参数 | 类型 | 说明 | 是否必填 |
Mode | String | 拆条模式,取值范围:
| 是 |
Ranges | List<Range> | 用于设置自定义拆条的时间区间 | 是 |
Range 参数说明
参数 | 类型 | 说明 | 是否必填 |
In | Float | 拆条片段开始时间,单位秒。例如:0 | 是 |
Out | Float | 拆条片段结束时间,单位秒。例如:10 | 是 |
参数示例
{
"Mode": "UserDefined",
"Media": [
{
"In": 0,
"Out": 10
},
{
"In": 20,
"Out": 30
}
]
}
InputConfig 参数说明
用户可通过配置InputConfig,指定视频素材。
参数 | 类型 | 说明 | 是否必填 |
Type | String | 媒体类型,以下类型二选一:
| 是 |
Media | String |
| 是 |
参数示例
{
"Type": "Media",
"Media": "c5c62d8f0*********12dce8e77dc6d"
}
OutputConfig 参数说明
用户可通过配置OutputConfig,指定输出地址、名称规则等合成参数。
参数 | 类型 | 说明 | 必填 | 示例 |
OutputMediaTarget | String | 输出文件的目标类型
| 否,默认oss-object | oss-object |
Endpoint | String | 满足S3协议的Endpoint
默认为同一region的oss endpoint。 | 否 | https://oss-cn-shanghai.aliyuncs.com |
Bucket | String | 满足S3协议的存储Bucket
| 否 | test-output |
ObjectKey | String | 满足S3协议的对象名 支持的占位符:
| 否 | dir/to/testOutput_{index}.mp4 |
ExportAsNewMedia | Boolean | 是否输出为新媒资 仅当OutputMediaTarget = oss-object时支持填写 | 否,默认false | false |
Width | Integer | 成片宽,单位:px。不填则和素材视频相同 | 否 | 1280 |
Height | Integer | 成片高,单位:px。不填则和素材视频相同 | 否 | 720 |
JSONObject | 输出视频流相关配置,Crf、Codec等 | 否 | { "Bitrate": 3000 } |
参数示例
{
"OutputMediaTarget": "oss-object",
"Endpoint": "https://oss-cn-shanghai.aliyuncs.com"
"Bucket": "test-output",
"ObjectKey": "dir/to/testOutput_{index}.mp4",
"ExportAsNewMedia": false,
"Width": 1280,
"Height": 720,
"Video": {
"Bitrate": 3000
}
}
GetSmartHandleJob 返回参数说明
通过GetSmartHandleJob - 获取智能任务结果获取智能拆条任务的结果,AiResult的参数说明如下:
AiResult 参数说明
{
"SegmentationResult": {
"OutputEndpoint": "http://oss-cn-shanghai.aliyuncs.com", // 满足S3协议的Endpoint
"OutputBucket": "test-output", // 满足S3协议的Bucket
"OutputObjectResults": [ // 分镜拆条后的结果
{
"ObjectKey": "testOutput_0.mp4", // 满足S3协议的对象名
"MediaId": "xxx1" // 分镜拆条后生成的媒资Id
},
{
"ObjectKey": "testOutput_0.mp4",
"MediaId": "xxx2"
}
]
}
}
相关文档
- 本页导读 (1)
- 使用说明
- JobParams 参数说明
- Range 参数说明
- 参数示例
- InputConfig 参数说明
- 参数示例
- OutputConfig 参数说明
- 参数示例
- GetSmartHandleJob 返回参数说明
- AiResult 参数说明
- 相关文档