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

功能总览

更新时间:2024-04-29 21:15

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

初始化相关的前置功能

方法名 描述
createEngine 创建 ZegoExpressEngine 单例对象并初始化 SDK。
destroyEngine 销毁 ZegoExpressEngine 单例对象并反初始化 SDK。
setEngineConfig 设置引擎进阶配置。
setLogConfig 设置日志配置。
setRoomMode 设置房间模式。
getSDKVersion 获取 SDK 版本号。
isFeatureSupported 查询当前 SDK 是否支持指定的功能特性。
setRoomScenario 设置房间场景。
uploadLog 上传日志到 ZEGO 服务器。
enableDebugAssistant 开启调试助手。注意,请勿在线上版本开启此功能!仅在开发阶段使用!
callExperimentalAPI 调用实验性 API。
onDebugError 调试错误信息回调。
onApiCalledResult 方法执行结果回调。
onEngineStateUpdate 音视频引擎状态更新的回调通知。
onRecvExperimentalAPI 实验性 API 回调。

房间功能

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

推流功能

方法名 描述
startPublishingStream 开始推流,支持多房间模式
stopPublishingStream 停止推流,可停止指定通道的音视频流。
setStreamExtraInfo 设置指定推流通道的流附加信息。
startPreview 启动/更新本地预览,支持设置其他通道的推流。
stopPreview 停止本地预览,支持设置其他通道的推流
setVideoConfig 设置视频配置,支持设置其他通道的推流。
getVideoConfig 获取当前视频配置,支持设置其他通道的推流
setPublishDualStreamConfig 设置大小流配置信息
setVideoMirrorMode 设置镜像模式,支持设置其他通道的推流。
setAppOrientation 设置采集视频的朝向,支持设置其他通道的推流。
setAudioConfig 设置指定推流通道的音频质量配置。
getAudioConfig 获取指定推流通道的当前音频质量配置。
setPublishStreamEncryptionKey 设置指定推流通道的推流加密密钥。
takePublishStreamSnapshot 对指定推流通道的推流画面截图。
mutePublishStreamAudio 停止或恢复发送指定推流通道的音频流。
mutePublishStreamVideo 停止或恢复发送指定推流通道的视频流。
enableTrafficControl 开始或停止指定推流通道的流量控制。
setMinVideoBitrateForTrafficControl 设置指定推流通道的流量控制视频码率最低值
setMinVideoFpsForTrafficControl 设置流量控制的最低视频帧率阈值。
setMinVideoResolutionForTrafficControl 设置流量控制的最低视频分辨率阈值。
setTrafficControlFocusOn 设置指定推流通道的触发流量控制的关注因素。
setCaptureVolume 设置推流端采集音量。
getCaptureVolume 获取推流端采集音量。
setAudioCaptureStereoMode 设置音频采集双声道模式。
addPublishCdnUrl 增加转推至 CDN 的 URL。
removePublishCdnUrl 删除转推至 CDN 的 URL。
enablePublishDirectToCDN 是否直接推流到 CDN(不经过 ZEGO RTC 服务器), 支持设置其他通道的推流。
setPublishWatermark 设置推流水印,支持设置其他通道的推流。
setSEIConfig 设置媒体增强补充信息类型。
sendSEI 指定推流通道号,发送媒体增强补充信息。
sendAudioSideInfo 发送音频次要信息。
enableHardwareEncoder 开/关硬件编码。
isVideoEncoderSupported 是否支持指定的视频编码类型和实现方式。
setAppOrientationMode 设置视频的朝向模式。
onPublisherStateUpdate 推流状态回调。
onPublisherQualityUpdate 推流质量回调。
onPublisherCapturedAudioFirstFrame 音频采集首帧回调接口。
onPublisherCapturedVideoFirstFrame 视频采集首帧回调接口。
onPublisherRenderVideoFirstFrame 推流端视频渲染首帧回调。
onPublisherVideoSizeChanged 采集视频大小变更回调。
onPublisherRelayCDNStateUpdate 添加/删除转推 CDN 地址状态回调。
onPublisherVideoEncoderChanged 视频编码器变更回调。
onPublisherStreamEvent 推流事件回调。
onVideoObjectSegmentationStateChanged 视频主体分割状态变化。
onPublisherLowFpsWarning 视频编码低帧率警告。

