文档中心
ExpressVideoSDK 实时音视频
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 实时音视频
  • 客户端 API
  • 功能总览

功能总览

更新时间:2025-04-10 19:14

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为多端提供清晰稳定的实时语音视频云服务。 以下为基本 API 的简要介绍。

初始化相关的前置功能

方法名 描述
createEngineWithProfile 创建 ZegoExpressEngine 单例对象并初始化 SDK。
destroyEngine 销毁 ZegoExpressEngine 单例对象并反初始化 SDK。
setEngineConfig 设置引擎进阶配置。
setRoomMode 设置房间模式。
getVersion 获取 SDK 版本号。
uploadLog 上传日志到 ZEGO 服务器。
callExperimentalAPI 调用实验性 API。
on 注册事件监听
off 注销事件监听
debugError 调试错误信息回调。
apiCalledResult 方法执行结果回调。
engineStateUpdate 音视频引擎状态更新的回调通知。
recvExperimentalAPI 实验性 API 回调。

房间功能

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

推流功能

方法名 描述
startPublishingStream 开始推流,支持多房间模式
stopPublishingStream 停止推流,可停止指定通道的音视频流。
setStreamExtraInfo 设置指定推流通道的流附加信息。
startPreview 启动/更新本地预览,支持设置其他通道的推流。
stopPreview 停止本地预览,支持设置其他通道的推流
setVideoConfig 设置视频配置,支持设置其他通道的推流。
getVideoConfig 获取当前视频配置,支持设置其他通道的推流
setVideoMirrorMode 设置镜像模式,支持设置其他通道的推流。
setAppOrientation 设置采集视频的朝向,支持设置其他通道的推流。
setAudioConfig 设置指定推流通道的音频质量配置。
getAudioConfig 获取指定推流通道的当前音频质量配置。
takePublishStreamSnapshot 对指定推流通道的推流画面截图。
mutePublishStreamAudio 停止或恢复发送指定推流通道的音频流。
mutePublishStreamVideo 停止或恢复发送指定推流通道的视频流。
setStreamAlignmentProperty 开启或关闭流精准对齐功能
setCaptureVolume 设置推流端采集音量。
setAudioCaptureStereoMode 设置音频采集双声道模式。
addPublishCdnUrl 增加转推至 CDN 的 URL。
removePublishCdnUrl 删除转推至 CDN 的 URL。
enablePublishDirectToCDN 是否直接推流到 CDN(不经过 ZEGO RTC 服务器), 支持设置其他通道的推流。
sendSEI 指定推流通道号,发送媒体增强补充信息。
enableHardwareEncoder 开/关硬件编码。
enableH265EncodeFallback 是否开启 H.265 编码自动降级到 H.264 编码。
isVideoEncoderSupported 是否支持指定视频编码类型。
setVideoSource 设置指定推流通道的视频采集源。
setAudioSource 为指定推流通道设置音频采集源
enableVideoObjectSegmentation 开启主体分割。
enableAlphaChannelVideoEncoder 开启视频编码器透明通道支持。
publisherStateUpdate 推流状态回调。
publisherQualityUpdate 推流质量回调。
publisherCapturedAudioFirstFrame 音频采集首帧回调接口。
publisherCapturedVideoFirstFrame 视频采集首帧回调接口。
publisherRenderVideoFirstFrame 推流端视频渲染首帧回调。
publisherVideoSizeChanged 采集视频大小变更回调。
publisherRelayCDNStateUpdate 添加/删除转推 CDN 地址状态回调。
publisherVideoEncoderChanged 视频编码器变更回调。
publisherStreamEvent 推流事件回调。
videoObjectSegmentationStateChanged 视频主体分割状态变化。

拉流功能

