提交工单
咨询集成、功能及报价等问题
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
超低延迟直播 中文站 English
- 文档中心
- 超低延迟直播
- 客户端 API
- 功能总览
功能总览
更新时间：2023-12-13 21:56
ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。
API 返回的错误码请参考：https://doc-zh.zego.im/article/4378。
以下为基本的 API 简要介绍。
初始化相关的前置功能
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| CreateEngine | 创建 ZegoExpressEngine 单例对象并初始化 SDK。 | 是 |
| DestroyEngine | 销毁 ZegoExpressEngine 单例对象并反初始化 SDK。 | 是 |
| GetEngine | 获取引擎单例对象。 | 是 |
| SetEngineConfig | 设置引擎进阶配置。 | 是 |
| SetLogConfig | 设置日志配置。 | 否 |
| SetLocalProxyConfig | 设置本地代理配置。 | 否 |
| SetCloudProxyConfig | 设置云代理配置。 | 否 |
| SetRoomMode | 设置房间模式。 | 否 |
| GetVersion | 获取 SDK 版本号。 | 是 |
| IsFeatureSupported | 查询当前 SDK 是否支持指定的功能特性。 | 否 |
| SetRoomScenario | 设置房间场景。 | 是 |
| UploadLog | 上传日志到 ZEGO 服务器。 | 否 |
| SubmitLog | 上传日志到 ZEGO 服务器。 | 否 |
| EnableDebugAssistant | 开启调试助手。注意，请勿在线上版本开启此功能！仅在开发阶段使用！ | 否 |
| CallExperimentalAPI | 调用实验性 API。 | 否 |
| OnDebugError | 调试错误信息回调。 | 否 |
| OnApiCalledResult | 方法执行结果回调。 | 否 |
| OnEngineStateUpdate | 音视频引擎状态更新的回调通知。 | 否 |
| OnRecvExperimentalAPI | 实验性 API 回调。 | 否 |
房间功能
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| LoginRoom | 使用配置进阶属性的方式登录房间，推拉流前必须登录房间。 | 是 |
| LoginRoom | 使用带配置进阶属性的方式登录房间，通过回调参数返回登录结果，推拉流前必须登录房间。 | 是 |
| LogoutRoom | 退出房间，带回调。 | 是 |
| LogoutRoom | 退出指定房间 ID 的房间，并带有回调。 | 是 |
| SwitchRoom | 使用配置进阶属性的方式切换房间。 | 否 |
| RenewToken | 更新 token 鉴权信息。 | 是 |
| SetRoomExtraInfo | 设置房间附加消息。 | 是 |
| OnRoomStateUpdate | 房间状态变化通知。 | 是 |
| OnRoomStateChanged | 房间状态变化通知，包含具体的状态变化原因。 | 是 |
| OnRoomUserUpdate | 房间内其他用户增加或减少的回调通知。 | 是 |
| OnRoomOnlineUserCountUpdate | 房间内当前在线用户数量回调。 | 否 |
| OnRoomStreamUpdate | 相同房间内其他用户推的流增加或减少的通知。 | 是 |
| OnRoomStreamExtraInfoUpdate | 房间内流附加信息更新通知。 | 是 |
| OnRoomExtraInfoUpdate | 房间附加信息更新通知。 | 是 |
| OnRoomTokenWillExpire | 房间 Token 鉴权将要过期的回调通知。 | 是 |
推流功能
拉流功能
信令消息功能
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| CreateRealTimeSequentialDataManager | 创建实时有序数据管理器对象。 | 否 |
| DestroyRealTimeSequentialDataManager | 销毁实时有序数据管理器对象。 | 否 |
| StartBroadcasting | 开始广播实时有序数据流。 | 否 |
| StopBroadcasting | 停止广播实时有序数据流。 | 否 |
| SendRealTimeSequentialData | 在广播中的流 ID 上发送实时有序数据。 | 否 |
| StartSubscribing | 开始订阅实时有序数据流。 | 否 |
| StopSubscribing | 停止订阅实时有序数据流。 | 否 |
| GetIndex | 获取实时有序数据管理器索引。 | 否 |
| OnReceiveRealTimeSequentialData | 收到实时有序数据回调。 | 否 |
| SendBroadcastMessage | 发送房间广播消息。 | 否 |
| SendBarrageMessage | 发送房间弹幕消息。 | 否 |
| SendCustomCommand | 发送自定义信令。 | 否 |
| OnIMRecvBroadcastMessage | 接收房间广播消息通知。 | 否 |
| OnIMRecvBarrageMessage | 接收房间弹幕消息通知。 | 否 |
| OnIMRecvCustomCommand | 接收自定义信令通知。 | 否 |
混流功能
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| StartMixerTask | 开始混流任务。 | 否 |
| StopMixerTask | 停止混流任务。 | 否 |
| StartAutoMixerTask | 开始自动混流任务。 | 否 |
| StopAutoMixerTask | 停止自动混流任务。 | 否 |
| OnMixerRelayCDNStateUpdate | 混流转推 CDN 状态更新通知。 | 否 |
| OnMixerSoundLevelUpdate | 混流中的每条单流的声浪更新通知。 | 否 |
| OnAutoMixerSoundLevelUpdate | 自动混流中的每条单流的声浪更新通知。 | 否 |
音视频前处理
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| EnableAEC | 是否开启回声消除。 | 否 |
| EnableHeadphoneAEC | 是否在使用耳机时开启回声消除。 | 否 |
| SetAECMode | 设置回声消除模式。 | 否 |
| EnableAGC | 开/关自动增益控制。 | 否 |
| EnableANS | 开/关噪声抑制。 | 否 |
| EnableTransientANS | 开/关瞬态噪声抑制。 | 否 |
| SetANSMode | 设置音频噪声抑制模式。 | 否 |
| SetVoiceChangerPreset | 通过预设枚举设置变声。 | 否 |
| SetVoiceChangerParam | 设置变声的具体参数。 | 否 |
| SetReverbPreset | 通过预设枚举设置混响。 | 否 |
| SetReverbAdvancedParam | 设置混响的具体参数。 | 否 |
| SetReverbEchoParam | 设置混响回声效果的具体参数。 | 否 |
| EnableVirtualStereo | 开启或关闭推流时的虚拟立体声效果。 | 否 |
| EnablePlayStreamVirtualStereo | 开启或关闭拉流时的虚拟立体声效果。 | 否 |
| EnableColorEnhancement | 开启色彩增强。 | 否 |
媒体播放器功能
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| CreateMediaPlayer | 创建媒体播放器实例对象。 | 否 |
| DestroyMediaPlayer | 销毁媒体播放器实例对象。 | 否 |
| SetVideoHandler | 设置媒体播放器的视频数据回调。 | 否 |
| SetAudioHandler | 设置媒体播放器的音频数据回调。 | 否 |
| LoadResource | 加载本地或者网络媒体资源。 | 否 |
| LoadResourceWithPosition | 加载本地或者网络媒体资源，并指定开始位置。 | 否 |
| LoadResourceFromMediaData | 加载二进制的音频媒体资源。 | 否 |
| LoadCopyrightedMusicResourceWithPosition | 加载版权音乐资源。 | 否 |
| Start | 开始播放。 | 否 |
| Stop | 停止播放。 | 否 |
| Pause | 暂停播放。 | 否 |
| Resume | 恢复播放。 | 否 |
| SeekTo | 设置指定的播放进度。 | 否 |
| EnableRepeat | 是否重复播放。 | 否 |
| SetPlayLoopCount | 设置播放循环次数。 | 否 |
| SetPlaySpeed | 设置播放倍速。 | 否 |
| EnableAux | 是否将播放器的声音混入正在推的流中。 | 否 |
| MuteLocal | 是否静默本地播放。 | 否 |
| SetVolume | 设置播放器音量，会同时设置本地播放音量和推流音量。 | 否 |
| SetPlayVolume | 设置播放器本地播放音量。 | 否 |
| SetPublishVolume | 设置播放器推流音量。 | 否 |
| SetProgressInterval | 设置播放进度回调间隔。 | 否 |
| GetPlayVolume | 获取当前媒体播放器本地播放的音量，范围为 0 ~ 200，默认值为 60。 | 否 |
| GetPublishVolume | 获取当前媒体播放器推流的音量，范围为 0 ~ 200，默认值为 60。 | 否 |
| GetTotalDuration | 获取媒体资源的总进度。 | 否 |
| GetCurrentProgress | 获取当前播放进度。 | 否 |
| GetAudioTrackCount | 获取播放文件的音轨个数。 | 否 |
| SetAudioTrackIndex | 设置播放文件的音轨。 | 否 |
| SetVoiceChangerParam | 设置变声的具体参数。 | 否 |
| GetCurrentState | 获取当前播放状态。 | 否 |
| GetIndex | 获取媒体播放器的序号。 | 否 |
| EnableAccurateSeek | 开启精准 seek 并设置相关属性。 | 否 |
| SetNetWorkResourceMaxCache | 设置网络素材最大的缓存时长和缓存数据大小。 | 否 |
| GetNetWorkResourceCache | 获取当前网络素材缓存队列的缓存数据可播放的时长和缓存数据大小。 | 否 |
| SetNetWorkBufferThreshold | 通过该接口设置媒体播放器重新恢复播放需要达到的缓存阈值,SDK 默认值是 5000ms,有效值为大于等于1000ms。 | 否 |
| EnableSoundLevelMonitor | 是否开启声浪监听。 | 否 |
| EnableFrequencySpectrumMonitor | 是否开启频谱监听。 | 否 |
| UpdatePosition | 更新媒体播放器(音频源)位置。 | 否 |
| SetHttpHeader | 设置 http 头信息。 | 否 |
| OnMediaPlayerStateUpdate | 媒体播放器播放状态回调。 | 否 |
| OnMediaPlayerNetworkEvent | 媒体播放器网络状态事件回调。 | 否 |
| OnMediaPlayerPlayingProgress | 播放器播放进度回调。 | 否 |
| OnMediaPlayerRecvSEI | 媒体次要信息回调。 | 否 |
| OnMediaPlayerSoundLevelUpdate | 声浪更新回调。 | 否 |
| OnMediaPlayerFrequencySpectrumUpdate | 频谱更新回调。 | 否 |
| OnVideoFrame | 播放器抛视频数据的回调，带视频帧附加信息。 | 否 |
| OnAudioFrame | 播放器抛音频数据的回调。 | 否 |
| OnCapturedUnprocessedRawData | 当获取到原始视频数据时回调。 | 否 |
音效播放器功能
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| CreateAudioEffectPlayer | 创建音效播放器实例对象。 | 否 |
| DestroyAudioEffectPlayer | 销毁音效播放器实例对象。 | 否 |
| Start | 开始播放音效。 | 否 |
| Stop | 停止播放音效。 | 否 |
| Pause | 暂停播放音效。 | 否 |
| Resume | 恢复播放音效。 | 否 |
| StopAll | 停止播放所有音效。 | 否 |
| PauseAll | 暂停播放所有音效。 | 否 |
| ResumeAll | 恢复播放所有音效。 | 否 |
| SeekTo | 设置播放进度。 | 否 |
| SetVolume | 设置单个音效的播放音量，会同时设置本地播放音量和推流音量。 | 否 |
| SetVolumeAll | 设置所有音效的播放音量，会同时设置本地播放音量和推流音量。 | 否 |
| GetTotalDuration | 获取指定音效资源的总长度。 | 否 |
| GetCurrentProgress | 获取当前播放进度。 | 否 |
| LoadResource | 加载音效资源。 | 否 |
| UnloadResource | 卸载音效资源。 | 否 |
| UpdatePosition | 更新音效播放器(音频源)位置。 | 否 |
| GetIndex | 获取音效播放器索引。 | 否 |
| OnAudioEffectPlayStateUpdate | 音效播放状态回调。 | 否 |
录制功能
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| StartRecordingCapturedData | 开始本地录制，直接将音视频数据录制到本地文件。 | 否 |
| StopRecordingCapturedData | 结束录制本端音频或音视频。 | 否 |
| OnCapturedDataRecordStateUpdate | 本地录制的状态更新回调，当录制过程状态变化时触发。 | 否 |
| OnCapturedDataRecordProgressUpdate | 录制进度更新回调。 | 否 |
设备管理
自定义视频采集和渲染
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| EnableCustomVideoCapture | 开始或停止自定义视频采集，支持设置其他通道的推流。 | 否 |
| SendCustomVideoCaptureRawData | 给 SDK 发送自定义采集的视频帧原始数据，支持其他路推流。 | 否 |
| SendCustomVideoCaptureRawData | 给 SDK 发送自定义采集的视频帧原始数据，支持其他路推流。 | 否 |
| OnCustomVideoCaptureStart | 自定义视频采集开始的通知。 | 否 |
| OnCustomVideoCaptureStop | 自定义视频采集结束的通知。 | 否 |
| EnableCustomVideoProcessing | 自定义视频前处理配置开关，支持指定推流通道号。 | 否 |
| SendCustomVideoProcessedRawData | 将自定义视频前处理后的原始视频数据发送给 SDK，支持其他路推流。 | 否 |
| SendCustomVideoProcessedCVPixelBuffer | 将自定义视频前处理后的 [CVPixelBuffer] 类型视频数据发送给 SDK。支持其他路推流。 | 否 |
| SendCustomVideoProcessedTextureData | 将自定义视频前处理后的 [Texture] 类型视频数据发送给 SDK。支持其他路推流。 | 否 |
| OnCapturedUnprocessedRawData | 当获取到原始视频数据时回调。 | 否 |
| OnCapturedUnprocessedCVPixelBuffer | 当获取到 [CVPixelBuffer] 类型的原始视频数据时回调。 | 否 |
| OnCapturedUnprocessedTextureData | 当 SDK 获取到 [Texture] 类型的原始视频数据时回调。 | 否 |
自定义音频采集和渲染
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| StartAudioDataObserver | 开启音频数据回调监测。 | 否 |
| StopAudioDataObserver | 停止音频数据回调监测。 | 否 |
| EnableCustomAudioIO | 开启自定义音频 IO 功能，支持其他路推流，支持 PCM 、AAC 格式数据。 | 否 |
| SendCustomAudioCaptureAACData | 发送自定义音频采集 AAC 数据，支持设置其他通道的推流。 | 否 |
| SendCustomAudioCapturePCMData | 发送自定义音频采集 PCM 数据，支持其他路推流。 | 否 |
| FetchCustomAudioRenderPCMData | 从 SDK 取远端拉流自定义音频渲染 PCM 数据。 | 否 |
| OnCapturedAudioData | 获取本地麦克风采集到的音频数据的回调。 | 否 |
| OnPlaybackAudioData | 获取 SDK 播放的音频数据的回调。 | 否 |
| OnMixedAudioData | 获取 SDK 播放的音频数据和本地麦克风采集到的音频数据的回调，该音频数据是经过 SDK 混合之后的数据。 | 否 |
| OnPlayerAudioData | 获取 SDK 每条拉流的音频数据的回调。 | 否 |
实用工具
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| GetNetworkTimeInfo | 获取同步网络时间信息。 | 否 |
| OnNetworkQuality | 房间内正在推流的用户的网络质量回调。 | 否 |
| OnNetworkTimeSynchronized | 网络时间同步成功的回调。 | 否 |
范围语音
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| CreateRangeAudio | 创建范围语音实例对象。 | 否 |
| DestroyRangeAudio | 销毁范围语音实例对象。 | 否 |
| SetAudioReceiveRange | 设置音频接收距离的最大范围。 | 否 |
| SetRangeAudioVolume | 设置范围语音音量。 | 否 |
| UpdateSelfPosition | 更新自身的位置和朝向。 | 否 |
| UpdateAudioSource | 添加或更新音源位置信息。 | 否 |
| EnableSpatializer | 开启或关闭 3D 音效。 | 否 |
| EnableMicrophone | 开启或关闭麦克风。 | 否 |
| EnableSpeaker | 开启或关闭扬声器。 | 否 |
| SetRangeAudioMode | 设置范围语音模式。 | 否 |
| SetRangeAudioCustomMode | 设置范围语音的高阶自定义模式。 | 否 |
| SetTeamID | 设置队伍 ID。 | 否 |
| MuteUser | 是否可接收指定用户音频数据。 | 否 |
| OnRangeAudioMicrophoneStateUpdate | 范围语音麦克风使用状态回调。 | 否 |
版权音乐
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| CreateCopyrightedMusic | 创建版权音乐实例对象。 | 否 |
| DestroyCopyrightedMusic | 销毁版权音乐实例对象。 | 否 |
| InitCopyrightedMusic | 初始化版权音乐模块。 | 否 |
| GetCacheSize | 获取缓存大小。 | 否 |
| ClearCache | 清除缓存。 | 否 |
| SendExtendedRequest | 发送扩展功能请求。 | 否 |
| GetLrcLyric | 获取 lrc 格式歌词。 | 否 |
| GetKrcLyricByToken | 获取逐字歌词。 | 否 |
| RequestResource | 获取音乐资源。 | 否 |
| GetSharedResource | 获取分享歌曲资源。 | 否 |
| Download | 下载歌曲或伴奏。 | 否 |
| QueryCache | 查询资源是否有缓存。 | 否 |
| GetDuration | 获取歌曲或伴奏文件的播放时长。 | 否 |
| StartScore | 开始评分。 | 否 |
| PauseScore | 暂停评分。 | 否 |
| ResumeScore | 恢复评分。 | 否 |
| StopScore | 结束评分。 | 否 |
| ResetScore | 重置评分。 | 否 |
| GetPreviousScore | 获取上一句的评分。 | 否 |
| GetAverageScore | 获取平均评分。 | 否 |
| GetTotalScore | 获取总评分。 | 否 |
| GetFullScore | 获取满分。 | 否 |
| GetStandardPitch | 获取标准音高数据。 | 否 |
| GetCurrentPitch | 获取实时音高数据。 | 否 |
| OnDownloadProgressUpdate | 加载歌曲或伴奏进度回调。 | 否 |
| OnCurrentPitchValueUpdate | 实时音高线回调。 | 否 |
范围场景
| 方法名 | 描述 | 是否支持 WebGL |
|---|---|---|
| SetReceiveRange | 设置音视频流的接收范围。 | 否 |
| EnableRangeSpatializer | 开启或关闭 3D 空间音效。 | 否 |
| MutePlayAudio | 设置是否接收指定用户的音频数据。 | 否 |
| MutePlayVideo | 设置是否接收指定用户的视频数据。 | 否 |
| OnUserStreamStateUpdate | 本端拉其他用户的流状态变更回调通知。 | 否 |
| OnUserMicUpdate | 用户麦克风状态变更回调。 | 否 |
| OnUserCameraUpdate | 用户摄像头状态变更回调。 | 否 |
| OnUserSpeakerUpdate | 用户扬声器状态变更回调。 | 否 |
| CreateRangeScene | 创建范围场景实例对象。 | 否 |
| DestroyRangeScene | 销毁范围场景实例对象。 | 否 |
| GetRangeSceneStream | 获取范围场景流管理实例对象。 | 否 |
| GetRangeSceneHandle | 获取范围场景实例句柄。 | 否 |
| LoginScene | 登录场景。 | 否 |
| LogoutScene | 退出场景。 | 否 |
| UpdateUserStatus | 更新用户的状态。 | 否 |
| UpdateUserCommand | 更新用户的指令。 | 否 |
| UpdateUserPosition | 更新用户的位置。 | 否 |
| GetUserCount | 获取场景内总人数。 | 否 |
| GetUserListInView | 获取范围内用户列表。 | 否 |
| SendCustomCommand | 发送用户自定义信令。 | 否 |
| RenewToken | 更新 Token 鉴权信息。 | 否 |
| SetStreamConfig | 设置场景推拉流模式。 | 否 |
| OnSceneStateUpdate | 场景状态变化通知。 | 否 |
| OnEnterView | 其他用户进入当前用户视野范围回调。 | 否 |
| OnLeaveView | 其他用户离开当前用户视野范围回调通知。 | 否 |
| OnUserStatusUpdate | 用户状态变更回调。 | 否 |
| OnUserCommandUpdate | 用户指令变更回调。 | 否 |
| OnCustomCommandUpdate | 用户自定义信令变更回调。 | 否 |
| OnSceneTokenWillExpire | 场景 Token 鉴权将要过期的回调通知。 | 否 |
废弃接口列表
| 方法名 | 描述 |
|---|---|
| EnableBeautify | 【已废弃】开/关美颜，为任意推流通道设置。此函数在 2.16.0 版本及以上已废弃，请使用 [enableEffectsBeauty] 函数代替。 |
| SetBeautifyOption | 【已废弃】设置美颜参数。此函数在 2.16.0 版本及以上已废弃，请使用 [setEffectsBeautyParam] 函数代替。 |
| CreateEngine | 【已废弃】创建 ZegoExpressEngine 单例对象并初始化 SDK。此函数在 2.14.0 版本及以上已废弃，请使用不带 [isTestEnv] 参数的同名函数代替。请参考 测试环境废弃说明 |
| RequestSong | 【已废弃】点歌。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。 |
| RequestAccompaniment | 【已废弃】点伴奏。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。 |
| RequestAccompanimentClip | 【已废弃】点伴奏高潮片段。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。 |
| GetMusicByToken | 【已废弃】获取歌曲或伴奏。此函数在 3.0.2 版本及以上已废弃，请使用 [getSharedResource] 函数代替。 |
| GetLrcLyric | 【已废弃】获取 lrc 格式歌词。此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。 |
| QueryCache | 【已废弃】查询资源是否有缓存。此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。 |
本篇目录
- 免费试用
- 电话咨询400 1006 604咨询客服微信扫码，24h在线
联系我们
文档反馈
