调用 UpdateHighlightClipResult 接口,更新指定高光智剪任务的名称、封面,以及生成的高光片段的描述和剪辑范围。
注意事项
- 请求频率:单用户请求频率限制为 10 次/秒。
- 前提条件:
- 确保您拥有火山引擎主账号,或具备媒资库 > 视频管理 > 视频库或直播暂存 > 可编辑权限的子账号。有关如何添加子账号,详见权限管理。
- 使用子账号调用接口时,仅支持更新该子账号可见的视频所关联的高光智剪任务。有关如何配置子账号的可见范围,详见权限管理中可见范围相关内容。
请求说明
- 请求方式:POST
- 请求地址:https://livesaas.volcengineapi.com/?Action=UpdateHighlightClipResult&Version=2023-08-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
去调试请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | UpdateHighlightClipResult | 接口名称。当前 API 的名称为 UpdateHighlightClipResult。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
Body
HighlightClipVideoList
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| VideoDesc | String | 是 | 演讲者谈企业利润的用途 | 高光片段的内容描述。 |
| StartTime | Long | 是 | 2000 | 高光片段在原视频中的开始时间,单位为毫秒。 |
| EndTime | Long | 是 | 11000 | 高光片段在原视频中的结束时间,单位为毫秒。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Status | Boolean | true | 是否更新成功。成功返回 true。 |
请求示例
POST https://livesaas.volcengineapi.com/?Action=UpdateHighlightClipResult&Version=2023-08-01
{
"Id": 1,
"CoverImage": "https://p-boe-sign.bytedance.net/tos-boe-v-c1801c/o0Cqxxx",
"HighlightClipVideoList": [
{
"VideoDesc": "演讲者谈企业利润的用途",
"StartTime": 2000,
"EndTime": 11000
}
],
"Title": "Demo视频高光"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "UpdateHighlightClipResult",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"Status": true
}
}
错误码
访问公共错误码和错误码获取详细信息。