提交工单
咨询集成、功能及报价等问题
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
在线KTV 中文站 English
- 文档中心
- 在线KTV
- 客户端 API
- 功能总览
功能总览
更新时间：2023-06-02 11:33
ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。
API 返回的错误码请参考：https://doc-zh.zego.im/article/4378。
以下为基本的 API 简要介绍。
初始化相关的前置功能
| 方法名 | 描述 |
|---|---|
| createEngineWithProfile:eventHandler: | 创建 ZegoExpressEngine 单例对象并初始化 SDK。 |
| destroyEngine: | 销毁 ZegoExpressEngine 单例对象并反初始化 SDK。 |
| sharedEngine | 获取引擎单例对象。 |
| setEngineConfig: | 设置引擎进阶配置。 |
| setLogConfig: | 设置日志配置。 |
| setLocalProxyConfig:enable: | 设置本地代理配置 |
| setCloudProxyConfig:token:enable: | 设置云代理配置 |
| setLicense: | 设置 License 鉴权。 |
| setRoomMode: | 设置房间模式。 |
| setGeoFence:area | 设置地理围栏。 |
| getVersion | 获取 SDK 版本号。 |
| setApiCalledCallback: | 设置方法执行结果回调。 |
| isFeatureSupported: | 查询当前 SDK 是否支持指定的功能特性。 |
| setEventHandler: | 设置事件通知回调。 |
| setRoomScenario: | 设置房间场景。 |
| uploadLog | 上传日志到 ZEGO 服务器。 |
| uploadLog: | 上传日志到 ZEGO 服务器。 |
| enableDebugAssistant: | 开启调试助手。注意，请勿在线上版本开启此功能！仅在开发阶段使用！ |
| callExperimentalAPI: | 调用实验性 API。 |
| onDebugError:funcName:info: | 调试错误信息回调。 |
| onApiCalledResult:funcName:info: | 方法执行结果回调。 |
| onEngineStateUpdate: | 音视频引擎状态更新的回调通知。 |
| onRecvExperimentalAPI: | 实验性 API 回调。 |
房间功能
| 方法名 | 描述 |
|---|---|
| loginRoom:user: | 登录房间，推拉流前必须登录房间。 |
| loginRoom:user:config: | 使用配置进阶属性的方式登录房间，推拉流前必须登录房间。 |
| loginRoom:callback:user:config: | 使用带配置进阶属性的方式登录房间，通过回调参数返回登录结果，推拉流前必须登录房间。 |
| logoutRoom | 退出房间。 |
| logoutRoomWithCallback: | 退出房间。 |
| logoutRoom: | 退出房间。 |
| logoutRoomWithCallback:callback: | 退出房间。 |
| switchRoom:toRoomID: | 切换房间。 |
| switchRoom:toRoomID:config: | 使用配置进阶属性的方式切换房间。 |
| renewToken: | 更新 token 鉴权信息。 |
| setRoomExtraInfo:forKey:roomID:callback: | 设置房间附加消息。 |
| onRoomStateUpdate:errorCode:extendedData:roomID: | 房间状态变化通知 |
| onRoomStateChanged:errorCode:extendedData:roomID: | 房间状态变化通知 |
| onRoomUserUpdate:userList:roomID: | 房间内其他用户增加或减少的回调通知。 |
| onRoomOnlineUserCountUpdate:roomID: | 房间内当前在线用户数量回调。 |
| onRoomStreamUpdate:streamList:extendedData:roomID: | 相同房间内其他用户推的流增加或减少的通知。 |
| onRoomStreamExtraInfoUpdate:roomID: | 房间内流附加信息更新通知。 |
| onRoomExtraInfoUpdate:roomID: | 房间附加信息更新通知。 |
| onRoomTokenWillExpire:roomID: | 房间 Token 鉴权将要过期的回调通知。 |
推流功能
拉流功能
信令消息功能
| 方法名 | 描述 |
|---|---|
| createRealTimeSequentialDataManager: | 创建实时有序数据管理器对象 |
| destroyRealTimeSequentialDataManager: | 销毁实时有序数据管理器对象 |
| setEventHandler: | 设置实时有序数据管理器回调 |
| startBroadcasting: | 开始广播实时有序数据流。 |
| stopBroadcasting: | 停止广播实时有序数据流 |
| sendRealTimeSequentialData:streamID:callback: | 在广播中的流 ID 上发送实时有序数据 |
| startSubscribing: | 开始订阅实时有序数据流。 |
| stopSubscribing: | 停止订阅实时有序数据流。 |
| getIndex | 获取实时有序数据管理器索引。 |
| manager:receiveRealTimeSequentialData:streamID | 收到实时有序数据回调 |
| sendBroadcastMessage:roomID:callback: | 发送房间广播消息。 |
| sendBarrageMessage:roomID:callback: | 发送房间弹幕消息。 |
| sendCustomCommand:callback: | 发送自定义信令。 |
| onIMRecvBroadcastMessage:roomID: | 接收房间广播消息通知。 |
| onIMRecvBarrageMessage:roomID: | 接收房间弹幕消息通知。 |
| onIMRecvCustomCommand:fromUser:roomID: | 接收自定义信令通知。 |
混流功能
| 方法名 | 描述 |
|---|---|
| startMixerTask:callback: | 开始混流任务。 |
| stopMixerTask:callback: | 停止混流任务。 |
| startAutoMixerTask:callback: | 开始自动混流任务 |
| stopAutoMixerTask:callback: | 停止自动混流任务 |
| onMixerRelayCDNStateUpdate:taskID: | 混流转推 CDN 状态更新通知。 |
| onMixerSoundLevelUpdate: | 混流中的每条单流的声浪更新通知。 |
| onAutoMixerSoundLevelUpdate: | 自动混流中的每条单流的声浪更新通知 |
音视频前处理
| 方法名 | 描述 |
|---|---|
| enableAEC: | 是否开启回声消除。 |
| enableHeadphoneAEC: | 是否在使用耳机时开启回声消除。 |
| setAECMode: | 设置回声消除模式 |
| enableAGC: | 开/关自动增益控制 |
| enableANS: | 开/关噪声抑制 |
| enableTransientANS: | 开/关瞬态噪声抑制 |
| setANSMode: | 设置音频噪声抑制模式 |
| enableSpeechEnhance:level: | 开启或关闭人声增强。 |
| enableAudioMixing: | 开/关混音功能 |
| setAudioMixingHandler: | 设置混音回调 |
| muteLocalAudioMixing: | 静音或恢复本地播放混音声音。 |
| setAudioMixingVolume: | 设置混音音量（同时设置本地和远端的音量） |
| setAudioMixingVolume:type: | 设置混音音量（可分别设置本地、远端的音量） |
| startEffectsEnv | 开启 Effects 美颜环境。 |
| stopEffectsEnv | 关闭 Effects 美颜环境。 |
| enableEffectsBeauty: | 开启或关闭美颜效果。 |
| setEffectsBeautyParam: | 设置美颜效果参数。 |
| setAudioEqualizerGain:bandGain: | 设置音效均衡器（EQ）。 |
| setVoiceChangerPreset: | 通过预设枚举设置变声。 |
| setVoiceChangerParam:audioChannel: | 设置变声的具体参数。 |
| setReverbPreset: | 通过预设枚举设置混响。 |
| setReverbAdvancedParam: | 设置混响的具体参数。 |
| setReverbEchoParam: | 设置混响回声效果的具体参数。 |
| enableVirtualStereo:angle: | 开启或关闭推流时的虚拟立体声效果。 |
| enablePlayStreamVirtualStereo:angle:streamID: | 开启或关闭拉流时的虚拟立体声效果。 |
| setElectronicEffects:mode:tonal: | 开启或关闭电音效果。 |
| onAudioMixingCopyData: | 混音数据回调。 |
媒体播放器功能
音效播放器功能
| 方法名 | 描述 |
|---|---|
| createAudioEffectPlayer | 创建音效播放器实例对象。 |
| destroyAudioEffectPlayer: | 销毁音效播放器实例对象。 |
| setEventHandler: | 设置音效播放器回调。 |
| start:path:config: | 开始播放音效。 |
| stop: | 停止播放音效。 |
| pause: | 暂停播放音效。 |
| resume: | 恢复播放音效。 |
| stopAll | 停止播放所有音效。 |
| pauseAll | 暂停播放所有音效。 |
| resumeAll | 恢复播放所有音效。 |
| seekTo:audioEffectID:callback: | 设置播放进度。 |
| setVolume:audioEffectID: | 设置单个音效的播放音量，会同时设置本地播放音量和推流音量。 |
| setVolumeAll: | 设置所有音效的播放音量，会同时设置本地播放音量和推流音量。 |
| setPlaySpeed:audioEffectID: | 设置指定音效的播放速度，会同时设置本地播放速度和推流速度（不支持单独设置）。 |
| getTotalDuration: | 获取指定音效资源的总长度。 |
| getCurrentProgress: | 获取当前播放进度。 |
| loadResource:audioEffectID:callback: | 加载音效资源。 |
| unloadResource: | 卸载音效资源。 |
| updatePosition:position: | 更新音效播放器(音频源)位置。 |
| getIndex | 获取音效播放器索引。 |
| audioEffectPlayer:audioEffectID:playStateUpdate:errorCode | 音效播放状态回调。 |
录制功能
| 方法名 | 描述 |
|---|---|
| startRecordingCapturedData:channel: | 开始本地录制，直接将音视频数据录制到本地文件。 |
| stopRecordingCapturedData: | 结束录制本端音频或音视频。 |
| setDataRecordEventHandler: | 设置数据录制事件回调。 |
| onCapturedDataRecordStateUpdate:errorCode:config:channel: | 本地录制的状态更新回调，当录制过程状态变化时触发。 |
| onCapturedDataRecordProgressUpdate:config:channel: | 录制进度更新回调。 |
设备管理
自定义视频采集和渲染
自定义音频采集和渲染
实用工具
| 方法名 | 描述 |
|---|---|
| startPerformanceMonitor: | 启动系统性能监控。 |
| stopPerformanceMonitor | 停止系统性能监控。 |
| startNetworkProbe:callback: | 启动网络探测。 |
| stopNetworkProbe | 停止网络探测。 |
| testNetworkConnectivity: | 测试网络连通性 |
| startNetworkSpeedTest: | 启动网络测速。 |
| startNetworkSpeedTest:interval: | 启动网络测速，支持设置测速周期。 |
| stopNetworkSpeedTest | 停止网络测速。 |
| getNetworkTimeInfo | 获取同步网络时间信息。 |
| onPerformanceStatusUpdate: | 系统性能监控回调。 |
| onNetworkModeChanged: | 网络模式变更回调。 |
| onNetworkSpeedTestError:type: | 网络测速异常回调。 |
| onNetworkSpeedTestQualityUpdate:type: | 网络测速质量回调。 |
| onNetworkQuality:upstreamQuality:downstreamQuality: | 房间内正在推流的用户的网络质量回调。 |
| onNetworkTimeSynchronized | 网络时间同步成功的回调 |
范围语音
| 方法名 | 描述 |
|---|---|
| createRangeAudio | 创建范围语音实例对象。 |
| destroyRangeAudio: | 销毁范围语音实例对象。 |
| setEventHandler: | 设置范围语音回调。 |
| setAudioReceiveRange: | 设置音频接收距离的最大范围。 |
| setPositionUpdateFrequency: | 设置SDK内部实时更新位置的频率 |
| setRangeAudioVolume: | 设置范围语音音量 |
| setStreamVocalRange:vocalRange: | 设置流的发声范围 |
| updateStreamPosition:position: | 更新流的位置 |
| updateSelfPosition:axisForward:axisRight:axisUp: | 更新自身的位置和朝向。 |
| updateAudioSource:position: | 添加或更新音源位置信息。 |
| enableSpatializer: | 开启或关闭 3D 音效。 |
| enableMicrophone: | 开启或关闭麦克风。 |
| enableSpeaker: | 开启或关闭扬声器。 |
| setRangeAudioMode: | 设置范围语音模式。 |
| setRangeAudioCustomMode:listenMode: | 设置范围语音的高阶自定义模式。 |
| setTeamID: | 设置队伍 ID |
| muteUser:mute: | 是否可接收指定用户音频数据。 |
| rangeAudio:microphoneStateUpdate:errorCode | 范围语音麦克风使用状态回调。 |
版权音乐
| 方法名 | 描述 |
|---|---|
| createCopyrightedMusic | 创建版权音乐实例对象。 |
| destroyCopyrightedMusic: | 销毁版权音乐实例对象。 |
| setEventHandler: | 设置版权音乐回调。 |
| initCopyrightedMusic:callback: | 初始化版权音乐模块。 |
| getCacheSize | 获取缓存大小。 |
| clearCache | 清除缓存。 |
| sendExtendedRequest:callback:params: | 发送扩展功能请求。 |
| getLrcLyric:callback:vendorID: | 获取 lrc 格式歌词。 |
| getKrcLyricByToken:callback: | 获取 krc 格式歌词。 |
| requestResource:callback:type: | 获取音乐资源。 |
| getSharedResource:callback:type: | 获取分享歌曲资源。 |
| download:callback: | 下载歌曲或伴奏。 |
| queryCache:type:vendorID: | 查询资源是否有缓存。 |
| getDuration: | 获取歌曲或伴奏文件的播放时长。 |
| setScoringLevel: | 设置打分难度级别。 |
| startScore:pitchValueInterval: | 开始评分。 |
| pauseScore: | 暂停评分。 |
| resumeScore: | 恢复评分。 |
| stopScore: | 结束评分。 |
| resetScore: | 重置评分。 |
| getPreviousScore: | 获取上一句的评分。 |
| getAverageScore: | 获取平均评分。 |
| getTotalScore: | 获取总评分。 |
| getFullScore: | 获取满分。 |
| getStandardPitch:callback: | 获取标准音高数据。 |
| getCurrentPitch: | 获取实时音高数据。 |
| onDownloadProgressUpdate:resourceID:progressRate: | 加载歌曲或伴奏进度回调。 |
| onCurrentPitchValueUpdate:resourceID:currentDuration:pitchValue: | 实时音高线回调。 |
范围场景
屏幕共享
| 方法名 | 描述 |
|---|---|
| getScreenCaptureSourcesWithThumbnailSize:iconSize: | 获取屏幕列表或屏幕中的窗口列表。 |
| createScreenCaptureSource:sourceType: | 创建屏幕采集源 |
| destroyScreenCaptureSource: | 销毁屏幕采集源对象 |
| setEventHandler: | 设置屏幕采集源回调 |
| updateCaptureSource:sourceType: | 更新屏幕采集源 |
| startCapture | 开始屏幕采集。 |
| stopCapture | 停止屏幕采集。 |
| updateCaptureRegion: | 更新屏幕采集的区域。 |
| setExcludeWindowList: | 设置过滤的窗口列表。 |
| enableWindowActivate: | 是否激活窗口提升至前台显示。 |
| enableCursorVisible: | 设置是否显示光标 |
| getIndex | 获取屏幕采集源索引。 |
| screenCapture:availableFrame:dataLength:param | 屏幕采集数据的回调 |
| screenCapture:exceptionOccurred | 屏幕采集异常通知 |
| screenCapture:windowState:windowRect | 采集目标窗口状态发生改变。 |
| sharedInstance | 创建屏幕采集扩展单例。 |
| setupWithDelegate: | 初始化扩展进程。 |
| setupWithDelegate:appGroup | 使用 App Group 进行初始化扩展进程，在屏幕共享时可以提供更好的性能与稳定性。 |
| finished | 结束屏幕采集。 |
| sendSampleBuffer:withType | 媒体数据发送方法 |
| broadcastFinished:reason | 屏幕采集结束回调。 |
| setAppGroupID: | 设置 App Group 配置项。 |
| startScreenCaptureInApp: | 开始屏幕采集，仅限 app 应用内录屏。 |
| startScreenCapture: | 开始屏幕采集。 |
| stopScreenCapture | 停止屏幕采集。 |
| updateScreenCaptureConfig: | 更新屏幕采集参数配置。 |
废弃接口列表
| 方法名 | 描述 |
|---|---|
| setPlayStreamBufferIntervalRange:streamID: | 【已废弃】设置拉流播放缓存自适应调整的区间范围。 |
| enableBeautify: | 【已废弃】开/关美颜，为主推流通道设置。此函数在 2.16.0 版本及以上已废弃，请使用 [enableEffectsBeauty] 函数代替。 |
| enableBeautify:channel: | 【已废弃】开/关美颜，为任意推流通道设置。此函数在 2.16.0 版本及以上已废弃，请使用 [enableEffectsBeauty] 函数代替。 |
| setBeautifyOption: | 【已废弃】设置美颜参数。此函数在 2.16.0 版本及以上已废弃，请使用 [setEffectsBeautyParam] 函数代替。 |
| setBeautifyOption:channel: | 【已废弃】设置美颜参数。此函数在 2.16.0 版本及以上已废弃，请使用 [setEffectsBeautyParam] 函数代替。 |
| createEngineWithAppID:appSign:isTestEnv:scenario:eventHandler: | 【已废弃】创建 ZegoExpressEngine 单例对象并初始化 SDK。此函数在 2.14.0 版本及以上已废弃，请使用不带 [isTestEnv] 参数的同名函数代替。请参考 测试环境废弃说明 |
| requestSong:callback: | 【已废弃】点歌。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。 |
| requestAccompaniment:callback: | 【已废弃】点伴奏。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。 |
| requestAccompanimentClip:callback: | 【已废弃】点伴奏高潮片段。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。 |
| getMusicByToken:callback: | 【已废弃】获取歌曲或伴奏。此函数在 3.0.2 版本及以上已废弃，请使用 [getSharedResource] 函数代替。 |
| getLrcLyric:callback: | 【已废弃】获取 lrc 格式歌词。此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。 |
| queryCache:type: | 【已废弃】查询资源是否有缓存。此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。 |
本篇目录
- 免费试用
- 电话咨询400 1006 604咨询客服微信扫码，24h在线
联系我们
文档反馈
