提交工单
咨询集成、功能及报价等问题
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
互动视频 中文站 English
- 文档中心
- 互动视频
- API 文档
ZEGO Windows API Reference
更新时间：2023-02-09 11:08
ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。
基本功能方法
此分类下主要包括初始化 SDK 和基本音视频通信的方法，适用于语音通话、视频通话、语音/视频直播等应用场景。
基础功能
| 方法 | 描述 |
|---|---|
| 初始化 | |
| ZEGO::LIVEROOM::InitSDK | 初始化 SDK |
| ZEGO::LIVEROOM::SetUser | 设置用户信息 |
| ZEGO::LIVEROOM::UnInitSDK | 反初始化 SDK |
| ZEGO::LIVEROOM::SetConfig | 设置配置信息 |
| 环境配置 | |
| ZEGO::LIVEROOM::GetSDKVersion | 获取 SDK 版本号 |
| ZEGO::LIVEROOM::GetSDKVersion2 | 获取 SDK 引擎版本号 |
| ZEGO::LIVEROOM::SetVerbose | 调试信息输出开关 |
| ZEGO::LIVEROOM::SetUseTestEnv | 测试环境开关 |
| SDK 日志 | |
| ZEGO::LIVEROOM::SetLogDirAndSize | 设置日志保存目录和日志大小 |
| ZEGO::LIVEROOM::UploadLog | 上传日志 |
| 登录登出 | |
| ZEGO::LIVEROOM::SetRoomCallback | 设置直播房间相关信息通知的回调 |
| ZEGO::LIVEROOM::SetRoomConfig | 设置房间配置信息 |
| ZEGO::LIVEROOM::SetCustomToken | 设置自定义token信息 |
| ZEGO::LIVEROOM::LoginRoom | 登录房间 |
| ZEGO::LIVEROOM::SwitchRoom | 切换房间 |
| ZEGO::LIVEROOM::LogoutRoom | 退出房间 |
推拉流功能
实时消息
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::SetIMCallback | 设置实时消息信息通知的回调对象 |
| ZEGO::LIVEROOM::SetRoomCallback | 设置直播房间相关信息通知的回调 |
| ZEGO::LIVEROOM::SendRoomMessageEx | 发送聊天室消息 不支持大房间，每个房间QPS限制为10，消息大小限制为1k字节 |
| ZEGO::LIVEROOM::GetRoomMessage | 获取聊天室历史消息 |
| ZEGO::LIVEROOM::SendBigRoomMessage | 发送不可靠信道消息，主要用于大并发的场景，发送一些非必须到达的消息 支持大房间，每个房间QPS限制为20，消息大小限制为1k字节 |
| 自定义消息 | |
| ZEGO::LIVEROOM::SendCustomCommand | 发送自定义信令 发给一人时，支持大房间，每个房间QPS限制为200，消息大小限制为1k字节 发给多人时不支持大房间，每个房间QPS限制为10，消息大小限制为1k字节 注意：如果不指定接收人，会给所有人发送消息。 |
| 房间消息 | |
| ZEGO::LIVEROOM::SendReliableMessage | 发送可靠业务消息 支持大房间，每个房间QPS限制为10 |
| ZEGO::LIVEROOM::SetRoomExtraInfo | 更新房间属性 登录房间成功后使用 支持大房间，每个房间QPS限制为10 |
进阶功能方法
此分类下的方法主要包括了 Zego SDK 的特性，在基础的音视频通话基础上增加更丰富的功能，满足开发者的其它诉求，适用于语音通话、视频通话、互动直播、音视频录制等应用场景。
连麦
本组方法适用于互动直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::RespondJoinLiveReq | 回应连麦申请 |
| ZEGO::LIVEROOM::InviteJoinLive | 邀请连麦 |
| ZEGO::LIVEROOM::EndJoinLive | 结束连麦 |
| ZEGO::LIVEROOM::RequestJoinLive | 申请连麦 |
| ZEGO::LIVEROOM::RespondInviteJoinLiveReq | 回应连麦邀请 |
| IsVideoEncoderSupported | 是否支持指定视频编码 |
| IsVideoDecoderSupported | 是否支持指定视频解码格式 |
视频外部采集
本组方法为开发者提供自定义视频采集源的功能，适用于直播场景。
视频外部滤镜
本组方法为开发者提供可以自定义视频滤镜或者第三方视频滤镜的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::VIDEOFILTER::SetVideoFilterFactory | 设置外部滤镜模块 |
| 视频外部滤镜工厂 | |
| AVE::VideoFilterFactory::Create | 创建滤镜 |
| AVE::VideoFilterFactory::Destroy | 销毁滤镜 |
| 滤镜设置 | |
| AVE::VideoFilter::AllocateAndStart | 初始化采集使用的资源，例如启动线程，保存SDK传递的回调 |
| AVE::VideoFilter::StopAndDeAllocate | 停止并且释放采集占用的资源，同时调用client的Destroy方法，这里的client指的是AllocateAndStart传递的client |
| AVE::VideoFilter::SupportBufferType | 获取滤镜处理类型，SDK会根据此类型，使用对应的接口传输数据 |
| AVE::VideoFilter::GetInterface | 获取不同滤镜处理模型对应的接口 |
| 滤镜 Client | |
| AVE::VideoFilter::Client::Destroy | 销毁滤镜 |
| AVE::VideoFilter::Client::GetInterface | 获取不同滤镜处理模型对应的接口 |
| AVE::VideoFilterCallback::OnProcess | 滤镜处理回调 |
| AVE::VideoBufferPool::DequeueInputBuffer | SDK 请求外部滤镜返回内存池的下标,进行内存拷贝 |
| AVE::VideoBufferPool::GetInputBuffer | 获取C++内存指针 |
| AVE::VideoBufferPool::QueueInputBuffer | 外部滤镜处理数据并返回给SDK |
视频外部渲染
本组方法为开发者提供可以自处理视频渲染的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::EXTERNAL_RENDER::SetVideoRenderCallback | 设置外部视频渲染回调 |
| ZEGO::EXTERNAL_RENDER::SetVideoDecodeCallback | 设置外部视频解码回调 |
| ZEGO::EXTERNAL_RENDER::SetVideoRenderType | |
| ZEGO::EXTERNAL_RENDER::EnableVideoRender | 设置是否开启/关闭外部视频渲染（拉流） |
| ZEGO::EXTERNAL_RENDER::EnableVideoPreview | 设设置是否需要 SDK 将推流预览的数据抛出 |
媒体播放器
音效播放器
| 方法 | 描述 |
|---|---|
| ZEGO::AUDIOPLAYER::CreateAudioPlayer | 创建音效播放器 |
| ZEGO::AUDIOPLAYER::SetAudioPlayerCallback | 设置回调 |
| ZEGO::AUDIOPLAYER::PlayEffect | 播放音效 |
| ZEGO::AUDIOPLAYER::StopEffect | 停止播放音效 |
| ZEGO::AUDIOPLAYER::PauseEffect | 暂停播放音效 |
| ZEGO::AUDIOPLAYER::ResumeEffect | 恢复播放音效 |
| ZEGO::AUDIOPLAYER::SetVolume | 设置单个音效的音量 |
| ZEGO::AUDIOPLAYER::SetVolumeAll | 设置所有音效的音量 |
| ZEGO::AUDIOPLAYER::PauseAll | 暂停全部音效 |
| ZEGO::AUDIOPLAYER::ResumeAll | 恢复全部音效 |
| ZEGO::AUDIOPLAYER::StopAll | 停止全部音效 |
| ZEGO::AUDIOPLAYER::SetVolumeAll | 设置所有音效的音量 |
| ZEGO::AUDIOPLAYER::PreloadEffect | 预加载音效 |
| ZEGO::AUDIOPLAYER::UnloadEffect | 删除预加载音效 |
| ZEGO::AUDIOPLAYER::SeekTo | 设置进度 |
| ZEGO::AUDIOPLAYER::GetDuration | 获取音效的总时长 |
| ZEGO::AUDIOPLAYER::GetCurrentDuration | 获取音效的当前进度 |
| ZEGO::AUDIOPLAYER::DestroyAudioPlayer | 销毁音效播放器 |
媒体次要信息
本组方法为开发者提供在直播时同步其它信息的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::MEDIASIDEINFO::SetMediaSideCallback | 设置回调，接收媒体次要信息 |
| ZEGO::MEDIASIDEINFO::SetMediaSideFlags | 发送媒体次要信息开关，支持 SEI |
| ZEGO::MEDIASIDEINFO::SendMediaSideInfo | 发送媒体次要信息 |
音频外部采集与渲染
本组方法为开发者提供推流时采用自定义的音频数据及拉流时自渲染音频数据的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| zego_external_audio_device_enable | 主推流通道外部音频采集开关 |
| zego_external_audio_device_set_audio_src_for_auxiliary_publish_channel | 选择辅助推流通道的音频采集源 |
| zego_external_audio_device_start_capture | 开始外部音频采集（通知 SDK） |
| zego_external_audio_device_stop_capture | 结束外部音频采集（通知 SDK） |
| zego_external_audio_device_start_render | 开始外部音频播放（通知 SDK） |
| zego_external_audio_device_stop_render | 结束外部音频播放（通知 SDK） |
| zego_external_audio_device_on_record_audio_frame | 把采集到的音频数据(AAC 或者 PCM） 塞给 SDK |
| zego_external_audio_device_on_playback_audio_frame | 从 SDK 取音频渲染数据(PCM) |
音频前处理设置
本组方法为开发者提供自处理 SDK 采集的音频数据的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::SetAudioPrepCallback | 设置音频前处理函数 |
音频后处理设置
本组方法为开发者提供自处理拉流的音频数据的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::SetAudioPostpCallback | 设置音频后处理回调，并设置预处理参数 |
| ZEGO::LIVEROOM::EnableAudioPostp | 开启或关闭音频后处理功能 |
音频加解密设置
适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::AUDIO_ENCRYPT_DECRYPT::SetAudioEncryptDecryptCallback | 设置回调，接收音频数据进行加密或者解密后，再回传给sdk |
| ZEGO::AUDIO_ENCRYPT_DECRYPT::EnableAudioEncryptDecrypt | 音频加密、解密开关 |
音频录制设置
适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::SetAudioRecordCallback | 设置音频录制回调 |
| ZEGO::LIVEROOM::EnableSelectedAudioRecord | 音频录制回调开关 |
本地媒体录制
仅适用于推流或预览时的录制，不支持拉流时的音视频录制。
| 方法 | 描述 |
|---|---|
| ZEGO::MEDIA_RECORDER::SetZegoMediaRecordCallback | 设置录制回调 |
| ZEGO::MEDIA_RECORDER::StartRecord | 开始录制 |
| ZEGO::MEDIA_RECORDER::StopRecord | 停止录制 |
自动混流音频
适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::AUTOMIXSTREAM::SetAutoMixStreamCallback | 设置自动混流的事件回调 |
| ZEGO::AUTOMIXSTREAM::SetSoundLevelInAutoMixedStreamCallback | 设置自动混流中的发言者及其说话音量的回调通知 |
| ZEGO::AUTOMIXSTREAM::StartAutoMixStream | 开始自动混流 |
| ZEGO::AUTOMIXSTREAM::StopAutoMixStream | 停止自动混流 |
混流设置
适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::MIXSTREAM::SetMixStreamExCallback | 设置对应 MixStreamEx 的回调 |
| ZEGO::MIXSTREAM::SetSoundLevelInMixedStreamCallback | 设置接收混流中的音量信息的回调 |
| ZEGO::MIXSTREAM::MixStreamEx | 混流接口，支持混流一路或者多路输出 |
混音设置
本组方法为开发者提供自处理 SDK 采集的音频数据的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::AUDIOAUX::SetAuxCallback | 设置混音带有媒体次要信息回调 |
| ZEGO::AUDIOAUX::EnableAux | 混音开关 |
| ZEGO::AUDIOAUX::MuteAux | 混音静音开关 |
| ZEGO::AUDIOAUX::SetAuxVolume | 设置混音音量 |
| ZEGO::AUDIOAUX::SetAuxPublishVolume | 设置混音推流音量 |
| ZEGO::AUDIOAUX:: SetAuxPlayVolume | 设置混音本地播放音量 |
| ZEGO::MIXENGINE::MixEnginePlayout | 把引擎播放的声音混到推流中 |
| ZEGO::MIXENGINE::SetMixEnginePlayoutVolume | 设置引擎播放的声音混到推流中的音量 |
| ZEGO::LIVEROOM::EnableMixSystemPlayout | 系统声卡声音采集开关 |
| ZEGO::LIVEROOM::SetAudioCaptureShiftOnMix | 设置麦克风采集声音在混音过程中的偏移 |
变声设置
适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::AUDIOPROCESSING::SetVoicePreset | 预设变声配置 |
| ZEGO::AUDIOPROCESSING::SetReverbPreset | 预设混响效果 |
| ZEGO::AUDIOPROCESSING::SetAdvancedReverbParam | 设置音频混响高级参数 |
| ZEGO::AUDIOPROCESSING::EnableVirtualStereo | 设置虚拟立体声 |
| SetElectronicEffects | 设置电音配置 |
| ZEGO::AUDIOPROCESSING::EnableReverb | 设置音频混响 |
| ZEGO::AUDIOPROCESSING::SetReverbParam | 设置音频混响参数 |
| ZEGO::AUDIOPROCESSING::SetVoiceChangerParam | 设置变声器参数 |
美颜配置
本组方法为开发者提供调整美颜效果的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::EnableBeautifying | 开启美颜功能 |
| ZEGO::LIVEROOM::SetPolishStep | 设置美颜磨皮的采样步长 |
| ZEGO::LIVEROOM::SetPolishFactor | 设置美颜采样颜色阈值 |
| ZEGO::LIVEROOM::SetWhitenFactor | 设置美颜美白的亮度修正参数 |
| ZEGO::LIVEROOM::SetSharpenFactor | 设置锐化参数 |
| ZEGO::LIVEROOM::SetFilter | 设置滤镜 |
频域功率谱设置
本组方法为开发者提供获取直播音频在各频点上的能量的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::SPECTRUM::SetFrequencySpectrumCallback | 设置获取频域功率谱的回调 |
| ZEGO::SPECTRUM::SetFrequencySpectrumMonitorCycle | 设置获取频域功率谱的监控周期 |
| ZEGO::SPECTRUM::StartFrequencySpectrumMonitor | 启动频域功率谱监听 |
| ZEGO::SPECTRUM::StopFrequencySpectrumMonitor | 停止频域功率谱监听 |
音浪设置
本组方法为开发者提供获取直播音量的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::SOUNDLEVEL::EnableVADMonitor | 设置音浪回调是否检测VAD |
| ZEGO::SOUNDLEVEL::SetSoundLevelCallback | 设置获取 soundLevel 的回调对象 |
| ZEGO::SOUNDLEVEL::SetSoundLevelMonitorCycle | 设置 soundLevel 的监控周期 |
| ZEGO::SOUNDLEVEL::StartSoundLevelMonitor | 启动 soundLevel 监听 |
| ZEGO::SOUNDLEVEL::StopSoundLevelMonitor | 停止 soundLevel 监听 |
水印设置
本组方法为开发者提供加入特定水印到直播画面中的功能，适用于直播场景。
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::SetWaterMarkImagePath | 设置水印的图片路径 |
| ZEGO::LIVEROOM::SetPublishWaterMarkRect | 设置水印在采集视频中的位置 |
| ZEGO::LIVEROOM::SetPreviewWaterMarkRect | 设置水印在预览视频中的位置 |
设备状态管理
音频观察器设置
基本功能回调
音视频引擎事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::SetAVEngineCallback | 设置音视频引擎状态通知的回调 |
| ZEGO::LIVEROOM::IAVEngineCallback::OnAVEngineStop | 音视频引擎停止时回调 |
| ZEGO::LIVEROOM::IAVEngineCallback::OnAVEngineStart | 音视频引擎启动时回调 |
基础功能事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::IRoomCallback::OnInitSDK | InitSDK成功回调 |
| 登录登出相关事件回调 | |
| ZEGO::LIVEROOM::IRoomCallback::OnLoginRoom | 登录房间成功回调 |
| ZEGO::LIVEROOM::IRoomCallback::OnLogoutRoom | 退出房间回调 |
| ZEGO::LIVEROOM::IRoomCallback::OnKickOut | 用户被踢出房间 |
| ZEGO::LIVEROOM::IRoomCallback::OnDisconnect | 与 server 断开通知 |
| ZEGO::LIVEROOM::IRoomCallback::OnReconnect | 与 server 重连成功通知 |
| ZEGO::LIVEROOM::IRoomCallback::OnTempBroken | 与 server 的连接被动断开通知 |
| onTokenWillExpired | 设置的token即将过期回调，登录成功后在设置的token剩余时间小于等于30秒时会收到此回调 |
| 流更新事件回调 | |
| ZEGO::LIVEROOM::IRoomCallback::OnStreamUpdated | 流信息更新 |
| ZEGO::LIVEROOM::IRoomCallback::OnRoomInfoUpdated | 房间信息更新 |
| ZEGO::LIVEROOM::IRoomCallback::OnStreamExtraInfoUpdated | 流附加信息更新 |
| 用户状态更新事件回调 | |
| ZEGO::LIVEROOM::IIMCallback::OnUserUpdate | 用户状态更新 |
| ZEGO::LIVEROOM::IIMCallback::OnUpdateOnlineCount | 在线人数更新 |
推拉流功能事件回调
实时消息事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::LIVEROOM::IIMCallback::OnRecvRoomMessage | 收到房间消息回调 |
| ZEGO::LIVEROOM::IIMCallback::OnGetRoomMessage | 主动拉取房间历史消息回调 |
| ZEGO::LIVEROOM::IIMCallback::OnSendBigRoomMessage | 发送不可靠消息结果，这个接口用于大并发情景 |
| ZEGO::LIVEROOM::IIMCallback::OnRecvBigRoomMessage | 收到不可靠消息回调 |
| 自定义消息事件回调 | |
| ZEGO::LIVEROOM::IRoomCallback::OnCustomCommand | 发送自定义信令结果 |
| ZEGO::LIVEROOM::IRoomCallback::OnRecvCustomCommand | 收到自定义信令 |
进阶功能回调
连麦事件回调
视频外部采集事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::VCAP::IZegoTrafficControlCallback::OnTrafficControlCallback | 外部视频采集流控回调 |
视频外部渲染事件回调
媒体播放器事件回调
音效播放器事件回调
媒体次要信息事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::MEDIASIDEINFO::IZegoMediaSideCallback::onRecvMediaSideInfo | 接收到媒体次要信息 |
音频前处理事件回调
| 方法 | 描述 |
|---|---|
| AVE::OnPrepCallback | 音频前处理回调，并在回调中处理 SDK 传入的音频数据 |
音频后处理事件回调
| 方法 | 描述 |
|---|---|
| AVE::OnPostpCallback | 音频后处理回调，并在回调中处理拉流的音频数据 |
音频加解密事件回调
| 方法 | 描述 |
|---|---|
| IZegoAudioEncryptDecryptCallback::OnAudioEncryptDecryptCallback | 音频加密、解密回调 |
音频录制事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::AV::IZegoAudioRecordCallback::OnAudioRecordCallback | 音频录制结果回调 |
本地媒体录制事件回调
自动混流音频事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::AUTOMIXSTREAM::IZegoAutoMixStreamCallback::OnStartAutoMixStream | 启动自动混流结果通知 |
| ZEGO::AUTOMIXSTREAM::IZegoAutoMixStreamCallback::OnStopAutoMixStream | 停止自动混流结果通知 |
| ZEGO::AUTOMIXSTREAM::IZegoSoundLevelInAutoMixedStreamCallback::OnSoundLevelInAutoMixedPlayStream | 混流中的发言者及其说话音量信息的回调，是高频率同步回调，请勿在回调中处理耗时事务 |
混流事件回调
混音事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::AUDIOAUX::IZegoAuxCallback::OnAuxCallbackEx | 混音音频数据输入回调。 当开启混音后，通过此回调获取混音音频数据 |
频域功率谱设置事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::SPECTRUM::IZegoFrequencySpectrumCallback::OnCaptrueFrequencySpectrumUpdate | 获取采集的频域功率谱信息 |
| ZEGO::SPECTRUM::IZegoFrequencySpectrumCallback::OnFrequencySpectrumUpdate | 获取拉流的频域功率谱信息 |
音浪设置事件回调
| 方法 | 描述 |
|---|---|
| ZEGO::SOUNDLEVEL::IZegoSoundLevelCallback::OnSoundLevelUpdate | 获取 soundLevel 更新的回调 |
| ZEGO::SOUNDLEVEL::IZegoSoundLevelCallback::OnCaptureSoundLevelUpdate | 获取 captureSoundLevel 更新的回调 |
设备状态管理事件回调
| 方法 | 描述 |
|---|---|
| 视频设备状态管理事件回调 | |
| ZEGO::AV::IZegoDeviceStateCallback::OnVideoDeviceStateChanged | 视频设备状态变更 |
| 音频设备状态管理事件回调 | |
| ZEGO::AV::IZegoDeviceStateCallback::OnAudioDeviceStateChanged | 音频设备状态变更 |
| ZEGO::AV::IZegoDeviceStateCallback::OnAudioVolumeChanged | 音频设备音量变更 |
| ZEGO::AV::IZegoDeviceStateCallback::OnDeviceError | 设备错误 |
| ZEGO::AV::IZegoNetTypeCallback::onNetTypeChange | 网络状态回调，以根据回调的当前网络状态，提示用户网络状态的变化 |
| ZEGO::AV::DeviceVideoCapabilityInfo::GetVideoDevCapabilityList | 获取视频设备的分辨率、帧率列表 |
| ZEGO::LIVEROOM::IRoomCallback::OnNetworkQuality | 房间内正在连麦的用户的网络质量回调 |
音频观察器事件回调
本篇目录
- 免费试用
- 电话咨询400 1006 604咨询客服微信扫码，24h在线
联系我们
文档反馈