方法名 描述
startPlayingStream 开始拉流(从 ZEGO RTC 服务器或第三方 CDN),支持多房间模式。
stopPlayingStream 停止拉流。
takePlayStreamSnapshot 拉流画面截图。
setPlayVolume 设置拉流音量。
setAllPlayStreamVolume 设置所有拉流音量。
setPlayStreamVideoType 设置播放视频流类型。
setPlayStreamBufferIntervalRange 设置拉流播放缓存自适应调整的区间范围。
mutePlayStreamAudio 拉流是否可接收指定音频数据。
mutePlayStreamVideo 拉流是否可接收指定视频数据。
muteAllPlayStreamAudio 拉流是否接收所有音频数据。(当设置为true时, 调用[mutePlayStreamAudio]不会生效)
muteAllPlayStreamVideo 拉流是否可接收所有视频数据。(当设置为true时, 调用[mutePlayStreamVideo]不会生效)
enableHardwareDecoder 开/关硬件解码。
isVideoDecoderSupported 是否支持指定视频解码格式。
setPlayStreamsAlignmentProperty 设置拉流对齐属性。
playerStateUpdate 拉流状态变更回调。
playerQualityUpdate 拉流质量回调。
playerMediaEvent 拉流媒体事件回调。
playerRecvAudioFirstFrame 拉流端音频接收首帧回调。
playerRecvVideoFirstFrame 拉流端视频接收首帧回调。
playerRenderVideoFirstFrame 拉流端渲染完视频首帧回调。
playerVideoSizeChanged 拉流分辨率变更通知。
playerRecvSEI 收到远端流的 SEI 内容。

信令消息功能

方法名 描述
createRealTimeSequentialDataManager 创建实时有序数据管理器对象
destroyRealTimeSequentialDataManager 销毁实时有序数据管理器对象
startBroadcasting 开始广播实时有序数据流。
stopBroadcasting 停止广播实时有序数据流
sendRealTimeSequentialData 在广播中的流 ID 上发送实时有序数据
startSubscribing 开始订阅实时有序数据流。
stopSubscribing 停止订阅实时有序数据流。
getIndex 获取实时有序数据管理器索引。
receiveRealTimeSequentialData 收到实时有序数据回调
on 注册监听实时有序数据事件回调
off 注销监听实时有序数据事件回调
sendBroadcastMessage 发送房间广播消息。
sendBarrageMessage 发送房间弹幕消息。
sendCustomCommand 发送自定义信令。
IMRecvBroadcastMessage 接收房间广播消息通知。
IMRecvBarrageMessage 接收房间弹幕消息通知。
IMRecvCustomCommand 接收自定义信令通知。

混流功能

方法名 描述
startMixerTask 开始混流任务。
stopMixerTask 停止混流任务。
mixerRelayCDNStateUpdate 混流转推 CDN 状态更新通知。
mixerSoundLevelUpdate 混流中的每条单流的声浪更新通知。

音视频前处理

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

媒体播放器功能

