页面录制

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

描述

调用本接口开始云端录制
成功调用 start 方法后, 开启页面录制服务

接口请求地址

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

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

API鉴权

参见 Restful API 基本认证

请求参数

参数	类型	是否必选	描述
app_id	string	是	BRTC 给开发者分配的 appId, 唯一标识一个应用
room_id	string	是	录制的房间 id
input_params	object	是	录制任务的输入参数
publish_cdn	json	否	推流信息，如果要同时推流到第三方平台，需要传这个参数
storage_params	json	否	存储设置，如果需要存储到客户自己定制的OSS中，可传这个参数
record_output_params	json	否	输出文件参数

input_params 成员

参数	类型	是否必选	描述
input_url	string	是	页面录制地址
page_info	object	是	页面信息
video	object	是	视频参数

record_output_params 成员

参数	类型	是否必选	描述
output_file_format	string	否	输出文件格式，默认为 `flv` , 可选: `flv`/`mp4`
output_folder	string	否	录制文件在第三方云存储的输出目录, 请注意每个房间应该有独立的存储目录，同一个目录下如果录制了多段视频，这些视频最终会被拼接在一起

特别说明： output_folder 如果指定的话，不同的房间号一定要指定不同的目录，因为相同目录下的多段视频会拼接到一起，这样是为了实现多段录制自动合并的功能。

例如：在一节课中，老师可能录制了 3 个视频（中间休息过 2 次），如果调用方希望最终这 3 个视频合并成一个，那么就指定相同的 output_folder ，例如用课堂号做为 output_folder 的一部分。

如果调用方希望保留原来的 3 个视频，不要做合并，那么就每次调用都指定一个不同的 output_folder，可以每次调用时用房间号 + 时间戳做这个目录的一部分。

如果不同的房间都指定了同一个 output_folder，那么不同的房间号录制的视频都会合并到一起，这应该不是调用方期望的结果。

storage_params 成员

参数	类型	是否必选	描述
vendor	int	是	录制文件存储服务提供商，目前只支持的存储服务提供商如下: 1: 阿里云 OSS 2: 腾讯云 COS
endpoint	string	是	云存储指定的地区信息（阿里云传 endpoint，如：oss-cn-beijing.aliyuncs.com，腾讯云传地区信息，如：beijing，不要带 `ap-` 前缀）
bucket	string	是	云存储 bucket
access_key_id	string	是	云存储的 key, 建议提供只写权限的访问密钥
access_key_secret	string	是	云存储的 secret

请求示例

请求包体内容：

{
    "app_id":"YG1*******Gfd8e",
    "room_id":"789789",
    "input_params":{
        "input_url":"https://www.bilibili.com/video/BV1DZ4y1a7fD?spm_id_from=333.851.b_7265636f6d6d656e64.2",
        "page_info":{
            "width":1920,
            "height":1080
        },
        "video":{
            "size":"1280x720",
            "fps":15
        }
    },
    "publish_cdn":{
        "url":"rtmp://push*****.xxxx.com/live/bili789789"
    },
    "record_output_params": {
        "output_file_format": "mp4",
        "output_folder": "brtc-record/789789-20240423161300"
    },
    "storage_params": {
        "bucket": "bmcu-test-1256241101",
        "access_key_id": "A********ID",
        "endpoint": "beijing",
        "vendor": 2,
        "access_key_secret": "A********T"
    }
}

注：如果是 aliyun，endpoint需要传的形式如： oss-cn-beijing.aliyuncs.com

响应参数

参数	类型	描述
code	int	错误码
msg	string	描述

响应示例

响应包体内容：

{
    "code": 200,
    "data": {},
    "msg": "succeed"
}