录制视频

接口字段

字段类型

是否必填

说明

备注

channelId

String

频道ID

三方自行生成，字符串类型，1~64位，由大小写字母、数字、下划线（_）、短划线（-）组成，需要租户下唯一，相同channelId入会会进入同一频道

appId

String

应用ID

appId申请见3.1新建应用获取应用Id和令牌

userId

String

用户ID

表示录制当前用户ID的单路视频流和其他用户音频

当modeType=0时，表示录制当前用户ID的单路视频流；

当modeType=1时，表示要混流录制的主屏幕

recordRuleId

String

录制规则ID

录制规则由ISDP系统提供，暂不对外提供配置，规则id包含的配置请参考recordRule对象

recordRuleId: 生成appid后，提供给ISDP平台，通过appId生成。

recordPath

String

存储路径

录制文件存储路径，完整路径为basePath+recordPath

如果传入此参数，文件路径参考规则recordRule配置项里的recordPath字段，且支持可变参数

callbackUrl

String

回调URL

第三方提供的回调地址

extraData

String

回调透传参数

支持最大1000位字节

fileName

String

文件名称

支持可变参数{date_time},{channel_id} 区分大小写

举例：

1、fileName = AICC_{date_time}_{channel_id}。

2、如果不传入：由系统自动生成。

文件后缀由系统自动补充。

接口字段

字段类型

是否必填

说明

备注

storageType

String

N

存储类型

可选值NAS、ISDP，默认为ISDP

NAS:适用于私有云部署场景，录制文件存储至NAS文件网络共享盘

ISDP：默认值，适用于公有云场景，使用ISDP提供的文件存储服务

当配置 storageType=NAS时，部署架构需增加NAS网络共享存储组件，适用于OP部署场景

当配置 storageType=NAS时，录制系统只负责将文件存储到NAS盘，文件播放、下载接口不再提供服务

modeType

int

Y

录制类型

0 单流， 1合流

callbackUrl

String

Y

回调地址

录制成功后调用此地址返回录制结果信息。

用户提供的以http、https开头的完整的url,例如：https://isdp-saas-sit.test.huawei.com/rest/live.video/SaaSLive/XXXXX

recordPath

String

N

存储路径

当storageType=NAS时，可用

录制文件存储路径举例：/saas/application/{app_id}/{date_time}

表示：录制的文件会存储在该路径下/saas/application/8239839232/20211119

其中：

{app_id}=8239839232 表示当前APPID

{date_time}=20211119 表示当前日期

存储路径可使用变量：

{app_id}：应用id

{date_time}：当前日期（20211119)

{channel_id}：频道ID

{file_start_time}：文件生成当前时间戳

接口字段

字段类型

是否必填

说明

备注

errorCode

int

状态码

请参考错误码为空说明成功

errorMessage

String

消息内容

SUCCESS,FAIL

timestamp

String

时间

data

Object

响应内容

见data参数

接口字段

字段类型

是否必填

说明

备注

recordingId

String

录制id