服务端 API 文档

指定时间点截图

最近更新时间:2019-08-27 16:14:09

接口名称

CreateSnapshotByTimeOffset

注意:

本接口已不再维护,新接口 ProcessMedia 为您提供更完备的功能,请尽快迁移。

功能说明

  1. 获取视频文件在一组时间点的截图。
  2. 本接口属于异步调用,视频截图结束后,如果 App 配置了服务端事件通知,则会触发截图完成事件通知。

事件通知

文件截图成功会触发 事件通知 - 指定时间点截图完成。App 后台可通过该事件监听云点播系统中的视频截图行为。

更多请参见 服务端事件通知

请求方式

请求域名

vod.api.qcloud.com

最高调用频率

100次/分钟

参数说明

参数名称 必填 类型 说明
fileId String 文件的 FileID。
definition Integer 截图规格,请参见 指定时间点截图参数模板
timeOffset.n Integer 截图的时间戳,单位为毫秒。n从0开始递增。
COMMON_PARAMS - 请参见 公共参数

请求示例

https://vod.api.qcloud.com/v2/index.php?Action=CreateSnapshotByTimeOffset
&fileId=96000077184630899
&definition=10
&timeOffset.0=1
&timeOffset.1=20
&COMMON_PARAMS

接口应答

参数说明

参数名称 类型 说明
code Integer 错误码,0:成功;其他值:失败。
message String 错误信息。
vodTaskId String 任务 ID。

错误码说明

错误码 含义说明
4000 - 7000 请参见 公共错误码
1 内部错误。
1000 无效参数。
1108 内部错误。
1152 内部错误。
1801 内部错误。
1802 内部错误。
2000 内部错误。
2001 内部错误。
10009 文件状态异常。
10010 内部错误。
10012 内部错误。

应答示例

{
    "code": 0,
    "message": "",
    "vodTaskId": ""
}
目录