获取录制文件

编辑文档更新于 2024-11-11 06:14:32

web

描述

云端录制结束后，查询获取录制文件

云端录制的文件, 从生成后默认在 BRTC 保存 7 天, 7 天后自动删除, 请及时下载相关文件

录制文件保存命名规则

<app_id>_<room_id>_<mode>_<user_id>_<start_time>_<end_time>.flv

<app_id>:发起录制的App
<room_id>:录制的房间 id
mode :录制类型 1: 单流录制; 2: 混流录制
<user_id>:录制流的用户 id,单流录制中，该值为被录制的用户 id; 混流录制中，该值为空
<start_time>:文件开始录制时的 UTC 时间，时区为 UTC/GMT+08:0，由年、月、日、小时、分钟、秒组成，如 20210602010203
<end_time>:结束文件录制时的 UTC 时间，时区为 UTC/GMT+08:0，由年、月、日、小时、分钟、秒组成，如 20210602010203

接口请求地址

请求方式：GET
传输协议：HTTPS
调用频次限制：50 次/秒
请求 URL：

https://brtc-api.baijiayun.com/vcs/recording/stream/query

API鉴权

参见 Restful API 基本认证

请求参数

参数	类型	是否必选	描述
app_id	string	是	BRTC 给开发者分配的 appId, 唯一标识一个应用
room_id	string	是	需要录制的房间 id
start_ts	string	是	查询范围开始时间, 如 2021-07-28
end_ts	string	是	查询范围结束时间, 如 2021-08-01
page	int	否	页数, 录制文件数量过多时, 可以分多页来获取, 每页取 page_size 条, 默认值为 1
page_size	int	否	每页获取的条数, 最大值不能超过 1000, 默认值 100

请求示例

请求包体内容：

https://brtc-api.baijiayun.com/vcs/recording/stream/query
&app_id=BZ2no1v919Die6mLc2nNOGvfqcQNSfKO
&room_id=33669
&start_ts=2021-07-28
&end_ts=2021-07-28
&page=2
&page_size=20

响应参数

参数	类型	描述
code	int	错误码
msg	string	错误描述
total	int	该房间总的录制文件数
date	string	录制日期
total_size	float	录制文件大小
name	string	录制文件名称
oss_path	string	录制文件在 oss 上的地址
mode	string	录制类型 1: 单流录制 2: 混流录制
targer_user	string	录制用户 id
created_at	string	录制文件上传 oss 时间

响应示例

响应包体内容：

{
    "code": 0,
    "msg": "succeed",
    "data":{
        "total":6,
        "list":[
            {
                "date": "2021-07-28",
                "name": "string",
                "total_size": 123,
                "oss_path": "string",
                "mode": 1,
                "targer_user": "string",
                "created_at": "2021-08-02 10:20:58"
            },
            {
                "date": "2021-07-28",
                "name": "string",
                "total_size": 123,
                "oss_path": "string",
                "mode": 1,
                "targer_user": "string",
                "created_at": "2021-08-02 10:20:58"
            }
        ]
    }
}