提交工单
咨询集成、功能及报价等问题
ZEGO SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为多端提供清晰稳定的实时语音视频云服务。
以下为基本 API 的简要介绍。
方法名 | 描述 |
---|---|
uploadLog | 上传离线日志 |
setRoomScenario | 设置房间场景 |
destroyEngine | 销毁引擎实例。 |
setGeoFence | 设置地理围栏。 |
setEngineOptions | 设置引擎进阶配置。 |
use | 引入模块,可以通过该接口按需引入其他模块。 |
setTurnServer | 用于代理的 turn 服务器配置。 |
callExperimentalAPI | ZEGO 通过此 API 提供 RTC 业务中的部分技术预览或特别定制功能,需要获取功能的使用或详情其详情可咨询 ZEGO 技术支持 |
checkSystemRequirements | 支持能力检测接口 |
off | 删除注册过的回调事件 |
on | 注册回调事件 |
enableMultiRoom | 是否开启多房间模式 |
setLogConfig | 日志高级配置 |
setCloudProxyConfig | 设置云代理配置。 |
setLocalProxyConfig | 设置本地代理配置。 |
setDebugVerbose | 是否开启Debug模式,打开时错误信息 alert 提示,默认测试环境开启 |
getVersion | 获取当前SDK版本 |
方法名 | 描述 |
---|---|
loginRoom | 登录房间 |
logoutRoom | 退出房间,不再接受各种房间内状态 |
renewToken | 更新房间权限token |
setRoomExtraInfo | 设置房间附加消息 |
方法名 | 描述 |
---|---|
startPlayingStream | 开始拉流 |
stopPlayingStream | 停止拉取远端流(即构服务器) |
mutePlayStreamVideo | 停止或恢复拉取视频流 |
setAudioFrameCallback | 设置拉流原始音频数据回调 |
muteAllPlayAudioStreams | 拉流是否接收所有音频数据(包括之后在房间中新拉取的流) |
muteAllPlayVideoStreams | 拉流是否接收所有视频数据(包括之后在房间中新拉取的流) |
mutePlayStreamAudio | 停止或恢复拉取音频流 |
getPlayingStreamQuality | 获取拉流质量。 |
方法名 | 描述 |
---|---|
sendBarrageMessage | 发送房间弹幕消息(消息不保证可靠) |
sendBroadcastMessage | 发送房间广播消息(消息保证可靠) |
sendCustomCommand | 发送自定义信令(消息可靠) |
方法名 | 描述 |
---|---|
startAutoMixerTask | 开始自动混流任务 |
startMixerTask | 开始混流任务 |
stopAutoMixerTask | 停止服务端自动混流任务 |
stopMixerTask | 停止服务端混流 |
setMixerTaskConfig | 混流高级配置 |
方法名 | 描述 |
---|---|
startMixingAudio | 开始混音 |
stopMixingAudio | 停止混音 |
setMixingAudioVolume | 设置混音音量 |
enableLiveAudioEffect | 开启或关闭音效增强的功能。 |
setAudioChangerParam | 对传入的歌曲进行变调处理。 |
方法名 | 描述 |
---|---|
enableVideoCaptureDevice | 开/关视频采集设备。 |
enumDevices | 获取设备硬件信息,为操作硬件设备接口提供设备id参数。 |
getCameras | 获取摄像头设备列表,为操作硬件设备接口提供设备id参数。 |
getMicrophones | 获取麦克风设备列表,为操作硬件设备接口提供设备id参数。 |
getSpeakers | 获取扬声器设备列表,为操作硬件设备接口提供设备id参数。 |
useFrontCamera | 切换前后摄像头 |
useVideoDevice | 切换摄像头 |
useAudioDevice | 切换麦克风 |
useAudioOutputDevice | 切换音频输出设备。 |
setSoundLevelDelegate | 设置是否监听音浪及音浪回调间隔时间 |
isMicrophoneMuted | 获取麦克风静音状态 |
muteMicrophone | 是否静音麦克风声音 |
方法名 | 描述 |
---|---|
play | 在页面上播放媒体流的音视频。 |
stop | 停止在页面上播放音视频。 |
resume | 恢复播放页面上的音视频。 |
setAudioMuted | 开关音频的播放。 |
setVideoMuted | 开关视频的播放。 |
useAudioOutputDevice | 切换音频输出设备。 |
setVolume | 设置音频播放音量。 |
on | 注册回调事件。 |
off | 注销回调事件。 |
takeStreamSnapshot | 客户端截图 |
createLocalStreamView | 创建本地媒体流播放器组件实例对象。 |
createRemoteStreamView | 创建远端媒体流播放器组件实例对象。 |
方法名 | 描述 |
---|---|
start | 开始播放音效。 |
stop | 结束播放音效。 |
pause | 暂停播放音效。 |
resume | 恢复播放音效。 |
setVolume | 设置单个音效的播放音量,会同时设置本地播放音量和推流音量。 |
getTotalDuration | 获取指定音效资源的总时长。 |
getCurrentProgress | 获取当前播放进度。 |
seekTo | 设置播放进度。 |
createAudioEffectPlayer | 创建音效播放器实例对象。 |
loadAudioEffect | 加载音效资源。 |
unloadAudioEffect | 释放音效资源。 |
方法名 | 描述 |
---|---|
createRangeAudioInstance | 创建范围语音实例对象。 |
setVoiceChangerParam | 范围语音对媒体流进行自定义参数设置变声处理。 |
setVoiceChangerPreset | 范围语音对媒体流进行变声处理。 |
enableAudioSourceUpdateChecker | 是否检查范围内用户的变更。 |
on | 注册回调事件。 |
off | 注销回调事件。 |
setAudioReceiveRange | 设置音频接收距离的最大范围。 |
updateSelfPosition | 更新听者的位置和朝向。 |
updateAudioSource | 添加或更新音源位置信息。 |
enableSpatializer | 开关 3D 音效。 |
enableMicrophone | 开关麦克风。 |
selectMicrophone | 指定麦克风设备。 |
selectSpeaker | 指定扬声器设备。 |
enableSpeaker | 开关扬声器。 |
setRangeAudioCustomMode | 设置范围语音的高阶自定义模式。 |
setRangeAudioMode | 设置范围语音模式。 |
setTeamID | 设置队伍 ID。 |
setPositionUpdateFrequency | 设置 SDK 内部实时更新位置的频率。 |
setRangeAudioVolume | 设置范围语音本地播放音量。 |
enableAiDenoise | 范围语音开启或关闭 AI 降噪。 |
isAudioContextRunning | 判断 AudioContext 对象是否已启用。 |
resumeAudioContext | 重新启用内部的 AudioContext 对象。 |
setStreamVocalRange | 设置拉流音频发送范围。 |
updateStreamPosition | 更新拉流的位置。 |
setCustomSourceVocalRange | 设置自定义发声源发送范围。 |
updateCustomSourcePosition | 添加或更新自定义发声源位置信息。 |
方法名 | 描述 |
---|---|
initCopyrightedMusic | 初始化版权音乐模块。 |
on | 注册回调事件。 |
sendExtendedRequest | 发送扩展功能请求。 |
requestResource | 获取音乐资源。 |
getSharedResource | 获取分享歌曲资源。 |
getLrcLyric | 获取 lrc 格式歌词。 |
getKrcLyricByToken | 获取 krc 格式歌词。 |
download | 下载歌曲或伴奏。 |
clearCache | 清除歌曲缓存。 |
startScore | 开始评分。 |
stopScore | 开始评分。 |
pauseScore | 暂停评分。 |
resumeScore | 恢复评分。 |
resetScore | 恢复评分。 |
getPreviousScore | 获取上一句的评分。 |
getAverageScore | 获取平均评分。 |
getTotalScore | 获取总评分。 |
getFullScore | 获取满分。 |
getStandardPitch | 获取标准音高数据。 |
getCurrentPitch | 获取实时音高数据。 |
setScoringLevel | 设置打分难度级别。 |
createCopyrightedMusic | 创建版权音乐实例对象。 |
destroyCopyrightedMusic | 销毁版权音乐实例对象。 |
方法名 | 描述 |
---|---|
createRealTimeSequentialDataManager | 创建实时有序数据实例对象 |
destroyRealTimeSequentialDataManager | 销毁实时有序数据实例对象 |
startBroadcasting | 开始广播 |
stopBroadcasting | 停止广播 |
sendRealTimeSequentialData | 发送实时有序数据 |
startSubscribing | 开始订阅 |
stopSubscribing | 停止订阅 |
on | 注册回调事件。 |
off | 注销回调事件。 |
方法名 | 描述 |
---|---|
ZegoExpressPlayer | 播放器插件构造函数 |
destroy | 销毁播放器插件 |
fullScreen | 播放器全屏播放 |
getPlayQuality | 播放器获取流质量 |
onCanPlay | 播放器 CDN 资源可播放回调 |
onError | 播放器错误回调 |
onLoaded | CDN 媒体资源加载结束回调 |
onMediaInfoUpdate | 播放的 CDN 资源媒体信息更新回调 |
onPaused | 播放器渲染(播放)暂停的回调 |
onPlay | 播放器渲染(播放)开始回调 |
onPlaying | 播放已经加载到足够多的数据,开始恢复播放。 |
onTimeUpdate | 当前播放时间改变的回调 |
onWaiting | 由于暂时缺少数据,播放已停止。 |
pause | 播放器暂停播放 |
play | 播放器开始播放 |
resume | 播放器重新拉取当前 CDN 直播流。 |
setBufferInterval | 播放器设置 buffer 间隔 |
setMuted | 播放器设置播放静音开关 |
setVolume | 播放器设置音量大小 |
stop | 停止播放资源,不在加载当前指定的媒体 |
verify | 播放器鉴权 |
联系我们
文档反馈