混流录制

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

描述

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

接口请求地址

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

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

API鉴权

参见 Restful API 基本认证

请求参数

参数	类型	是否必选	描述
app_id	string	是	BRTC 给开发者分配的 appId, 唯一标识一个应用
room_id	string	是	录制的房间 id
task_id	string	是	录制任务 id
publish_cdn	json	否	混流推流信息
record_output_params	json	否	输出文件参数
storage_params	json	否	录制任务的存储配置
comments	string	否	透传数据, 便于客户标识某些业务, 字段不能超过 4k(4096) 个字符

record_output_params 成员

参数	类型	是否必选	描述
output_file_format	string	否	输出文件格式，默认为 flv , 可选 flv、mp4
output_folder	string	否	录制文件在第三方云存储的输出目录

storage_params 成员

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

请求示例

请求包体内容：

{
    "app_id": "BZ2no1v919Die6mLc2nNOGvfqcQNSfKO",
    "room_id": "33669",
    "task_id": "33669@BZ2no1v919Die6mLc2nNOGvfqcQNSfKO",
    "publish_cdn":{
        "url": "string"
    },
    "record_output_params": {
        "output_file_format": "flv"
    },
    "storage_params": {
        "vendor": 1,
        "endpoint": "oss-xxxx",
        "bucket": "xxxx",
        "access_key_id": "xxxx",
        "access_key_secret": "xxxx"
    },
    "comments": "key:1223"
}

响应参数

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

响应示例

响应包体内容：

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