文档中心
实时音视频
客户端 API
功能总览

功能总览

更新时间：2025-02-27 17:18

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。

API 返回的错误码请参考：https://doc-zh.zego.im/article/4378。

以下为基本的 API 简要介绍。

初始化相关的前置功能

方法名	描述
createEngine	创建 ZegoExpressEngine 单例对象并初始化 SDK。
destroyEngine	销毁 ZegoExpressEngine 单例对象并反初始化 SDK。
setEngineConfig	设置引擎进阶配置。
setLogConfig	设置日志配置。
setRoomMode	设置房间模式。
getVersion	获取 SDK 版本号。
setApiCalledCallback	设置方法执行结果回调。
isFeatureSupported	查询当前 SDK 是否支持指定的功能特性。
setEventHandler	设置事件通知回调。
setRoomScenario	设置房间场景。
uploadLog	上传日志到 ZEGO 服务器，带回调。
enableDebugAssistant	开启调试助手。注意，请勿在线上版本开启此功能！仅在开发阶段使用！
callExperimentalAPI	调用实验性 API。
onDebugError	调试错误信息回调。
onApiCalledResult	方法执行结果回调。
onEngineStateUpdate	音视频引擎状态更新的回调通知。
onRecvExperimentalAPI	实验性 API 回调。

房间功能

方法名	描述
loginRoom	使用带配置进阶属性的方式登录房间，通过回调参数返回登录结果，推拉流前必须登录房间。
logoutRoom	退出指定房间 ID 的房间，并带有回调。
switchRoom	使用配置进阶属性的方式切换房间。
renewToken	更新 token 鉴权信息。
setRoomExtraInfo	设置房间附加消息。
onRoomStateUpdate	房间状态变化通知。
onRoomStateChanged	房间状态变化通知，包含具体的状态变化原因。
onRoomUserUpdate	房间内其他用户增加或减少的回调通知。
onRoomOnlineUserCountUpdate	房间内当前在线用户数量回调。
onRoomStreamUpdate	相同房间内其他用户推的流增加或减少的通知。
onRoomStreamExtraInfoUpdate	房间内流附加信息更新通知。
onRoomExtraInfoUpdate	房间附加信息更新通知。
onRoomTokenWillExpire	房间 Token 鉴权将要过期的回调通知。

推流功能

方法名	描述
startPublishingStream	开始推流，支持多房间模式
stopPublishingStream	停止推流，可停止指定通道的音视频流。
setStreamExtraInfo	设置指定推流通道的流附加信息。
startPreview	启动/更新本地预览，支持设置其他通道的推流。
stopPreview	停止本地预览，支持设置其他通道的推流
setVideoConfig	设置视频配置，支持设置其他通道的推流。
getVideoConfig	获取当前视频配置，支持设置其他通道的推流
setVideoMirrorMode	设置镜像模式，支持设置其他通道的推流。
setAppOrientation	设置采集视频的朝向，支持设置其他通道的推流。
setAudioConfig	设置指定推流通道的音频质量配置。
getAudioConfig	获取指定推流通道的当前音频质量配置。
setPublishStreamEncryptionKey	设置指定推流通道的推流加密密钥。
mutePublishStreamAudio	停止或恢复发送指定推流通道的音频流。
mutePublishStreamVideo	停止或恢复发送指定推流通道的视频流。
enableTrafficControl	开始或停止指定推流通道的流量控制。
setMinVideoBitrateForTrafficControl	设置指定推流通道的流量控制视频码率最低值
setMinVideoFpsForTrafficControl	设置流量控制的最低视频帧率阈值。
setMinVideoResolutionForTrafficControl	设置流量控制的最低视频分辨率阈值。
setCaptureVolume	设置推流端采集音量。
enableHardwareEncoder	开/关硬件编码。
setCapturePipelineScaleMode	设置采集缩放时机，视频数据是采集的时候立即缩放还是编码时才进行缩放。
isVideoEncoderSupported	是否支持指定视频编码类型。
setAppOrientationMode	设置视频的朝向模式。
onPublisherStateUpdate	推流状态回调。
onPublisherQualityUpdate	推流质量回调。
onPublisherCapturedAudioFirstFrame	音频采集首帧回调接口。
onPublisherCapturedVideoFirstFrame	视频采集首帧回调接口。
onPublisherRenderVideoFirstFrame	推流端视频渲染首帧回调。
onPublisherVideoSizeChanged	采集视频大小变更回调。
onPublisherRelayCDNStateUpdate	添加/删除转推 CDN 地址状态回调。
onPublisherVideoEncoderChanged	视频编码器变更回调。
onPublisherStreamEvent	推流事件回调。

