提交工单
咨询集成、功能及报价等问题
ZEGO SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为多端提供清晰稳定的实时语音视频云服务。
以下为基本 API 的简要介绍。
方法名 | 描述 |
---|---|
createEngine | 创建 ZegoExpressEngine 单例对象并初始化 SDK。 |
destroyEngine | 销毁 ZegoExpressEngine 单例对象并反初始化 SDK。 |
getEngine | 获取引擎单例对象。 |
setEngineConfig | 设置引擎进阶配置。 |
setEngineConfig | 设置引擎进阶配置,支持设置安卓应用上下文。 |
setLogConfig | 设置日志配置。 |
setRoomMode | 设置房间模式。 |
getVersion | 获取 SDK 版本号。 |
setApiCalledCallback | 设置方法执行结果回调。 |
setEventHandler | 设置事件通知回调。 |
uploadLog | 上传日志到 ZEGO 服务器。 |
uploadLog | 上传日志到 ZEGO 服务器。 |
enableDebugAssistant | 开启调试助手。注意,请勿在线上版本开启此功能!仅在开发阶段使用! |
callExperimentalAPI | 调用 RTC 试验性 API。 |
setDummyCaptureImagePath | 设置关闭摄像头时所推静态图片的路径 |
onDebugError | 调试错误信息回调。 |
onApiCalledResult | 方法执行结果回调。 |
onEngineStateUpdate | 音视频引擎状态更新的回调通知。 |
onNetworkTimeSynchronized | 网络时间同步成功的回调 |
方法名 | 描述 |
---|---|
loginRoom | 登录房间,推拉流前必须登录房间。 |
loginRoom | 使用配置进阶属性的方式登录房间,推拉流前必须登录房间。 |
loginRoom | 使用带配置进阶属性的方式登录房间,通过回调参数返回登录结果,推拉流前必须登录房间。 |
logoutRoom | 退出房间。 |
logoutRoom | 退出房间。 |
logoutRoom | 退出房间。 |
logoutRoom | 退出房间。 |
switchRoom | 切换房间。 |
switchRoom | 使用配置进阶属性的方式切换房间。 |
renewToken | 更新 token 鉴权信息。 |
setRoomExtraInfo | 设置房间附加消息。 |
onRoomStateUpdate | 房间状态变化通知 |
onRoomStateChanged | 房间状态变化通知 |
onRoomUserUpdate | 房间内其他用户增加或减少的回调通知。 |
onRoomOnlineUserCountUpdate | 房间内当前在线用户数量回调。 |
onRoomStreamUpdate | 相同房间内其他用户推的流增加或减少的通知。 |
onRoomStreamExtraInfoUpdate | 房间内流附加信息更新通知。 |
onRoomExtraInfoUpdate | 房间附加信息更新通知。 |
onRoomTokenWillExpire | 房间 Token 鉴权将要过期的回调通知。 |
方法名 | 描述 |
---|---|
createRealTimeSequentialDataManager | 创建实时有序数据管理器对象 |
destroyRealTimeSequentialDataManager | 销毁实时有序数据管理器对象 |
setEventHandler | 设置实时有序数据管理器回调 |
startBroadcasting | 开始广播实时有序数据流。 |
stopBroadcasting | 停止广播实时有序数据流 |
sendRealTimeSequentialData | 在广播中的流 ID 上发送实时有序数据 |
startSubscribing | 开始订阅实时有序数据流。 |
stopSubscribing | 停止订阅实时有序数据流。 |
getIndex | 获取实时有序数据管理器索引。 |
onReceiveRealTimeSequentialData | 收到实时有序数据回调 |
sendBroadcastMessage | 发送房间广播消息。 |
sendBarrageMessage | 发送房间弹幕消息。 |
sendCustomCommand | 发送自定义信令。 |
onIMRecvBroadcastMessage | 接收房间广播消息通知。 |
onIMRecvBarrageMessage | 接收房间弹幕消息通知。 |
onIMRecvCustomCommand | 接收自定义信令通知。 |
方法名 | 描述 |
---|---|
startMixerTask | 开始混流任务。 |
stopMixerTask | 停止混流任务。 |
startAutoMixerTask | 开始自动混流任务 |
stopAutoMixerTask | 停止自动混流任务 |
onMixerRelayCDNStateUpdate | 混流转推 CDN 状态更新通知。 |
onMixerSoundLevelUpdate | 混流中的每条单流的的声浪更新通知。 |
onAutoMixerSoundLevelUpdate | 自动混流中的每条单流的的声浪更新通知 |
方法名 | 描述 |
---|---|
enableAEC | 是否开启回声消除。 |
enableHeadphoneAEC | 是否在使用耳机时开启回声消除。 |
setAECMode | 设置回声消除模式 |
enableAGC | 开/关自动增益控制 |
enableANS | 开/关噪声抑制 |
enableTransientANS | 开/关瞬态噪声抑制 |
setANSMode | 设置音频噪声抑制模式 |
enableAudioMixing | 开/关混音功能 |
setAudioMixingHandler | 设置混音回调 |
muteLocalAudioMixing | 静音或恢复本地播放混音声音。 |
setAudioMixingVolume | 设置混音音量(同时设置本地和远端的音量) |
setAudioMixingVolume | 设置混音音量(可分别设置本地、远端的音量) |
startEffectsEnv | 开启 Effects 美颜环境。 |
stopEffectsEnv | 关闭 Effects 美颜环境。 |
enableEffectsBeauty | 开启或关闭美颜效果。 |
setEffectsBeautyParam | 设置美颜效果参数。 |
setAudioEqualizerGain | 设置音效均衡器(EQ)。 |
setVoiceChangerPreset | 通过预设枚举设置变声。 |
setVoiceChangerParam | 设置变声的具体参数。 |
setReverbPreset | 通过预设枚举设置混响。 |
setReverbAdvancedParam | 设置混响的具体参数。 |
setReverbEchoParam | 设置混响回声效果的具体参数。 |
enableVirtualStereo | 开启或关闭推流时的虚拟立体声效果。 |
enablePlayStreamVirtualStereo | 开启或关闭拉流时的虚拟立体声效果。 |
setElectronicEffects | 开启或关闭电音效果。 |
onAudioMixingCopyData | 混音数据回调。 |
方法名 | 描述 |
---|---|
createAudioEffectPlayer | 创建音效播放器实例对象。 |
destroyAudioEffectPlayer | 销毁音效播放器实例对象。 |
setEventHandler | 设置音效播放器回调。 |
start | 开始播放音效。 |
stop | 停止播放音效。 |
pause | 暂停播放音效。 |
resume | 恢复播放音效。 |
stopAll | 停止播放所有音效。 |
pauseAll | 暂停播放所有音效。 |
resumeAll | 恢复播放所有音效。 |
seekTo | 设置播放进度。 |
setVolume | 设置单个音效的播放音量,会同时设置本地播放音量和推流音量。 |
setVolumeAll | 设置所有音效的播放音量,会同时设置本地播放音量和推流音量。 |
setPlaySpeed | 设置指定音效的播放速度,会同时设置本地播放速度和推流速度(不支持单独设置)。 |
getTotalDuration | 获取指定音效资源的总长度。 |
getCurrentProgress | 获取当前播放进度。 |
loadResource | 加载音效资源。 |
unloadResource | 卸载音效资源。 |
getIndex | 获取音效播放器索引。 |
onAudioEffectPlayStateUpdate | 音效播放状态回调。 |
方法名 | 描述 |
---|---|
startRecordingCapturedData | 开始本地录制,直接将音视频数据录制到本地文件。 |
stopRecordingCapturedData | 结束录制本端音频或音视频。 |
setDataRecordEventHandler | 设置数据录制事件回调。 |
onCapturedDataRecordStateUpdate | 本地录制的状态更新回调,当录制过程状态变化时触发。 |
onCapturedDataRecordProgressUpdate | 录制进度更新回调。 |
方法名 | 描述 |
---|---|
enableCustomVideoRender | 开始或停止自定义视频渲染。 |
setCustomVideoRenderHandler | 设置自定义视频渲染回调。 |
enableCustomVideoCapture | 开始或停止自定义视频采集。 |
enableCustomVideoCapture | 开始或停止自定义视频采集,支持设置其他通道的推流。 |
setCustomVideoCaptureHandler | 设置自定义视频采集回调。 |
sendCustomVideoCaptureRawData | 给 SDK 发送自定义采集的视频帧原始数据。 |
sendCustomVideoCaptureRawData | 给 SDK 发送自定义采集的视频帧原始数据,支持其他路推流。 |
sendCustomVideoCaptureTextureData | 向 SDK 发送自定义采集的视频帧 Texture 数据。 |
sendCustomVideoCaptureTextureData | 向 SDK 发送自定义采集的视频帧 Texture 数据,支持其他路推流。 |
getCustomVideoCaptureSurfaceTexture | 获取 SurfaceTexture 实例,使用主通道的推流 |
getCustomVideoCaptureSurfaceTexture | 获取 SurfaceTexture 实例,支持设置其他通道的推流 |
sendCustomVideoCaptureEncodedData | 给 SDK 发送自定义采集的视频帧编码后的数据。 |
sendCustomVideoCaptureEncodedData | 给 SDK 发送自定义采集的视频帧编码后的数据,支持其他路推流 |
setCustomVideoCaptureFillMode | 设置自定义视频采集画面缩放填充模式。 |
setCustomVideoCaptureFillMode | 设置自定义视频采集画面缩放填充模式,支持其他路推流 |
setCustomVideoCaptureFlipMode | 设置自定义采集画面翻转模式,仅当自定义采集类型为 Texture2D 时,此函数生效。 |
setCustomVideoCaptureFlipMode | 设置自定义采集画面翻转模式,支持其他路推流。仅当自定义采集类型为 Texture2D 时,此函数生效。 |
setCustomVideoCaptureRotation | 设置指定推流通道自定义采集画面旋转角度。 |
setCustomVideoCaptureDeviceState | 设置指定推流通道自定义采集设备状态。 |
setCustomVideoCaptureTransformMatrix | 设置指定推流通道自定义采集画面转换矩阵。 |
setCustomVideoCaptureRegionOfInterest | 设置指定推流通道自定义视频采集编码器的感兴趣区域(ROI)。 |
onStart | 自定义视频采集开始的通知。 |
onStop | 自定义视频采集结束的通知。 |
onEncodedDataTrafficControl | 自定义视频采集时检测到网络变化,通知开发者需要做流量控制,根据SDK的推荐参数调整编码配置。 |
onCapturedVideoFrameRawData | 开启自定义视频渲染时,本地预览采集的原始视频帧数据回调。 |
onRemoteVideoFrameRawData | 开启自定义视频渲染时,远端拉流原始视频帧数据回调,通过 streamID 区分不同的流。 |
onRemoteVideoFrameEncodedData | 开启自定义视频渲染时,远端拉流视频帧编码数据回调,通过 streamID 区分不同的流。 |
enableCustomVideoProcessing | 自定义视频前处理配置开关。 |
enableCustomVideoProcessing | 自定义视频前处理配置开关。 |
setCustomVideoProcessHandler | 设置自定义视频前处理回调。 |
sendCustomVideoProcessedTextureData | 将自定义视频前处理后的 [Texture] 类型视频数据发送给 SDK。 |
sendCustomVideoProcessedTextureData | 将自定义视频前处理后的 [Texture] 类型视频数据发送给 SDK。支持其他路推流。 |
onStart | SDK 通知开发者将要开始进行视频前处理。 |
onStop | SDK 通知开发者停止进行视频前处理。 |
getCustomVideoProcessOutputSurfaceTexture | 获取用于输出数据的 SurfaceTexture。 |
getCustomVideoProcessOutputSurfaceTexture | 获取用于输出数据的 SurfaceTexture。支持其他路推流 |
onCapturedUnprocessedTextureData | 当 SDK 获取到 [Texture] 类型的原始视频数据时回调。 |
getCustomVideoProcessInputSurfaceTexture | 当开发者选用 SurfaceTexture 视频前处理类型时,通过此接口获取用于输入原始视频数据的 SurfaceTexture 并传给 SDK。 |
方法名 | 描述 |
---|---|
startPerformanceMonitor | 启动系统性能监控。 |
stopPerformanceMonitor | 停止系统性能监控。 |
startNetworkProbe | 启动网络探测。 |
stopNetworkProbe | 停止网络探测。 |
testNetworkConnectivity | 测试网络连通性 |
startNetworkSpeedTest | 启动网络测速。 |
startNetworkSpeedTest | 启动网络测速,支持设置测速周期。 |
stopNetworkSpeedTest | 停止网络测速。 |
getNetworkTimeInfo | 获取同步网络时间信息。 |
onPerformanceStatusUpdate | 系统性能监控状态回调(注意:由于 Android 系统限制,无法获取 CPU 使用量) |
onNetworkModeChanged | 网络模式变更回调。 |
onNetworkSpeedTestError | 网络测速异常回调。 |
onNetworkSpeedTestQualityUpdate | 网络测速质量回调。 |
onRecvExperimentalAPI | 接收实验性 API JSON 内容。 |
onNetworkQuality | 房间内正在推流的用户的网络质量回调。 |
方法名 | 描述 |
---|---|
createRangeAudio | 创建范围语音实例对象。 |
destroyRangeAudio | 销毁范围语音实例对象。 |
setEventHandler | 设置范围语音回调。 |
setAudioReceiveRange | 设置音频接收距离的最大范围。 |
updateSelfPosition | 更新自身的位置和朝向。 |
updateAudioSource | 添加或更新音源位置信息。 |
enableSpatializer | 开启或关闭 3D 音效。 |
enableMicrophone | 开启或关闭麦克风。 |
enableSpeaker | 开启或关闭扬声器。 |
setRangeAudioMode | 设置范围语音模式。 |
setTeamID | 设置队伍 ID |
muteUser | 是否可接收指定用户音频数据。 |
onRangeAudioMicrophoneStateUpdate | 范围语音麦克风使用状态回调。 |
方法名 | 描述 |
---|---|
createCopyrightedMusic | 创建版权音乐实例对象。 |
destroyCopyrightedMusic | 销毁版权音乐实例对象。 |
setEventHandler | 设置版权音乐回调。 |
initCopyrightedMusic | 初始化版权音乐模块。 |
getCacheSize | 获取缓存大小。 |
clearCache | 清除缓存。 |
sendExtendedRequest | 发送扩展功能请求。 |
getLrcLyric | 获取 lrc 格式歌词。 |
getKrcLyricByToken | 获取 krc 格式歌词。 |
requestSong | 点歌。 |
requestAccompaniment | 点伴奏。 |
requestAccompanimentClip | 点伴奏高潮片段。 |
getMusicByToken | 获取歌曲或伴奏。 |
download | 下载歌曲或伴奏。 |
queryCache | 查询资源是否有缓存。 |
getDuration | 获取歌曲或伴奏文件的播放时长。 |
startScore | 开始评分。 |
pauseScore | 暂停评分。 |
resumeScore | 恢复评分。 |
stopScore | 结束评分。 |
resetScore | 重置评分。 |
getPreviousScore | 获取上一句的评分。 |
getAverageScore | 获取平均评分。 |
getTotalScore | 获取总评分。 |
getStandardPitch | 获取标准音高数据。 |
getCurrentPitch | 获取实时音高数据。 |
onDownloadProgressUpdate | 加载歌曲或伴奏进度回调。 |
onCurrentPitchValueUpdate | 实时音高线回调。 |
方法名 | 描述 |
---|---|
enableBeautify | 开/关美颜,为主推流通道设置。 |
enableBeautify | 开/关美颜,为任意推流通道设置 |
setBeautifyOption | 设置美颜参数。 |
setBeautifyOption | 设置美颜参数。 |
createEngine | 【已废弃】创建 ZegoExpressEngine 单例对象并初始化 SDK。 |
setDebugVerbose | 【已废弃】设置调试详细信息开关以及语言。此函数在 2.3.0 版本废弃,请使用 [enableDebugAssistant] 来实现原来的功能。 |
loginMultiRoom | 【已废弃】登录多房间。此方法在版本 2.9.0 以后已废弃,若需实现多房间功能,请先在引擎初始化之前调用 [setRoomMode] 函数设置多房间模式,再使用 [loginRoom] 登录多房间,如果调用 [loginRoom] 函数登录多房间,请确保传入相同的用户信息。 |
setPlayStreamVideoLayer | 【已废弃】设置选取拉流视频图层。此函数在 2.3.0 版本以后已废弃, 请使用 [setPlayStreamVideoType] 代替。 |
enableAudioDataCallback | 【已废弃】开启额外接收音频数据的回调。此函数在 2.7.0 版本以后已废弃,请使用 [startAudioDataObserver] 和 [stopAudioDataObserver] 代替。 |
setReverbParam | 【已废弃】设置混响的具体参数。此函数在 1.18.0 版本以后已废弃,请使用 [setReverbAdvancedParam] 代替。 |
setBuiltInSpeakerOn | 【已废弃】是否使用内置扬声器播放声音。此函数在 2.3.0 版本以后已废弃,请使用 [setAudioRouteToSpeaker] 代替。 |
onRoomStreamUpdate | 【已废弃】相同房间内其他用户推的流增加或减少的通知。此回调函数自 1.18.0 起已废弃,请使用带 [extendedData] 参数的同名回调函数。 |
onDeviceError | 【已废弃】设备异常通知。此函数在 2.15.0 版本及以上已废弃,请使用 [onLocalDeviceExceptionOccurred] 代替。 |
onNetworkQuality | 【已废弃】回报房间中流的网络质量。此回调函数在 2.10.0 版本及以上已废弃,请使用带 [ZegoStreamQualityLevel] 枚举参数的同名回调代替。 |
onProcessCapturedAudioData | 【已废弃】自定义音频处理本地采集 PCM 音频帧回调。此回调函数在 2.13.0 版本及以上已废弃,请使用带 [timestamp] 参数的同名回调函数。 |
onProcessRemoteAudioData | 【已废弃】自定义音频处理远端拉流 PCM 音频帧回调。此回调函数在 2.13.0 版本及以上已废弃,请使用带 [timestamp] 参数的同名回调函数。 |
onProcessPlaybackAudioData | 【已废弃】自定义音频处理 SDK 播放音频的 PCM 音频帧回调。此回调函数在 2.13.0 版本及以上已废弃,请使用带 [timestamp] 参数的同名回调函数。 |
联系我们
文档反馈