|
NERecord Linux SDK 5.5.3103
|
网易云信本地服务端录制 SDK（简称 NERecord SDK）基于 Linux 操作系统提供完善的音视频通话过程录制开发套件。SDK 支持一对一或多人的音视频通话过程录制。通过本地服务端录制功能，您可以将语音聊天、视频聊天的内容录制并储存下来，以便后续提供给更多人观看回放或存档。
在调用 SDK API 的过程中，SDK 可能会返回错误码或状态码。根据错误码或状态码，您可以判断当前 SDK 或任务的状态。如果遇到未知的错误码，请 提交工单 联系网易云信技术支持工程师排查。
SDK API 的错误码如下：
该类包含应用程序调用的主要方法。
方法 | 功能 | 起始版本 |
|---|---|---|
| initialize | 初始化 NERecord SDK 服务。 | V3.9.0 |
| release | 销毁录制引擎实例。 | V3.9.0 |
| joinChannel | 录制端加入房间并开始录制。 | V3.9.0 |
| leaveChannel | 录制端退出房间。 | V3.9.0 |
| setVideoMixingLayout | 设置视频合流布局。 | V3.9.0 |
| startMixingRecord | 启动合流录制。 | V3.9.0 |
| stopMixingRecord | 停止合流录制。 | V3.9.0 |
| subscribeRemoteAudioStream | 手动模式下订阅或取消订阅指定音频流。 | V3.9.0 |
| subscribeRemoteVideoStream | 手动模式下订阅或取消订阅指定视频流。 | V3.9.0 |
| updateSubscribeAudioUids | 手动模式下批量更新订阅的音频流。 | V3.9.0 |
| updateSubscribeVideoUids | 手动模式下批量更新订阅的视频流。 | V3.9.0 |
| startService | 手动模式下开始录制。 | V3.9.0 |
| stopService | 手动模式下暂停录制。 | V3.9.0 |
| updateWatermarkConfigs | 添加、更新或删除水印设置。 | V3.9.0 |
| updateWatermarkConfigs | 更新合流录制视频水印。此方法可设置辅流的水印。 | V4.1.0 |
| enableAudioVolumeIndication | 启用说话者音量提示。 | V3.9.0 |
| enableEncryption | 是否开启媒体流加密。 | V5.5.3103 |
| setUserBackground | 设置指定用户的背景。当指定 uid 没有发送视频流时，会显示该背景图片。 | V4.1.0 |
| getProperties | 获取录制属性。 | V3.9.0 |
回调 | 功能 | 起始版本 |
|---|---|---|
| onError | 发生错误回调。 | V3.9.0 |
| onWarning | 发生警告回调。 | V3.9.0 |
| onDisconnect | 网络连接丢失回调/客户端掉线回调。 | V3.9.0 |
| onConnectInterrupted | 网络连接中断回调。 | V3.9.0 |
| onConnectionStateChanged | 连接状态改变回调。 | V3.9.0 |
| onJoinChannel | 加入房间回调。 | V3.9.0 |
| onRejoinChannel | 重新加入房间回调。 | V3.9.0 |
| onLeaveChannel | 离开房间回调。 | V3.9.0 |
| onUserJoined | 远端用户加入当前房间回调。 | V3.9.0 |
| onUserLeft | 远端用户离开当前房间回调。 | V3.9.0 |
| onUserAudioStart | 远端用户开启音频回调。 | V3.9.0 |
| onUserAudioStop | 远端用户停用音频回调。 | V3.9.0 |
| audioFrameReceived | 收到原始音频数据回调。 | V3.9.0 |
| audioFrameMixed | 房间内音频混音完成回调。 | V4.1.0 |
| onUserAudioMute | 远端用户是否静音回调。 | V3.9.0 |
| onUserVideoStart | 远端用户开启视频回调。 | V3.9.0 |
| onUserVideoStop | 远端用户停用视频回调。 | V3.9.0 |
| videoFrameReceived | 收到原始视频数据回调。 | V3.9.0 |
| videoSubstreamFrameReceived | 收到辅流原始视频数据回调。 | V4.1.0 |
| onUserVideoMute | 远端用户是否禁视频流回调。 | V3.9.0 |
| onUserSubStreamVideoStart | 远端用户开启辅流视频回调。 | V4.1.0 |
| onUserSubStreamVideoStop | 远端用户停用辅流视频回调。 | V4.1.0 |
| onRemoteAudioVolumeIndication | 提示房间内谁正在说话及说话者瞬时音量的回调。 | V3.9.0 |
| onActiveSpeaker | 监测到活跃用户回调。 | V3.9.0 |
| onFirstAudioDataReceived | 已接收到远端音频首帧回调。 | V3.9.0 |
| onFirstVideoDataReceived | 已显示首帧远端视频回调。 | V3.9.0 |
| onFirstAudioFrameDecoded | 已解码远端音频首帧的回调。 | V3.9.0 |
| onFirstVideoFrameDecoded | 已接收到远端视频并完成解码回调。 | V3.9.0 |
| onRecordStats | 当前录制统计回调。 | V3.9.0 |
| onLocalAudioStats | 本地音频流统计信息回调。 | V3.9.0 |
| onRemoteAudioStats | 通话中远端音频流的统计信息回调。 | V3.9.0 |
| onLocalVideoStats | 本地视频流统计信息回调。 | V3.9.0 |
| onRemoteVideoStats | 通话中远端视频流的统计信息回调。 | V3.9.0 |
| onMixingLayoutChanged | 录制布局改变回调。 | V3.9.0 |
1.10.0