拉流功能

方法名	描述
startPlayingStream	开始拉流（从 ZEGO RTC 服务器或第三方 CDN），支持多房间模式。
stopPlayingStream	停止拉流。
setPlayStreamDecryptionKey	设置拉流解密密钥。
setPlayVolume	设置拉流音量。
setAllPlayStreamVolume	设置所有拉流音量。
setPlayStreamVideoType	设置播放视频流类型。
setPlayStreamBufferIntervalRange	设置拉流播放缓存自适应调整的区间范围。
setPlayStreamFocusOn	设置拉音视频流优先级的权重。
mutePlayStreamAudio	拉流是否可接收指定音频数据。
mutePlayStreamVideo	拉流是否可接收指定视频数据。
muteAllPlayStreamAudio	拉流是否接收所有音频数据。（当设置为true时，调用[mutePlayStreamAudio]不会生效）
muteAllPlayStreamVideo	拉流是否可接收所有视频数据。（当设置为true时，调用[mutePlayStreamVideo]不会生效）
enableHardwareDecoder	开/关硬件解码。
enableCheckPoc	开/关帧顺序检测。
isVideoDecoderSupported	是否支持指定视频解码格式。
onPlayerStateUpdate	拉流状态变更回调。
onPlayerQualityUpdate	拉流质量回调。
onPlayerMediaEvent	拉流媒体事件回调。
onPlayerRecvAudioFirstFrame	拉流端音频接收首帧回调。
onPlayerRecvVideoFirstFrame	拉流端视频接收首帧回调。
onPlayerRenderVideoFirstFrame	拉流端渲染完视频首帧回调。
onPlayerRenderCameraVideoFirstFrame	拉流端渲染完远端摄像头视频首帧回调。
onPlayerVideoSizeChanged	拉流分辨率变更通知。
onPlayerRecvSEI	收到远端流的 SEI 内容。
onPlayerSyncRecvSEI	同步接收远端流的 SEI 内容。
onPlayerRecvAudioSideInfo	收到远端流的音频次要信息内容。
onPlayerLowFpsWarning	拉流低帧率警告。
onPlayerStreamEvent	拉流事件回调。
onPlayerVideoSuperResolutionUpdate	拉流视频超分辨率开启状态变化。

音视频前处理

方法名	描述
enableAEC	是否开启回声消除。
enableHeadphoneAEC	是否在使用耳机时开启回声消除。
setAECMode	设置回声消除模式
enableAGC	开/关自动增益控制
enableANS	开/关噪声抑制
enableTransientANS	开/关瞬态噪声抑制
setANSMode	设置音频噪声抑制模式
startEffectsEnv	开启 Effects 美颜环境。
stopEffectsEnv	关闭 Effects 美颜环境。
enableEffectsBeauty	开启或关闭美颜效果。
setEffectsBeautyParam	设置美颜效果参数。
setAudioEqualizerGain	设置音效均衡器（EQ）。
setVoiceChangerPreset	通过预设枚举设置变声。
setVoiceChangerParam	设置变声的具体参数。
setReverbPreset	通过预设枚举设置混响。
setReverbAdvancedParam	设置混响的具体参数。
setReverbEchoParam	设置混响回声效果的具体参数。
enableVirtualStereo	开启或关闭推流时的虚拟立体声效果。
enablePlayStreamVirtualStereo	开启或关闭拉流时的虚拟立体声效果。
setElectronicEffects	开启或关闭电音效果。

设备管理

