接口描述
注意:由于该接口响应速度不理想,同时调用频率也不能太快(仅对刚结束的频道进行调用为宜),不推荐频繁使用。
推荐使用点播 API 接口进行查询:
- 根据直播流名称及时间范围查询录制文件 API SearchMedia。
- 依照视频名称前缀获取视频信息 API DescribeVodPlayInfo。
- 接口
Live_Tape_GetFilelist:用于查询某条直播流某段时间内生成的录制文件。 - 地址
API 调用地址为:http://fcgi.video.qcloud.com/common_access
。 - 说明
由于文件的落地时间对您不可知,所以这种主动查询接口在调用时机上并不是特别好掌握,更推荐使用 被动事件通知(event_type = 100)机制。
注意:
- 查询频道录制文件结果信息,包含文件 ID 和文件 URL。
- 最长查询2个月内的录制文件。
- 查询时间段须包含创建录制任务时所带的任务时间段,仅带实际录制时间查询无效。
输入参数
参数名 | 参数含义 | 类型 | 备注 | 是否必需 |
---|---|---|---|---|
appid | 客户 ID | int | 即直播 appid,用于区分不同客户的身份 | Y |
interface | 接口名称 | string | Live_Tape_GetFilelist | Y |
t | 有效时间 | int | UNIX 时间戳 | Y |
sign | 安全签名 | string | MD5(key+t) | Y |
Param.s.channel_id | 直播码 | string | - | Y |
Param.n.page_no | 分页页码 | int | 从1开始,默认为1 | N |
Param.n.page_size | 分页大小 | int | 1 - 100,默认为10 | N |
Param.s.sort_type | 排序方式 | string | asc 表示升序,desc 表示降序,默认 asc | N |
Param.s.start_time | 查询开始时间 | string | 中国标准时间,需要 UrlEncode。如:2017-01-01 10:10:01,编码为:2017-01-01+10%3a10%3a01 |
N |
Param.s.end_time | 查询结束时间 | string | 中国标准时间,需要 UrlEncode。如:2017-01-01 10:10:01,编码为:2017-01-01+10%3a10%3a01 。结束时间距开始时间一天以内,且不能跨天 |
N |
注意:有些早期提供的 API 中直播码参数被定义为 channel_id,新的 API 则称直播码为 stream_id,仅历史原因而已。
输出结果
参数名 | 参数含义 | 类型 | 备注 |
---|---|---|---|
ret | 返回码 | int | 0:成功;其他值:失败 |
message | 错误信息 | string | 错误信息 |
output | 消息内容 | object | 详情见下 |
其中 output 的主要内容为:
字段名 | 含义 | 类型 | 备注 |
---|---|---|---|
all_count | 分片总个数 | int | - |
file_list | 分片文件信息 | array | 详情见下 |
其中 file_list 的主要内容为:
字段名 | 含义 | 类型 | 备注 |
---|---|---|---|
vid | 点播的 vid | string | 如果为空,则使用 record_file_url |
start_time | 分片开始时间 | string | 由于 I 帧位置原因,并不能精确到秒 |
end_time | 分片结束时间 | string | 由于 I 帧位置原因,并不能精确到秒 |
file_id | 点播 file_id | string | 用点播 API 换取播放 URL 需要输入此参数 |
record_file_url | 播放地址 | string | 如果不为空,则使用该地址;如果为空,采用 vid,按拼接格式拼接地址 |
注意:vid 拼接格式,录制分片请求 url 格式:
http://(点播bizid).vod.myqcloud.com/(vid).f0.flv
调用示例
目标:查询直播码为 8888_test123 的直播流在整个直播过程中所录制的文件列表。
组成部分 | 示例内容 |
---|---|
接口 URL | http://fcgi.video.qcloud.com/common_access? |
appid | 1234 |
interface | Live_Tape_GetFilelist |
Param.s.channel_id | 8888_test123 |
Param.n.page_no | 1 |
Param.n.page_size | 20 |
t | 1471850187 |
sign | b17971b51ba0fe5916ddcd96692e9fb3 |
// copy时请去掉美化排版用的不可见换行符,否则可能出现 “appid is invalid” 等url拼装错误
URL = http://fcgi.video.qcloud.com/common_access?
appid=1234&interface=Live_Tape_GetFilelist
&Param.s.channel_id=8888_test123
&Param.n.page_no=1
&Param.n.page_size=20
&t=1471850187&sign=b17971b51ba0fe5916ddcd96692e9fb3
&Param.s.start_time=2017-01-01+10%3a10%3a01
&Param.s.end_time=2017-01-01+10%3a10%3a01