方法名 描述
createMediaPlayer 创建媒体播放器实例对象。
destroyMediaPlayer 销毁媒体播放器实例对象。
loadResource 加载本地或者网络媒体资源。
loadResourceWithConfig 加载本地或者网络媒体资源,带配置参数。
start 开始播放
stop 停止播放
pause 暂停播放
resume 恢复播放
seekTo 设置指定的播放进度
enableRepeat 是否重复播放
setPlaySpeed 设置播放倍速。
enableAux 是否将播放器的声音混入正在推的流中
muteLocal 是否静默本地播放
setPlayerView 设置播放器播放视频的视图
setVolume 设置播放器音量,会同时设置本地播放音量和推流音量
setPlayVolume 设置播放器本地播放音量
setPublishVolume 设置播放器推流音量
setProgressInterval 设置播放进度回调间隔
getPlayVolume 获取当前媒体播放器本地播放的音量,范围为 0 ~ 200,默认值为 60
getPublishVolume 获取当前媒体播放器推流的音量,范围为 0 ~ 200,默认值为 60
getTotalDuration 获取媒体资源的总进度
getCurrentProgress 获取当前播放进度
getCurrentRenderingProgress 获取当前渲染进度
getAudioTrackCount 获取播放文件的音轨个数
setAudioTrackIndex 设置播放文件的音轨
setAudioTrackMode 设置播放器的音轨模式
setAudioTrackPublishIndex 设置媒体文件需要推流的音轨
enableVoiceChanger 开启变声,设置变声的具体参数。
getCurrentState 获取当前播放状态
getIndex 获取媒体播放器的序号
takeSnapshot 对媒体播放器当前播放画面进行截图
setNetWorkResourceMaxCache 设置网络素材最大的缓存时长和缓存数据大小
getNetWorkResourceCache 获取当前网络素材缓存队列的缓存数据可播放的时长和缓存数据大小
setNetWorkBufferThreshold 通过该接口设置媒体播放器重新恢复播放需要达到的缓存阈值,SDK 默认值是 5000ms,有效值为大于等于1000ms
enableSoundLevelMonitor 是否开启声浪监听。
enableFrequencySpectrumMonitor 是否开启频谱监听。
setActiveAudioChannel 设置播放声道。
clearView 清除播放控件播放结束后, 在控件上保留的最后一帧画面。
getMediaInfo 获取媒体文件视频分辨率等媒体信息。
on 注册监听媒体播放器事件回调
off 注销监听媒体播放器事件回调
updatePosition 更新媒体播放器(音频源)位置。
setHttpHeader 设置 http 头信息。
setPlayMediaStreamType 设置播放的媒体流类型。
enableLiveAudioEffect 开启现场音效。
enableLocalCache 开启本地缓存 http/https 网络资源。
enableViewMirror 开启画面镜像。
getPlaybackStatistics 获取播放统计信息。
mediaPlayerStateUpdate 媒体播放器播放状态回调。
mediaPlayerNetworkEvent 媒体播放器网络状态事件回调。
mediaPlayerPlayingProgress 播放器播放进度回调。
mediaPlayerRenderingProgress 播放器渲染进度回调。
mediaPlayerVideoSizeChanged 媒体播放器播放视频分辨率改变事件回调。
mediaPlayerRecvSEI 媒体次要信息回调。
mediaPlayerSoundLevelUpdate 声浪更新回调。
mediaPlayerFrequencySpectrumUpdate 频谱更新回调。
mediaPlayerFirstFrameEvent 媒体播放器播放首帧回调。
mediaPlayerLocalCache 媒体播放器本地缓存 http/https 网络资源后回调。

音效播放器功能

方法名 描述
createAudioEffectPlayer 创建音效播放器实例对象。
destroyAudioEffectPlayer 销毁音效播放器实例对象。
start 开始播放音效。
stop 停止播放音效。
pause 暂停播放音效。
resume 恢复播放音效。
stopAll 停止播放所有音效。
pauseAll 暂停播放所有音效。
resumeAll 恢复播放所有音效。
seekTo 设置播放进度。
setVolume 设置单个音效的播放音量,会同时设置本地播放音量和推流音量。
setVolumeAll 设置所有音效的播放音量,会同时设置本地播放音量和推流音量。
getTotalDuration 获取指定音效资源的总长度。
getCurrentProgress 获取当前播放进度。
loadResource 加载音效资源。
unloadResource 卸载音效资源。
getIndex 获取音效播放器索引。
audioEffectPlayerStateUpdate 音效播放状态回调。
on 注册监听媒体播放器事件回调
off 注销监听媒体播放器事件回调

录制功能

方法名 描述
startRecordingCapturedData 开始本地录制,直接将音视频数据录制到本地文件。
stopRecordingCapturedData 结束录制本端音频或音视频。
capturedDataRecordStateUpdate 本地录制的状态更新回调,当录制过程状态变化时触发。
capturedDataRecordProgressUpdate 录制进度更新回调。

设备管理

方法名 描述
muteMicrophone 设置是否静音(关闭麦克风)。
isMicrophoneMuted 检查麦克风是否设置为静音。
muteSpeaker 设置是否静音(关闭音频输出)。
isSpeakerMuted 检查音频输出是否静音。
setAudioDeviceMode 设置音频设备模式。
enableAudioCaptureDevice 开/关音频采集设备。
getAudioRouteType 获取当前音频路由。
setAudioRouteToSpeaker 设置音频路由到扬声器。
enableCamera 开/关摄像头,支持设置其他通道的推流。
useFrontCamera 切换前后摄像头,支持指定推流通道。
startSoundLevelMonitor 启动声浪监控,支持开启进阶功能。
stopSoundLevelMonitor 停止声浪监控。
enableHeadphoneMonitor 开启/关闭 耳返。
capturedSoundLevelUpdate 本地采集音频声浪回调。
remoteSoundLevelUpdate 远端拉流音频声浪回调。
localDeviceExceptionOccurred 本地设备异常通知。
remoteCameraStateUpdate 远端摄像头设备状态通知。
remoteMicStateUpdate 远端麦克风设备状态通知。
audioRouteChange 音频设备路由变更通知。

