客户端 API
ZEGO 提供对音视频通话、音视频直播以及混流视频进行录制的服务。
初始化
| 方法 | 描述 |
|---|---|
| setUser | 设置用户信息。 |
| initSDK | 初始化 SDK。 |
| unInitSDK | 反初始化 SDK。 |
环境配置
| 方法 | 描述 |
|---|---|
| setCustomToken | 设置自定义 token 信息。 |
| getSDKVersion | 获取 SDK 版本。 |
SDK 日志
| 方法 | 描述 |
|---|---|
| setLogDirAndSize | 设置 SDK log 路径和单个 log 文件大小。 |
| uploadLog | 上传 log 文件到 ZEGO 后台。 |
登录登出
| 方法 | 描述 |
|---|---|
| loginRoom | 登录房间。 |
| logoutRoom | 退出房间。 |
录制
| 方法 | 描述 |
|---|---|
| setConfig | 设置配置信息。 |
| getMaxRecordCount | 获取 SDK 支持的最大同时录制流数。 |
| setMuxerOutType | 设置录制数据输出方式。 |
| setMuxerCacheSize | 设置文件落地前的缓存大小（64 KB ～ 1 MB），以字节为单位。 |
| enableSingleAndMixRecordMode | 设置是否启用单流混流同时录制模式，启用该模式比较消耗系统资源。 |
| enableExternalRender | 设置是否启用外部渲染。 |
| startRecordSingleStream | 开始单流录制。 |
| stopRecordSingleStream | 停止单流录制。 |
| startRecordMixStream | 开始混流录制。 |
| updateInputStreamConfig | 更新混流录制输入流配置。 |
| updateImageWaterMarkConfig | 更新图片水印配置。 |
| stopRecordMixStream | 停止混流录制。 |
| getRecordLastMediaSideTime | 获取收到的最近一次 Media Side Info 数据包距离录制的第一个数据包的时间间隔。 |
| getRecordStatus | 获取当前录制状态。 |
通用事件回调
| 方法 | 描述 |
|---|---|
| onInitSDK | InitSDK 回调。 |
| onLoginRoom | 登录房间成功回调。 |
| onLogoutRoom | 退出房间回调。 |
| onDisconnect | 与 server 断开通知。 |
| onStreamUpdate | 流信息更新。 |
| onAudioDataCallback | 音频帧数据回调，不要在回调函数中做耗时的操作。 |
| onVideoDataCallback | 视频帧数据回调，不要在回调函数中做耗时的操作。 |
| onRecvMediaSideInfo | 媒体次要信息回调。 |
录制事件回调
| 方法 | 描述 |
|---|---|
| onStreamRecordBegin | 录制开始回调。 |
| onStreamRecordEnd | 录制结束回调。 |
| onStreamRecordEvent | 录制事件回调。 |
| onStreamRecordData | 录制数据回调。 |
| onMixStreamRecordUpdate | 混流录制信息更新回调。 |
| onRecordFilePath | 录制文件名回调。 |