logo
控制台登录/注册
文档
客户端 API
服务端 API
实时音视频
Windows: C#
产品简介
概述
产品功能
计费说明
客户端 SDK
下载 SDK
客户端 APIlink
发布日志
常见错误码
快速开始
跑通示例源码
集成 SDK
实现视频通话
常见问题
当前页

功能总览

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。

API 返回的错误码请参考：https://doc-zh.zego.im/article/4378。

以下为基本的 API 简要介绍。

初始化相关的前置功能

方法名描述
CreateEngine创建 ZegoExpressEngine 单例对象并初始化 SDK。
DestroyEngine销毁 ZegoExpressEngine 单例对象并反初始化 SDK。
GetEngine获取引擎单例对象。
SetEngineConfig设置引擎进阶配置。
SetLogConfig设置日志配置。
SetRoomMode设置房间模式。
GetVersion获取 SDK 版本号。
UploadLog上传日志到 ZEGO 服务器。
SubmitLog上传日志到 ZEGO 服务器。
EnableDebugAssistant开启调试助手。注意，请勿在线上版本开启此功能！仅在开发阶段使用！
OnDebugError调试错误信息回调。
OnEngineStateUpdate音视频引擎状态更新的回调通知。

房间功能

方法名描述
LoginRoom使用配置进阶属性的方式登录房间，推拉流前必须登录房间。
LogoutRoom退出房间。
LogoutRoom退出指定房间 ID 的房间。
SwitchRoom使用配置进阶属性的方式切换房间。
SetRoomExtraInfo设置房间附加消息。
OnRoomStateUpdate房间状态变化通知。
OnRoomUserUpdate房间内其他用户增加或减少的回调通知。
OnRoomOnlineUserCountUpdate房间内当前在线用户数量回调。
OnRoomStreamUpdate相同房间内其他用户推的流增加或减少的通知。
OnRoomStreamExtraInfoUpdate房间内流附加信息更新通知。
OnRoomExtraInfoUpdate房间附加信息更新通知。

推流功能

方法名描述
StartPublishingStream开始推流，可选择推第二路流。
StartPublishingStream开始推流，支持多房间模式
StopPublishingStream停止推流，可停止指定通道的音视频流。
SetStreamExtraInfo设置指定推流通道的流附加信息。
StartPreview启动/更新本地预览，支持设置其他通道的推流。
StopPreview停止本地预览，支持设置其他通道的推流
SetVideoConfig设置视频配置，支持设置其他通道的推流。
GetVideoConfig获取当前视频配置，支持设置其他通道的推流
SetVideoMirrorMode设置镜像模式，支持设置其他通道的推流。
SetAppOrientation设置采集视频的朝向，支持设置其他通道的推流。
SetAudioConfig设置指定推流通道的音频质量配置。
GetAudioConfig获取当前音频质量配置。
MutePublishStreamAudio停止或恢复发送指定推流通道的音频流。
MutePublishStreamVideo停止或恢复发送指定推流通道的视频流。
EnableTrafficControl开始或停止流量控制。
SetMinVideoBitrateForTrafficControl设置流量控制的最低视频码率阈值。
SetCaptureVolume设置推流端采集音量。
SetAudioCaptureStereoMode设置音频采集双声道模式。
AddPublishCdnUrl增加转推至 CDN 的 URL。
RemovePublishCdnUrl删除转推至 CDN 的 URL。
EnablePublishDirectToCDN是否直接推流到 CDN（不经过 ZEGO RTC 服务器）, 支持设置其他通道的推流。
SendSEI指定推流通道号，发送媒体增强补充信息。
EnableHardwareEncoder开/关硬件编码。
SetCapturePipelineScaleMode设置采集缩放时机，视频数据是采集的时候立即缩放还是编码时才进行缩放。
OnPublisherStateUpdate推流状态回调。
OnPublisherQualityUpdate推流质量回调。
OnPublisherCapturedAudioFirstFrame音频采集首帧回调接口。
OnPublisherCapturedVideoFirstFrame视频采集首帧回调接口。
OnPublisherVideoSizeChanged采集视频大小变更回调。
OnPublisherRelayCDNStateUpdate添加/删除转推 CDN 地址状态回调。

拉流功能

方法名描述
StartPlayingStream开始拉流（从 ZEGO RTC 服务器或第三方 CDN），支持多房间模式。
StopPlayingStream停止拉流。
SetPlayVolume设置拉流音量。
MutePlayStreamAudio拉流是否可接收指定音频数据。
MutePlayStreamVideo拉流是否可接收指定视频数据。
EnableHardwareDecoder开/关硬件解码。
EnableCheckPoc开/关帧顺序检测。
OnPlayerStateUpdate拉流状态变更回调。
OnPlayerQualityUpdate拉流质量回调。
OnPlayerMediaEvent拉流媒体事件回调。
OnPlayerRecvAudioFirstFrame拉流端音频接收首帧回调。
OnPlayerRecvVideoFirstFrame拉流端视频接收首帧回调。
OnPlayerRenderVideoFirstFrame拉流端渲染完视频首帧回调。
OnPlayerVideoSizeChanged拉流分辨率变更通知。
OnPlayerRecvSEI收到远端流的 SEI 内容。

信令消息功能

方法名描述
SendBroadcastMessage发送房间广播消息。
SendBarrageMessage发送房间弹幕消息。
SendCustomCommand发送自定义信令。
OnIMRecvBroadcastMessage接收房间广播消息通知。
OnIMRecvBarrageMessage接收房间弹幕消息通知。
OnIMRecvCustomCommand接收自定义信令通知。

混流功能

