文档中心
本地服务端录制
API 文档
客户端 API

客户端 API

更新时间：2024-01-18 18:14

ZEGO 提供对音视频通话、音视频直播以及混流视频进行录制的服务。

初始化

方法	描述
SetCallback	设置录制 SDK 相关回调监听。
SetUser	设置用户信息。
InitSDK	初始化 SDK。
InitSDK	初始化 SDK，ga01596a1c8 及以上版本支持（2022-03-23 发布）。
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	录制文件名回调。

本篇目录