拉流功能

方法名 描述
startPlayingStream 开始拉流(从 ZEGO RTC 服务器或第三方 CDN),支持多房间模式。
stopPlayingStream 停止拉流。
setPlayStreamDecryptionKey 设置拉流解密密钥。
takePlayStreamSnapshot 拉流画面截图。
setPlayVolume 设置拉流音量。
setAllPlayStreamVolume 设置所有拉流音量。
setPlayStreamVideoType 设置播放视频流类型。
setPlayStreamBufferIntervalRange 设置拉流播放缓存自适应调整的区间范围。
mutePlayStreamVideo 拉流是否可接收指定视频数据。
enableHardwareDecoder 开/关硬件解码。
isVideoDecoderSupported 是否支持指定视频解码格式。
updatePlayingCanvas 更新拉流视图。
onPlayerStateUpdate 拉流状态变更回调。
onPlayerQualityUpdate 拉流质量回调。
onPlayerMediaEvent 拉流媒体事件回调。
onPlayerRecvAudioFirstFrame 拉流端音频接收首帧回调。
onPlayerRecvVideoFirstFrame 拉流端视频接收首帧回调。除 Linux 系统,此回调默认从 ui 线程抛出。
onPlayerRenderVideoFirstFrame 拉流端渲染完视频首帧回调。
onPlayerRenderCameraVideoFirstFrame 拉流端渲染完远端摄像头视频首帧回调。
onPlayerVideoSizeChanged 拉流分辨率变更通知。
onPlayerRecvSEI 收到远端流的 SEI 内容。
onPlayerSyncRecvSEI 同步接收远端流的 SEI 内容。
onPlayerRecvAudioSideInfo 收到远端流的音频次要信息内容。
onPlayerLowFpsWarning 拉流低帧率警告。
onPlayerStreamEvent 拉流事件回调。

信令消息功能

方法名 描述
sendBroadcastMessage 发送房间广播消息。
sendBarrageMessage 发送房间弹幕消息。
sendCustomCommand 发送自定义信令。
onIMRecvBroadcastMessage 接收房间广播消息通知。
onIMRecvBarrageMessage 接收房间弹幕消息通知。
onIMRecvCustomCommand 接收自定义信令通知。

混流功能

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

音视频前处理

方法名 描述
enableAEC 是否开启回声消除。
enableHeadphoneAEC 是否在使用耳机时开启回声消除。
setAECMode 设置回声消除模式
enableAGC 开/关自动增益控制
enableANS 开/关噪声抑制
enableTransientANS 开/关瞬态噪声抑制
setANSMode 设置音频噪声抑制模式
enableAudioMixing 开/关混音功能
muteLocalAudioMixing 静音或恢复本地播放混音声音。
setAudioMixingVolume 设置混音音量(可分别设置本地、远端的音量)
enableEffectsBeauty 开启或关闭美颜效果。
setEffectsBeautyParam 设置美颜效果参数。
setVoiceChangerPreset 通过预设枚举设置变声。
setReverbPreset 通过预设枚举设置混响。
enableVirtualStereo 开启或关闭推流时的虚拟立体声效果。

媒体播放器功能

方法名 描述
createMediaPlayer 创建媒体播放器实例对象。
destroyMediaPlayer 销毁媒体播放器实例对象。
loadResource 加载本地或者网络媒体资源。
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 设置播放文件的音轨
getCurrentState 获取当前播放状态
getIndex 获取媒体播放器的序号
onMediaPlayerStateUpdate 媒体播放器播放状态回调。
onMediaPlayerNetworkEvent 媒体播放器网络状态事件回调。
onMediaPlayerPlayingProgress 播放器播放进度回调。
onMediaPlayerRenderingProgress 播放器渲染进度回调。
onMediaPlayerVideoSizeChanged 媒体播放器播放视频分辨率改变事件回调。