自定义视频采集和渲染

方法名 描述
enableCustomVideoCapture 开始或停止自定义视频采集,支持设置其他通道的推流。
enableCustomVideoProcessing 自定义视频前处理配置开关,支持指定推流通道号。

自定义音频采集和渲染

方法名 描述
enableCustomAudioCaptureProcessing 开启本地采集自定义音频处理(耳返前)。
enableCustomAudioCaptureProcessingAfterHeadphoneMonitor 开启本地采集自定义音频处理(耳返后)。
enableAlignedAudioAuxData 开启抛出与伴奏对齐的音频混音数据功能。
enableBeforeAudioPrepAudioData 开启抛出 SDK 内部音频前处理前的音频数据功能。
enableCustomAudioRemoteProcessing 开启远端拉流自定义音频处理。
enableCustomAudioPlaybackProcessing 开启 SDK 播放的音频数据的自定义音频处理。
enableCustomAudioIO 开启自定义音频 IO 功能,支持其他路推流,支持 PCM 、AAC 格式数据。

媒体推流器

暂不支持

实用工具

方法名 描述
startNetworkSpeedTest 启动网络测速,支持设置测速周期。
stopNetworkSpeedTest 停止网络测速。
getNetworkTimeInfo 获取同步网络时间信息。
networkModeChanged 网络模式变更回调。
networkSpeedTestError 网络测速异常回调。
networkSpeedTestQualityUpdate 网络测速质量回调。
networkQuality 房间内正在推流的用户的网络质量回调。

范围语音

暂不支持

版权音乐

方法名 描述
createCopyrightedMusic 创建版权音乐实例对象。
destroyCopyrightedMusic 销毁版权音乐实例对象。
initCopyrightedMusic 初始化版权音乐模块。
getCacheSize 获取缓存大小。
clearCache 清除缓存。
sendExtendedRequest 发送扩展功能请求。
getLrcLyric 获取 lrc 格式歌词。
getKrcLyricByToken 获取逐字歌词。
requestResource 获取音乐资源。
getSharedResource 获取分享歌曲资源。
download 下载音乐资源。
cancelDownload 取消下载音乐资源。
queryCache 查询资源是否有缓存。
getDuration 获取歌曲或伴奏文件的播放时长。
setScoringLevel 设置打分难度级别。
startScore 开始评分。
pauseScore 暂停评分。
resumeScore 恢复评分。
stopScore 结束评分。
resetScore 重置评分。
getPreviousScore 获取上一句的评分。
getAverageScore 获取平均评分。
getTotalScore 获取总评分。
getFullScore 获取满分。
getStandardPitch 获取标准音高数据。
getCurrentPitch 获取实时音高数据。
downloadProgressUpdate 加载歌曲或伴奏进度回调。
currentPitchValueUpdate 实时音高线回调。
on 注册监听版权音乐事件回调
off 注销监听版权音乐事件回调

废弃接口列表

方法名 描述
enableBeautify 【已废弃】开/关美颜,为任意推流通道设置。此函数在 2.16.0 版本及以上已废弃,请使用 [enableEffectsBeauty] 函数代替。
setBeautifyOption 【已废弃】设置美颜参数。此函数在 2.16.0 版本及以上已废弃,请使用 [setEffectsBeautyParam] 函数代替。
createEngine 【已废弃】创建 ZegoExpressEngine 单例对象并初始化 SDK。此函数在 2.14.0 版本及以上已废弃,请使用不带 [isTestEnv] 参数的同名函数代替。请参考 测试环境废弃说明
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