文档反馈
文档反馈

云端录制

重要通知

网易云信新版文档中心现已正式上线!

音视频通话2.0互动直播2.0多人语音聊天室PK 直播等产品和场景方案已迁移至新版文档中心维护,欢迎体验!

调用接口开始或关闭云端录制。通过服务端接口实现云端录制时,可以设置音视频通话全局的录制相关参数。例如设置录制模式为单流录制模式,对房间内所有成员生效。

使用云端录制功能之前,请参考云端录制概述,了解云端录制功能,并联系网易云信商务经理开通云端录制功能和网易云信点播服务。该功能涉及资源计费,请确认您已了解相关的计费规则。

注意

URL

URL 中参数说明:

参数名称 类型 是否必选 示例 描述
cid int64 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。

请求参数

参数名称 类型 是否必选 示例 描述
cid int64 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。
a_record Boolean 必选 true 房间音频录制开关。开启后,该房间的所有音频信息均会被录制。可设置为:
  • true:开启音频录制。
  • false:关闭音频录制。
v_record Boolean 必选 true 房间视频录制开关。开启后,该房间的所有视频信息均会被录制。可设置为:
  • true:开启视频录制。
  • false:关闭视频录制。
type int 可选 0 录制模式。录制模式的详细说明请参考录制模式
可设置为:
  • 0:合流+单流录制。
  • 1:合流录制。
  • 2:单流录制。
uid int64 可选 123 录制时,主讲人的用户 ID。仅在录制布局为主讲人模式时生效。录制布局的详细说明请参考录制布局
enableSpamDetect Boolean 可选 true 是否开启云端录制文件内容安全审核。
  • true:开启。
  • false:(默认)关闭。
scFrequency Integer 可选 10 截图检测频率,取值范围为 1 ~ 60 秒。
默认5 秒截图检测一次。
detectTyp Integer 可选 0 检测类型。
  • 0:(默认)视频与音频同时检测。
  • 1:仅检测视频。

返回参数

Body 中不返回任何参数。

示例

请求示例

{   
    "a_record": true,              
    "v_record": true,               
    "type" : 0,                       
    "uid" : 123                        
}

正常返回示例

该接口返回的消息中,Header 中的 code 为 200,表示请求成功。

错误码

该接口在 HTTP Header 中返回错误码,错误码列表请参考 HTTP Header 中的状态码

×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。