音效播放器功能

方法名 描述
onAudioEffectPlayerStateUpdate 音效播放状态回调。

录制功能

暂不支持

设备管理

方法名 描述
muteMicrophone 设置是否静音(关闭麦克风)。
isMicrophoneMuted 检查麦克风是否设置为静音。
muteSpeaker 设置是否静音(关闭音频输出)。
isSpeakerMuted 检查音频输出是否静音。
getAudioDeviceList 获取音频设备列表
getDefaultAudioDeviceID 获取默认音频设备 ID
useAudioDevice 选择使用某个音频设备
getAudioDeviceVolume 获取音频设备音量
setAudioDeviceVolume 设置音频设备音量。
muteAudioDevice 静音或取消静音音频设备。
setAudioDeviceMode 设置音频设备模式。
isAudioDeviceMuted 检查音频设备是否静音
enableAudioCaptureDevice 开/关音频采集设备。
getAudioRouteType 获取当前音频路由。
setAudioRouteToSpeaker 设置音频路由到扬声器。
enableCamera 开/关摄像头,支持设置其他通道的推流。
useFrontCamera 切换前后摄像头,支持设置其他通道的推流。
isCameraFocusSupported 摄像头是否支持对焦
setCameraFocusMode 设置摄像头对焦模式。
setCameraFocusPointInPreview 设置预览视图中的对焦点。
setCameraExposureMode 设置摄像头曝光模式。
setCameraExposurePointInPreview 设置预览视图中的曝光点。
setCameraExposureCompensation 设置摄像头曝光补偿数值,支持指定推流通道号。
setCameraZoomFactor 设置摄像头变焦倍数,支持指定推流通道号。每次摄像头重新启动时,摄像头变焦倍数都将会恢复初始值 (1.0)。
getCameraMaxZoomFactor 获取摄像头最大变焦倍数,支持指定推流通道号。
startSoundLevelMonitor 启动声浪监控,支持开启进阶功能。
stopSoundLevelMonitor 停止声浪监控。
startAudioSpectrumMonitor 启动音频频谱监控,支持设置监听间隔。
stopAudioSpectrumMonitor 停止音频频谱监控。
enableHeadphoneMonitor 开启/关闭 耳返。
setHeadphoneMonitorVolume 设置耳返音量。
startAudioVADStableStateMonitor 开始语音的稳态检测,可设置检测周期。
stopAudioVADStableStateMonitor 停止语音的稳态检测。
onCapturedSoundLevelUpdate 本地采集音频声浪回调。
onRemoteSoundLevelUpdate 远端拉流音频声浪回调。
onCapturedAudioSpectrumUpdate 本地采集音频频谱回调。
onRemoteAudioSpectrumUpdate 远端拉流音频频谱回调。
onLocalDeviceExceptionOccurred 本地设备异常通知。
onRemoteCameraStateUpdate 远端摄像头设备状态通知。
onRemoteMicStateUpdate 远端麦克风设备状态通知。
onRemoteSpeakerStateUpdate 远端扬声器设备状态通知。
onAudioRouteChange 音频设备路由变更通知。
onAudioVADStateUpdate 检测音频数据的稳态语音状态的回调。

自定义视频采集和渲染

方法名 描述
enableCustomVideoProcessing 自定义视频前处理配置开关,支持指定推流通道号。

自定义音频采集和渲染

方法名 描述
enableCustomAudioCaptureProcessing 开启本地采集自定义音频处理(耳返前)。
startAudioDataObserver 开启音频数据回调监测。
stopAudioDataObserver 停止音频数据回调监测。

媒体推流器

暂不支持

实用工具

方法名 描述
startNetworkSpeedTest 启动网络测速,支持设置测速周期。
stopNetworkSpeedTest 停止网络测速。
onNetworkSpeedTestError 网络测速异常回调。
onNetworkSpeedTestQualityUpdate 网络测速质量回调。
onNetworkQuality 房间内正在推流的用户的网络质量回调。

范围语音

暂不支持

版权音乐

暂不支持

废弃接口列表

无

本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