方法名	描述
muteMicrophone	设置是否静音（关闭麦克风）。
isMicrophoneMuted	检查麦克风是否设置为静音。
muteSpeaker	设置是否静音（关闭音频输出）。
isSpeakerMuted	检查音频输出是否静音。
getAudioDeviceList	获取音频设备列表
getDefaultAudioDeviceID	获取默认音频设备 ID
useAudioDevice	选择使用某个音频设备
getAudioDeviceVolume	获取音频设备音量
setAudioDeviceVolume	设置音频设备音量。
startAudioDeviceVolumeMonitor	开启音频设备音量监控。
stopAudioDeviceVolumeMonitor	停止音频设备音量监控。
muteAudioDevice	静音或取消静音音频设备。
setAudioDeviceMode	设置音频设备模式。
isAudioDeviceMuted	检查音频设备是否静音
enableAudioCaptureDevice	开/关音频采集设备。
getAudioRouteType	获取当前音频路由。
setAudioRouteToSpeaker	设置音频路由到扬声器。
enableCamera	开/关摄像头，支持设置其他通道的推流。
useFrontCamera	切换前后摄像头，支持指定推流通道。
isCameraFocusSupported	摄像头是否支持对焦
setCameraFocusMode	设置摄像头对焦模式。
setCameraFocusPointInPreview	设置预览视图中的对焦点。
setCameraExposureMode	设置摄像头曝光模式。
setCameraExposurePointInPreview	设置预览视图中的曝光点。
setCameraExposureCompensation	设置摄像头曝光补偿数值，支持指定推流通道号。
setCameraZoomFactor	设置摄像头变焦倍数，支持指定推流通道号。每次摄像头重新启动时，摄像头变焦倍数都将会恢复初始值 (1.0)。
getCameraMaxZoomFactor	获取摄像头最大变焦倍数，支持指定推流通道号。
enableCameraAdaptiveFPS	开启摄像头自适应帧率
useVideoDevice	选择使用某个视频设备，支持设置指定推流通道
getVideoDeviceList	获取视频设备列表
getDefaultVideoDeviceID	获取默认视频设备 ID
startSoundLevelMonitor	启动声浪监控，支持开启进阶功能。
stopSoundLevelMonitor	停止声浪监控。
startAudioSpectrumMonitor	启动音频频谱监控，支持设置监听间隔。
stopAudioSpectrumMonitor	停止音频频谱监控。
enableHeadphoneMonitor	开启/关闭耳返。
setHeadphoneMonitorVolume	设置耳返音量。
enableMixSystemPlayout	开启/关闭系统声卡采集。
setMixSystemPlayoutVolume	设置系统声卡采集的音量。
enableMixEnginePlayout	是否将 SDK 播放的声音混到推流中。
startAudioVADStableStateMonitor	开始语音的稳态检测，可设置检测周期。
stopAudioVADStableStateMonitor	停止语音的稳态检测。
onAudioDeviceStateChanged	音频设备状态改变
onAudioDeviceVolumeChanged	音频设备音量变更。
onVideoDeviceStateChanged	视频设备状态改变。
onCapturedSoundLevelInfoUpdate	本地采集音频声浪回调，支持人声检测。
onRemoteSoundLevelInfoUpdate	远端拉流音频声浪回调，支持人声检测。
onCapturedAudioSpectrumUpdate	本地采集音频频谱回调。
onRemoteAudioSpectrumUpdate	远端拉流音频频谱回调。
onLocalDeviceExceptionOccurred	本地设备异常通知。
onRemoteCameraStateUpdate	远端摄像头设备状态通知。
onRemoteMicStateUpdate	远端麦克风设备状态通知。
onRemoteSpeakerStateUpdate	远端扬声器设备状态通知。
onAudioRouteChange	音频设备路由变更通知。
onAudioVADStateUpdate	检测音频数据的稳态语音状态的回调。
getCurrentAudioDevice	获取当前使用的音频设备信息。

实用工具

方法名	描述
startPerformanceMonitor	启动系统性能监控。
stopPerformanceMonitor	停止系统性能监控。
onPerformanceStatusUpdate	系统性能监控回调。