方法名描述
StartMixerTask开始混流任务。
StopMixerTask停止混流任务。
OnMixerRelayCDNStateUpdate混流转推 CDN 状态更新通知。
OnMixerSoundLevelUpdate混流中的每条单流的声浪更新通知。

音视频前处理

方法名描述
EnableAEC是否开启回声消除。
SetAECMode设置回声消除模式
EnableAGC开/关自动增益控制
EnableANS开/关噪声抑制
EnableTransientANS开/关瞬态噪声抑制
SetANSMode设置音频噪声抑制模式

媒体播放器功能

方法名描述
CreateMediaPlayer创建媒体播放器实例对象。
DestroyMediaPlayer销毁媒体播放器实例对象。

录制功能

方法名描述
StartRecordingCapturedData开始本地录制，直接将音视频数据录制到本地文件。
StopRecordingCapturedData结束录制本端音频或音视频。
OnCapturedDataRecordStateUpdate本地录制的状态更新回调，当录制过程状态变化时触发。
OnCapturedDataRecordProgressUpdate录制进度更新回调。

设备管理

方法名描述
MuteMicrophone设置是否静音（关闭麦克风）。
IsMicrophoneMuted检查麦克风是否设置为静音。
MuteSpeaker设置是否静音（关闭音频输出）。
IsSpeakerMuted检查音频输出是否静音。
GetAudioDeviceList获取音频设备列表
UseAudioDevice选择使用某个音频设备
EnableAudioCaptureDevice开/关音频采集设备。
EnableCamera开/关摄像头，支持设置其他通道的推流。
UseFrontCamera切换前后摄像头，支持指定推流通道。
UseVideoDevice选择使用某个视频设备，支持设置指定推流通道
GetVideoDeviceList获取视频设备列表
StartSoundLevelMonitor启动声浪监控，支持设置监听间隔。
StartSoundLevelMonitor启动声浪监控，支持开启进阶功能。
StopSoundLevelMonitor停止声浪监控。
StartAudioSpectrumMonitor启动音频频谱监控，支持设置监听间隔。
StopAudioSpectrumMonitor停止音频频谱监控。
EnableHeadphoneMonitor开启/关闭 耳返。
SetHeadphoneMonitorVolume设置耳返音量。
OnCapturedSoundLevelUpdate本地采集音频声浪回调。
OnRemoteSoundLevelUpdate远端拉流音频声浪回调。
OnCapturedAudioSpectrumUpdate本地采集音频频谱回调。
OnRemoteAudioSpectrumUpdate远端拉流音频频谱回调。
OnLocalDeviceExceptionOccurred本地设备异常通知。
OnRemoteCameraStateUpdate远端摄像头设备状态通知。
OnRemoteMicStateUpdate远端麦克风设备状态通知。

自定义视频采集和渲染

方法名描述
EnableCustomVideoRender开始或停止自定义视频渲染。
EnableCustomVideoCapture开始或停止自定义视频采集，支持设置其他通道的推流。
SendCustomVideoCaptureRawData给 SDK 发送自定义采集的视频帧原始数据，支持其他路推流。
SendCustomVideoCaptureRawData给 SDK 发送自定义采集的视频帧原始数据，支持其他路推流
OnCustomVideoCaptureStart自定义视频采集开始的通知。
OnCustomVideoCaptureStop自定义视频采集结束的通知。
OnCapturedVideoFrameRawData开启自定义视频渲染时，本地预览采集的原始视频帧数据回调。
OnRemoteVideoFrameRawData开启自定义视频渲染时，远端拉流原始视频帧数据回调，通过 streamID 区分不同的流。
EnableCustomVideoProcessing自定义视频前处理配置开关，支持指定推流通道号。

自定义音频采集和渲染

方法名描述
StartAudioDataObserver开启音频数据回调监测。
StopAudioDataObserver停止音频数据回调监测。
EnableCustomAudioIO开启自定义音频 IO 功能，支持其他路推流，支持 PCM 、AAC 格式数据。
SendCustomAudioCaptureAACData发送自定义音频采集 AAC 数据，支持设置其他通道的推流。
SendCustomAudioCapturePCMData发送自定义音频采集 PCM 数据，支持其他路推流。
FetchCustomAudioRenderPCMData从 SDK 取远端拉流自定义音频渲染 PCM 数据。
OnCapturedAudioData获取本地麦克风采集到的音频数据的回调.
OnPlaybackAudioData获取 SDK 播放的音频数据的回调。
OnMixedAudioData获取 SDK 播放的音频数据和本地麦克风采集到的音频数据的回调，该音频数据是经过 SDK 混合之后的数据。
OnPlayerAudioData获取 SDK 每条拉流的音频数据的回调。

版权音乐

方法名描述
CreateCopyrightedMusic创建版权音乐实例对象。
DestroyCopyrightedMusic销毁版权音乐实例对象。
InitCopyrightedMusic初始化版权音乐模块。
GetCacheSize获取缓存大小。
ClearCache清除缓存。
SendExtendedRequest发送扩展功能请求。
GetLrcLyric获取 lrc 格式歌词。
GetKrcLyricByToken获取逐字歌词。
Download下载音乐资源。
GetDuration获取歌曲或伴奏文件的播放时长。
OnDownloadProgressUpdate加载歌曲或伴奏进度回调。

废弃接口列表

方法名描述
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] 函数代替。
GetMusicByToken【已废弃】获取歌曲或伴奏。此函数在 3.0.2 版本及以上已废弃，请使用 [getSharedResource] 函数代替。
GetLrcLyric【已废弃】获取 lrc 格式歌词。此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。

Previous

CDN 直播价格说明

Next

Class

当前页

返回到顶部