Global

Members

(constant) ZegoAECMode :number

回声消除模式。
Type:
  • number
Properties:
Name Type Description
Aggressive number 激进的回声抵消，可能会影响音质稍微明显，但是回声会消除得很干净。
Medium number 适度的回声抵消，就是可能会稍微影响一点点音质，但是残留的回声会更少。
Soft number 舒适的回声抵消，就是回声抵消基本不会影响声音的音质，可能有时会残留一点回声，但不会影响正常听音。
Source:

(constant) ZegoANSMode :number

噪声抑制模式
Type:
  • number
Properties:
Name Type Description
Soft number 轻度的噪声抑制，基本不会损伤音质，但会残留一些噪声。
Medium number 适度的噪声抑制，有可能损伤一些音质，但有不错的降噪效果。
Aggressive number 激进的噪声抑制，有可能明显损伤音质，但有很好的降噪效果。
Source:

(constant) ZegoAudioCaptureStereoMode :number

音频采集双声道模式
Type:
  • number
Properties:
Name Type Description
None number 不开启双声道采集，即单声道采集
Always number 始终开启双声道采集
Adaptive number 自适应模式，当仅推流时采集双声道，当推拉流（如通话/连麦场景）时采集单声道
Source:

(constant) ZegoAudioChannel :number

音频声道
Type:
  • number
Properties:
Name Type Description
Unknown number 未知
Mono number 单声道
Stereo number 双声道
Source:

(constant) ZegoAudioCodecID :number

音频编码器
Type:
  • number
Properties:
Name Type Description
Default number default
Normal number Normal
Normal2 number Normal2
Normal3 number Normal3
Low number Low
Low2 number Low2
Low3 number Low3
Source:

(constant) ZegoAudioConfigPreset :number

音频配置类型
Type:
  • number
Properties:
Name Type Description
BasicQuality number 基础音质 (16 kbps, Mono, ZegoAudioCodecIDDefault)
StandardQuality number 标准音质 (48 kbps, Mono, ZegoAudioCodecIDDefault)
StandardQualityStereo number 标准音质 (56 kbps, Stereo, ZegoAudioCodecIDDefault)
HighQuality number 高音质 (128 kbps, Mono, ZegoAudioCodecIDDefault)
HighQualityStereo number 高音质 (192 kbps, Stereo, ZegoAudioCodecIDDefault)
Source:

(constant) ZegoAudioDeviceType :number

音频设备类型
Type:
  • number
Properties:
Name Type Description
Input number 音频输入设备
Output number 音频输出设备
Source:

(constant) ZegoAudioEffectPlayState :number

音效播放器状态
Type:
  • number
Properties:
Name Type Description
NoPlay number 不在播放
Playing number 播放中
Pausing number 暂停播放
PlayEnded number 播放结束
Source:

(constant) ZegoAudioRoute :number

音频路由
Type:
  • number
Properties:
Name Type Description
Speaker number 扬声器
Headphone number 耳机
Bluetooth number 蓝牙设备
Receiver number 听筒
ExternalUSB number USB 音频外接设备
AirPlay number Apple 隔空播放
Source:

(constant) ZegoCapturePipelineScaleMode :number

视频采集缩放时机
Type:
  • number
Properties:
Name Type Description
Pre number 采集后立即进行缩放，默认
Post number 编码时进行缩放
Source:

(constant) ZegoDataRecordState :number

录制状态
Type:
  • number
Properties:
Name Type Description
NoRecord number 未录制状态，当录制出错或者未开始录制之前处于此状态
Recording number 正在录制中，当成功调用 [startRecordingCapturedData] 函数之后处于此状态
Success number 录制成功
Source:

(constant) ZegoDataRecordType :number

录制类型
Type:
  • number
Properties:
Name Type Description
Default number 该字段表示纯音频 SDK 默认录制音频，音视频 SDK 默认录制音视频，当录制 .aac 格式的文件时默认也是录制音频
OnlyAudio number 只录制音频
OnlyVideo number 只录制视频，音频的 SDK 和录制 .aac 格式文件时无效
AudioAndVideo number 同时录制音频、视频。音频的 SDK 和录制 .aac 格式文件时录制出来也只有音频
Source:

(constant) ZegoEngineState :number

引擎状态
Type:
  • number
Properties:
Name Type Description
Start number 引擎已开启
Stop number 引擎已停止
Source:

(constant) ZegoLanguage :number

语言
Type:
  • number
Properties:
Name Type Description
English number 英文
Chinese number 中文
Source:

(constant) ZegoMediaPlayerAudioChannel :number

播放器声道
Type:
  • number
Properties:
Name Type Description
Left number 左声道
Right number 右声道
All number 全部声道
Source:

(constant) ZegoMediaPlayerNetworkEvent :number

播放器网络事件
Type:
  • number
Properties:
Name Type Description
BufferBegin number 网络资源播放不畅，开始尝试缓存数据
BufferEnded number 网络资源可以顺畅播放
Source:

(constant) ZegoMediaPlayerState :number

播放器状态
Type:
  • number
Properties:
Name Type Description
NoPlay number 不在播放
Playing number 播放中
Pausing number 暂停播放
PlayEnded number 播放结束
Source:

(constant) ZegoMixerInputContentType :number

混流内容类型
Type:
  • number
Properties:
Name Type Description
Audio number 音频混流内容类型
Video number 视频混流内容类型
VideoOnly number 仅视频混流内容类型
Source:

(constant) ZegoNetworkMode :number

网络模式
Type:
  • number
Properties:
Name Type Description
Offline number 离线（无网络）
Unknown number 未知网络模式
Ethernet number 有线以太网 (LAN)
Wifi number 无线局域网 (WLAN)
Mode2G number 2G 网络 (GPRS/EDGE/CDMA1x/etc.)
Mode3G number 3G 网络 (WCDMA/HSDPA/EVDO/etc.)
Mode4G number 4G 网络 (LTE)
Mode5G number 5G 网络 (NR (NSA/SA))
Source:

(constant) ZegoNetworkSpeedTestType :number

网速测试类型
Type:
  • number
Properties:
Name Type Description
Uplink number 上行测速
Downlink number 下行测速
Source:

(constant) ZegoPlayerMediaEvent :number

拉流媒体事件
Type:
  • number
Properties:
Name Type Description
AudioBreakOccur number 拉流端出现音频卡顿事件
AudioBreakResume number 拉流端音频卡顿事件结束
VideoBreakOccur number 拉流端出现视频卡顿事件
VideoBreakResume number 拉流端视频卡顿事件结束
Source:

(constant) ZegoPlayerState :number

拉流状态
Type:
  • number
Properties:
Name Type Description
NoPlay number 未拉流状态，在拉流前处于该状态。如果拉流过程出现稳态的异常，例如 AppID 和 AppSign 不正确，都会进入未拉流状态
PlayRequesting number 正在请求拉流状态，拉流操作执行成功后会进入正在请求拉流状态，通常通过该状态进行应用界面的展示。如果因为网络质量不佳产生的中断，SDK 会进行内部重试，也会回到正在请求拉流状态
Playing number 正在拉流状态，进入该状态表明拉流已经成功，用户可以正常通信
Source:

(constant) ZegoPlayerVideoLayer :number

拉流播放的视频分层
Type:
  • number
Properties:
Name Type Description
Auto number 根据网络状态选择图层
Base number 指定拉基本层（小分辨率）
BaseExtend number 指定拉扩展层（大分辨率)
Source:

(constant) ZegoPublishChannel :number

推流通道
Type:
  • number
Properties:
Name Type Description
Main number 主推流通道，默认通道
Aux number 辅推流通道（第二路推流通道）
Third number 第三路推流通道
Fourth number 第四路推流通道
Source:

(constant) ZegoPublisherState :number

推流状态
Type:
  • number
Properties:
Name Type Description
NoPublish number 未推流状态，在推流前处于该状态。如果推流过程出现稳态的异常，例如 AppID 和 AppSign 不正确，或者如果其他用户已经在推送流，推送相同流 ID 的流会失败，都会进入未推流状态
PublishRequesting number 正在请求推流状态，推流操作执行成功后会进入正在请求推流状态，通常通过该状态进行 UI 界面的展示。如果因为网络质量不佳产生的中断，SDK 会进行内部重试，也会回到正在请求推流状态
Publishing number 正在推流状态，进入该状态表明推流已经成功，用户可以正常通信
Source:

(constant) ZegoRemoteDeviceState :number

远端设备状态
Type:
  • number
Properties:
Name Type Description
Open number 设备开启
GenericError number 设备关闭：一般性设备错误
InvalidID number 设备关闭：无效的设备 ID
NoAuthorization number 设备关闭：无权限
ZeroFPS number 设备关闭：采集帧率为 0
InUseByOther number 设备关闭：设备被占用
Unplugged number 设备关闭：设备未插入或被拔出
RebootRequired number 设备关闭：由于系统原因需要重启后才能进行下一次修改，否则重新打开也不生效
SystemMediaServicesLost number 设备关闭：系统媒体服务停止，如 iOS 平台下，当系统检测到当前压力巨大（如播放大量动画），则有可能会将媒体相关服务全部停用
Disable number 设备关闭：禁用采集
Mute number 设备关闭：远端设备被静音
Interruption number 设备关闭：设备被中断，如电话事件打断等
InBackground number 设备关闭：用户 App 退到后台
MultiForegroundApp number 设备关闭：当前前台同时存在多个 App，如 iPad 应用分屏下，系统会禁止所有应用使用摄像头
BySystemPressure number 设备关闭：系统处于高负载压力下，可能导致设备异常
NotSupport number 设备状态未知：远端的 SDK 版本过低，不支持发布该设备状态信息
Source:

(constant) ZegoReverbPreset :number

混响预设值
Type:
  • number
Properties:
Name Type Description
None number 无混响
SoftRoom number 小房间混响效果
LargeRoom number 大房间混响效果
ConcertHall number 音乐厅混响效果
Valley number 山谷混响效果
RecordingStudio number 录音棚混响效果
Basement number 地下室混响效果
KTV number KTV 混响效果
Popular number 流行混响效果
Rock number 摇滚混响效果
VocalConcert number 演唱会混响效果
GramoPhone number 留声机混响效果
Source:

(constant) ZegoRoomState :number

房间状态
Type:
  • number
Properties:
Name Type Description
Disconnected number 未连接状态，在登陆房间前和退出房间之后进入该状态。如果登陆房间的过程出现稳态异常，例如 AppID 和 AppSign 不正确，或者有相同用户名在其他地方登陆导致本端被 KickOut，都会进入该状态
Connecting number 正在请求连接状态，登陆房间动作执行成功后会进入此状态。通常通过该状态进行应用界面的展示。如果因为网络质量不佳产生的中断， SDK 会进行内部重试，也会回到正在请求连接状态
Connected number 连接成功状态，进入该状态表示登陆房间已经成功，用户可以正常收到房间内的用户和流信息增删的回调通知
Source:

(constant) ZegoScenario :number

应用使用场景
Type:
  • number
Properties:
Name Type Description
General number 通用场景，SDK 为大多数使用场景提供的默认模式，开发者如果不是很确定自己产品的使用场景，可选择此场景模式。
Communication number 实时通讯场景，常用于 1V1 通话、多人通话等对实时性要求较高的通讯场景。
Live number 直播场景，常用于 1 对多直播 等直播场景。
Source:

(constant) ZegoSEIType :number

SEI 类型
Type:
  • number
Properties:
Name Type Description
ZegoDefined number 采用 H.264 的 SEI (nalu type = 6, payload type = 243) 类型打包，此类型是 SEI 标准未规定的类型，跟视频编码器或者视频文件中的 SEI 不存在冲突性，用户不需要根据 SEI 的内容做过滤，SDK 默认采用此种类型。
UserUnregister number 采用 H.264 的 SEI (nalu type = 6, payload type = 5) 类型打包，H.264 标准对于此类型有规定的格式：startcode + nalu type (6) + payload type (5) + len + payload (uuid + context) + trailing bits；因为视频编码器自身会产生 payload type 为 5 的 SEI，或者使用视频文件推流时，视频文件中也可能存在这样的 SEI，所以使用此类型时，用户需要把 uuid + content 当作 buffer 塞给发送 SEI 的函数；此时为了区别视频编码器自身产生的 SEI， App 在发送此类型 SEI 时，可以填写业务特定的 uuid (uuid 长度为 16 字节），接收方使用 SDK 解析 payload type 为 5 的 SEI 时，会根据设置的过滤字符串过滤出 uuid 相符的 SEI 抛给业务，如果没有设置过滤字符串，SDK 会把所有收到的 SEI 都抛给开发者。
Source:

(constant) ZegoStreamQualityLevel :number

流质量等级
Type:
  • number
Properties:
Name Type Description
Excellent number 质量极好
Good number 质量好
Medium number 质量正常
Bad number 质量差
Die number 质量异常
Unknown number 质量未知
Source:

(constant) ZegoStreamRelayCDNState :number

转推 CDN 状态
Type:
  • number
Properties:
Name Type Description
NoRelay number 未转推状态，在转推前处于该状态。如果转推过程出现稳态的异常，例如 转推地址 不正确，都会进入未转推状态
RelayRequesting number 正在请求转推状态，转推操作执行成功后会进入正在请求转推状态，通常通过该状态进行应用界面的展示。如果因为网络质量不佳产生的中断，SDK 会进行内部重试，也会回到正在转推状态
Relaying number 正在转推状态，进入该状态表明转推已成功
Source:

(constant) ZegoStreamRelayCDNUpdateReason :number

转发 CDN 状态改变原因
Type:
  • number
Properties:
Name Type Description
None number 无
ServerError number 服务器错误
HandshakeFailed number 握手失败
AccessPointError number 接入点错误
CreateStreamFailed number 创建流失败
BadName number 流 ID 不合法
CDNServerDisconnected number CDN 服务器主动断开
Disconnected number 主动断开
MixStreamAllInputStreamClosed number 混流的全部输入流会话关闭
MixStreamAllInputStreamNoData number 混流的全部输入流没有数据
MixStreamServerInternalError number 混流服务器内部错误
Source:

(constant) ZegoStreamResourceMode :number

拉流资源策略模式
Type:
  • number
Properties:
Name Type Description
Default number 默认模式。SDK 会根据拉流设置的 cdnConfig 参数以及即构的后台配置自动选择拉流资源
OnlyCDN number 仅从 CDN 拉流
OnlyL3 number 仅从 L3 拉流
OnlyRTC number 仅从 RTC 拉流
Source:

(constant) ZegoTrafficControlFocusOnMode :number

触发流量控制的因素
Type:
  • number
Properties:
Name Type Description
ZegoTrafficControlFounsOnLocalOnly number 只关注本地网络
ZegoTrafficControlFounsOnRemote number 关注本地网络, 同时也兼顾远端网络,目前只在 1v1 场景下有效
Source:

(constant) ZegoTrafficControlMinVideoBitrateMode :number

流控触发最低码率时的视频发送模式
Type:
  • number
Properties:
Name Type Description
NoVideo number 低于设置的最低码率时，停止视频发送
UltraLowFPS number 低于设置的最低码率时，视频以极低的频率发送（不超过 2 FPS)
Source:

(constant) ZegoTrafficControlProperty :number

当发生流量控制时可供调节的属性（位掩码枚举）
Type:
  • number
Properties:
Name Type Description
Basic number 基础属性（自适应（降低）视频码率）
AdaptiveFPS number 自适应（降低）视频帧率
AdaptiveResolution number 自适应（降低）视频分辨率
AdaptiveAudioBitrate number 自适应（降低）音频码率
Source:

(constant) ZegoUpdateType :number

更新类型
Type:
  • number
Properties:
Name Type Description
Add number 添加
Delete number 删除
Source:

(constant) ZegoVideoBufferType :number

视频帧数据类型
Type:
  • number
Properties:
Name Type Description
Unknown number 未知类型
RawData number 裸数据类型视频帧
EncodedData number 编码类型视频帧
GLTexture2D number OpenGL Texture 2D 类型视频帧
CVPixelBuffer number CVPixelBuffer 类型视频帧
SurfaceTexture number SurfaceTexture 类型视频帧
GLTextureExternalOES number OpenGL GL_TEXTURE_EXTERNAL_OES 类型视频帧
Source:

(constant) ZegoVideoCodecID :number

视频编码格式
Type:
  • number
Properties:
Name Type Description
Default number 默认编码 (H.264)
SVC number 分层编码 (H.264 SVC)
VP8 number VP8
H265 number H.265
Source:

(constant) ZegoVideoConfigPreset :number

视频配置分辨率与比特率预设枚举。预设的分辨率分别针对移动端与桌面端做了适配。在移动端上 height 长于 width，而桌面端相反。例如 1080p 在移动端上实际为 1080(w) x 1920(h)，而在桌面端上实际为 1920(w) x 1080(h)
Type:
  • number
Properties:
Name Type Description
Preset180P number 设置分辨率为 320x180，默认采用 15 fps，码率 300 kbps
Preset270P number 设置分辨率为 480x270，默认采用 15 fps，码率 400 kbps
Preset360P number 设置分辨率为 640x360，默认采用 15 fps，码率 600 kbps
Preset540P number 设置分辨率为 960x540，默认采用 15 fps，码率 1200 kbps
Preset720P number 设置分辨率为 1280x720，默认采用 15 fps，码率 1500 kbps
Preset1080P number 设置分辨率为 1920x1080，默认采用 15 fps，码率 3000 kbps
Source:

(constant) ZegoVideoFlipMode :number

视频帧翻转模式
Type:
  • number
Properties:
Name Type Description
None number 不翻转
X number X 轴翻转
Y number 垂直翻转
XY number XY 轴翻转
Source:

(constant) ZegoVideoFrameFormat :number

视频帧格式
Type:
  • number
Properties:
Name Type Description
Unknown number 未知格式，将取平台默认值
I420 number I420 (YUV420Planar) 格式
NV12 number NV12 (YUV420SemiPlanar) 格式
NV21 number NV21 (YUV420SemiPlanar) 格式
BGRA32 number BGRA32 格式
RGBA32 number RGBA32 格式
ARGB32 number ARGB32 格式
ABGR32 number ABGR32 格式
I422 number I422 (YUV422Planar) 格式
Source:

(constant) ZegoVideoFrameFormatSeries :number

视频帧格式系列
Type:
  • number
Properties:
Name Type Description
RGB number RGB 系列
YUV number YUV 系列
Source:

(constant) ZegoVideoMirrorMode :number

预览或拉流端的镜像模式。
Type:
  • number
Properties:
Name Type Description
OnlyPreviewMirror number 只有本地预览时才是镜像画面，默认采用此模式。
BothMirror number 本地预览和拉流端看到的视频都是镜像画面。
NoMirror number 本地预览和拉流端看到的视频都不是镜像画面。
OnlyPublishMirror number 只有拉流端看到的视频才是镜像画面。
Source:

(constant) ZegoVideoStreamType :number

视频流类型
Type:
  • number
Properties:
Name Type Description
Default number 根据网络状态自动选择流类型
Small number 小分辨率类型
Big number 大分辨率类型
Source:

(constant) ZegoViewMode :number

视频渲染填充模式
Type:
  • number
Properties:
Name Type Description
AspectFit number 等比缩放，可能有黑边
AspectFill number 等比缩放填充整个 View，可能有部分被裁减
ScaleToFill number 填充整个 View，图像可能被拉伸
Source:

(constant) ZegoVoiceChangerPreset :number

变声器预设值
Type:
  • number
Properties:
Name Type Description
None number 无变声
MenToChild number 男声变童声（萝莉声效）
MenToWomen number 男声变女声（幼儿园声效）
WomenToChild number 女声变童声
WomenToMen number 女声变男声
Foreigner number 歪果仁声效
OptimusPrime number 汽车人擎天柱声效
Android number 机器人声效
Ethereal number 空灵声效
MaleMagnetic number 磁性男声效
FemaleFresh number 清新女声效
MajorC number C大调电音音效
MinorA number A小调电音音效
HarmonicMinor number 和声小调电音音效
Source:

Type Definitions

ZegoAudioConfig

推流音频配置
Type:
  • Object
Properties:
Name Type Description
bitrate number 音频码率，单位为 kbps，默认为 48 kbps. 该配置推流前后设置均可生效
channel ZegoAudioChannel 音频编码声道，控制编码器编码的声道数。默认为 Mono 单声道。仅在推流前设置生效。
codecID ZegoAudioCodecID 编码 ID，默认为 ZegoAudioCodecIDDefault。仅在推流前设置生效。
Source:

ZegoAudioEffectPlayConfig

音效播放器播放配置
Type:
  • Object
Properties:
Name Type Description
playCount number 播放次数，当设为 0 时则无限循环播放，直到用户调用 [stop]，默认为 1 即仅播放一次。
isPublishOut boolean 是否将音效混入推流中，默认 false。
Source:

ZegoBarrageMessageInfo

房间弹幕消息
Type:
  • Object
Properties:
Name Type Description
message string 消息内容
messageID string 消息 ID
sendTime number 消息的发送时间，UNIX 时间戳，单位为毫秒
fromUser ZegoUser 消息的发送者。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
Source:

ZegoBroadcastMessageInfo

房间广播消息
Type:
  • Object
Properties:
Name Type Description
message string 消息内容
messageID number 消息 ID
sendTime number 消息的发送时间，UNIX 时间戳，单位为毫秒
fromUser ZegoUser 消息的发送者。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
Source:

ZegoCDNConfig

CDN 配置对象
Type:
  • Object
Properties:
Name Type Description
url string CDN 的 URL
authParam string URL 的鉴权参数
Source:

ZegoDataRecordConfig

录制配置
Type:
  • Object
Properties:
Name Type Description
filePath string 录制文件保存路径，绝对路径，需要包含文件名, 文件名需指明后缀，目前支持 .mp4/.flv/.aac 格式文件。若多次录制为同一个路径，会覆盖同名的文件。最大长度应小于 1024 字节。
recordType ZegoDataRecordType 录制文件媒体类型
Source:

ZegoDataRecordProgress

文件录制进度
Type:
  • Object
Properties:
Name Type Description
duration number 当前录制时长, 单位为毫秒
currentFileSize number 当前录制文件大小, 单位为字节
Source:

ZegoDeviceInfo

设备信息
Type:
  • Object
Properties:
Name Type Description
deviceID string 设备 ID
deviceName string 设备名称
Source:

ZegoEngineConfig

引擎进阶配置
Type:
  • Object
Properties:
Name Type Description
logConfig ZegoLogConfig 日志配置，未设置时使用默认配置(详见 [ZegoLogConfig])。
advancedConfig map.<string, string> 进阶功能配置，未设置时默认不使用任何特殊功能，如需使用，请联系 ZEGO 技术支持。
Source:

ZegoEngineProfile

创建引擎的配置
Type:
  • Object
Properties:
Name Type Description
appID number ZEGO 为开发者签发的应用 ID，请从 ZEGO 管理控制台 https://console-express.zego.im 申请。appID 取值范围 0~4294967295。
appSign string 每个 AppID 对应的应用签名，请从 ZEGO 管理控制台申请。该参数为包含 64 个字符的字符串，字符取值范围：'0' ~ '9', 'a' ~ 'z'。例："9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3"。
scenario ZegoScenario 产品的应用场景，开发者可根据所开发的 App 的场景选择其中一个，SDK 会针对该场景的作一些优化。当设置具体场景后，开发者若需要定制化更多参数，依然可以调用具体函数来设置具体参数。不同应用场景的建议配置可以参考：https://doc-zh.zego.im/faq/profile_difference。
Source:

ZegoLogConfig

日志配置
Type:
  • Object
Properties:
Name Type Description
logPath string 日志文件的存储路径。详情描述：用于自定义日志文件的存储路径。业务场景：当需要自定义日志存储路径时，需要这个配置。是否必填：否。默认值：各平台的默认路径有所不同，具体参考官网文档：https://doc-zh.zego.im/article/6467。注意事项：开发者需要确保对该路径下文件的读写权限。
logSize number 日志文件大小上限，单位Bytes。详情描述：用于自定义日志文件大小上限。业务场景：当需要自定义日志文件大小上限时，需要这个配置。是否必填：否。默认值：5MB (5 * 1024 * 1024 Bytes)。取值范围：最小1MB (1 * 1024 * 1024 Bytes)，最大100M (100 * 1024 * 1024 Bytes)，0表示不需要写日志。注意事项：日志文件大小上限越大，承载的日志信息越多，但是日志上传时间也会更长。
Source:

ZegoMixerAudioConfig

混流音频配置
Type:
  • Object
Properties:
Name Type Description
bitrate number 音频码率，单位为 kbps，默认为 48 kbps，开始混流任务后不能修改
channel ZegoAudioChannel 音频声道，默认为 Mono 单声道
codecID ZegoAudioCodecID 编码 ID，默认为 ZegoAudioCodecIDDefault
Source:

ZegoMixerInput

混流输入
Type:
  • Object
Properties:
Name Type Description
streamID string 流 ID，长度不超过256的字符串。不可以包含 URL 关键字，否则推拉流失败。仅支持数字，英文字符 和 '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。
contentType ZegoMixerInputContentType 混流内容类型
layout ZegoRect 流的布局。当混入的流为音频流时（即 ContentType 参数设置为音频混流类型），SDK内部不处理布局字段，此时无需关注该参数。
soundLevelID number 当混流任务开启了声浪回调时，需要为每条输入流指定唯一的 soundLevelID
isAudioFocus boolean 当前输入流是否开启焦点语音，开启了会突出此路流的声音
Source:

ZegoMixerOutput

混流输出对象
Type:
  • Object
Properties:
Name Type Description
target string 混流输出目标，URL 或者流 ID，若为 URL 格式 目前只支持 RTMP URL 格式：rtmp://xxxxxxxx, 且不能传入两个相同的混流输出的地址。
Source:

ZegoMixerTask

混流任务对象
Type:
  • Object
Properties:
Name Type Description
taskID string 混流任务 ID
inputList Array.<ZegoMixerInput> 混流任务的输入流列表
outputList Array.<ZegoMixerOutput> 混流任务的输出流列表
videoConfig ZegoMixerVideoConfig 混流任务的视频配置
audioConfig ZegoMixerAudioConfig 混流任务的音频配置
watermark ZegoWatermark 混流任务的水印
backgroundImageURL string 混流任务的背景图 URL
enableSoundLevel boolean 是否开启混流的声浪回调通知，开启后拉混流时可通过 [onMixerSoundLevelUpdate] 回调收到每条单流的声浪信息
advancedConfig map.<string, string> 设置高级配置，如可用于指定视频编码等功能。如需使用，联系 ZEGO 技术支持。
Source:

ZegoMixerVideoConfig

混流视频配置
Type:
  • Object
Properties:
Name Type Description
width number 视频分辨率宽
height number 视频分辨率高
fps number 视频帧率，开始混流任务后不能修改
bitrate number 视频码率，单位为 kbps
Source:

ZegoNetworkSpeedTestConfig

网络测速配置
Type:
  • Object
Properties:
Name Type Description
testUplink boolean 是否进行上行测速
expectedUplinkBitrate number 单位 kbps。用于确定网络上行环境是否适合推送指定码率的数据，建议用推流的码率来测试。
testDownlink boolean 是否进行下行测速
expectedDownlinkBitrate number 单位 kbps。用于确定网络下行环境是否适合拉取指定码率的数据，建议用推流的码率来测试。
Source:

ZegoNetworkSpeedTestQuality

网络测速质量
Type:
  • Object
Properties:
Name Type Description
connectCost number 连接服务器耗时，单位毫秒。测速过程中如果网络连接断开会自动发起重连，此变量会相应更新。
rtt number rtt，单位毫秒
packetLostRate number 丢包率，单位为百分比，0.0 ~ 1.0
Source:

ZegoPerformanceStatus

系统性能监控状态
Type:
  • Object
Properties:
Name Type Description
cpuUsageApp number 当前 App 的 CPU 使用率，取值范围 [0, 1]
cpuUsageSystem number 当前系统的 CPU 使用率，取值范围 [0, 1]
memoryUsageApp number 当前 App 的运行内存使用率，取值范围 [0, 1]
memoryUsageSystem number 当前系统的运行内存使用率，取值范围 [0, 1]
memoryUsedApp number 当前 App 的运行内存使用量，单位为 MB
Source:

ZegoPlayerConfig

拉流进阶配置。
Type:
  • Object
Properties:
Name Type Description
resourceMode ZegoStreamResourceMode 拉流资源策略模式。
cdnConfig ZegoCDNConfig 拉流的 CDN 配置，若设置后，则按照 URL 拉流而不是按照 streamID 拉流，此后 streamID 仅作为 SDK 内部回调的标识。
videoLayer ZegoPlayerVideoLayer 设置拉流的视频分层。
roomID string 房间 ID。
Source:

ZegoPlayStreamQuality

拉流质量对象
Type:
  • Object
Properties:
Name Type Description
videoRecvFPS number 视频接收帧率，单位为 f/s
videoDejitterFPS number 视频抗抖动帧率，单位为 f/s
videoDecodeFPS number 视频解码帧率，单位为 f/s
videoRenderFPS number 视频渲染帧率，单位为 f/s
videoKBPS number 视频码率，单位为 kbps
videoBreakRate number 视频卡顿率，单位为（卡顿次数/每10秒）
audioRecvFPS number 音频接收帧率，单位为 f/s
audioDejitterFPS number 音频抗抖动帧率，单位为 f/s
audioDecodeFPS number 音频解码帧率，单位为 f/s
audioRenderFPS number 音频渲染帧率，单位为 f/s
audioKBPS number 音频码率，单位为 kbps
audioBreakRate number 音频卡顿率，单位为（卡顿次数/每10秒）
rtt number 服务端至本端的延迟，单位为毫秒
packetLostRate number 丢包率，单位为百分比，0.0 ~ 1.0
peerToPeerDelay number 端到端延迟，单位为毫秒
peerToPeerPacketLostRate number 端到端丢包率，单位为百分比，0.0 ~ 1.0
level ZegoStreamQualityLevel 拉流质量级别
delay number 本端接收到数据后到播放的延迟，单位为毫秒
avTimestampDiff number 视频时间戳相对于音频时间戳的差值，用于反映音画同步情况，单位为毫秒。此值小于 0 表示视频超前音频的毫秒数, 大于 0 表示视频滞后音频的毫秒数, 等于0表示无差别。 当绝对值小于200，可基本认为音画同步，当绝对值连续 10 秒大于 200 可以认为异常
isHardwareDecode boolean 是否开启硬件解码
videoCodecID ZegoVideoCodecID 视频编码格式
totalRecvBytes number 已接收的总字节数，包括音频、视频和 SEI 等
audioRecvBytes number 已接收的音频字节数
videoRecvBytes number 已接收的视频字节数
Source:

ZegoPublishStreamQuality

推流质量对象
Type:
  • Object
Properties:
Name Type Description
videoCaptureFPS number 视频采集帧率，单位为 f/s
videoEncodeFPS number 视频编码帧率，单位为 f/s
videoSendFPS number 视频发送帧率，单位为 f/s
videoKBPS number 视频码率，单位为 kbps
audioCaptureFPS number 音频采集帧率，单位为 f/s
audioSendFPS number 音频发送帧率，单位为 f/s
audioKBPS number 音频码率，单位为 kbps
rtt number 本端至服务端的延迟，单位为毫秒
packetLostRate number 丢包率，单位为百分比，0.0 ~ 1.0
level ZegoStreamQualityLevel 推流质量级别
isHardwareEncode boolean 是否开启硬件编码
videoCodecID ZegoVideoCodecID 视频编码格式
totalSendBytes number 已发送的总字节数，包括音频、视频和SEI等
audioSendBytes number 已发送的音频字节数
videoSendBytes number 已发送的视频字节数
Source:

ZegoRect

视图相关所使用的坐标
Type:
  • Object
Properties:
Name Type Description
x number 矩形左上角在坐标系 X 轴上的值
y number 矩形左上角在坐标系 Y 轴上的值
width number 矩形宽度
height number 矩形高度
Source:

ZegoReverbAdvancedParam

音频混响高级参数
Type:
  • Object
Properties:
Name Type Description
roomSize number 房间大小（百分比），取值范围 [0.0, 100.0]，用于控制产生混响模拟的 “房间” 的大小，房间越大，混响越强
reverberance number 余响（百分比），取值范围 [0.0, 100.0]，用于控制混响的拖尾长度
damping number 混响阻尼（百分比），取值范围 [0.0, 100.0]，控制混响的衰减程度，阻尼越大，衰减越大
wetOnly boolean 只有湿信号。设置只输出混响声音，不叠加原始输入声音，默认是false。
wetGain number 湿信号增益(dB)，取值范围 [-20.0, 10.0]
dryGain number 干信号增益(dB)，取值范围 [-20.0, 10.0]
toneLow number 低频衰减，默认为不衰减（100%）
toneHigh number 高频衰减，默认为不衰减（100%）
preDelay number 初始延迟时间(ms)。取值范围[0, 200]
stereoWidth number 立体声宽度（百分比），默认值为 0%
Source:

ZegoReverbEchoParam

音频混响回声参数
Type:
  • Object
Properties:
Name Type Description
inGain number 输入音频信号的增益，取值范围 [0.0, 1.0]
outGain number 输出音频信号的增益，取值范围 [0.0, 1.0]
numDelays number 回声数量，取值范围 [0, 7]
delay Array.<number> 回声信号分别的延时，单位为毫秒，取值范围 [0, 5000] ms
decay Array.<number> 回声信号分别的衰减系数，取值范围 [0.0, 1.0]
Source:

ZegoReverbParam

音频混响参数
Type:
  • Object
Properties:
Name Type Description
roomSize number 房间大小，取值范围 [0.0, 1.0]，用于控制产生混响模拟的 “房间” 的大小，房间越大，混响越强
reverberance number 余响，取值范围 [0.0, 0.5]，用于控制混响的拖尾长度
damping number 混响阻尼，取值范围 [0.0, 2.0]，控制混响的衰减程度，阻尼越大，衰减越大
dryWetRatio number 干湿比，取值范围大于等于 0.0，控制混响与直达声和早期反射声之间的比 例，干(dry)的部分默认定为1，当干湿比设为较小时，湿(wet)的比例较大，此时混响较强
Source:

ZegoRoomConfig

房间进阶配置
Type:
  • Object
Properties:
Name Type Description
maxMemberCount number 房间最大用户数量，传 0 视为不限制，默认无限制
isUserStatusNotify boolean 是否开启用户进出房间回调通知 [onRoomUserUpdate]，默认关闭。若开发者需要使用 ZEGO 房间用户广播通知，请确保每个登录的用户都将此标记设置为true
token string 由开发者业务服务器下发的 token，用以保证安全性，生成规则详见 用户权限控制 https://doc-zh.zego.im/article/10360，默认为空字符串，即不鉴权。
Source:

ZegoRoomExtraInfo

房间附加消息
Type:
  • Object
Properties:
Name Type Description
key string 房间附加消息的键
value string 房间附加消息的值
updateUser ZegoUser 更新房间附加消息的用户。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
updateTime number 房间附加消息的更新时间，UNIX 时间戳，单位为毫秒
Source:

ZegoSEIConfig

SEI 配置
Type:
  • Object
Properties:
Name Type Description
type ZegoSEIType SEI 类型
Source:

ZegoStream

音视频流对象
Type:
  • Object
Properties:
Name Type Description
user ZegoUser 用户对象实例。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
streamID string 流 ID，长度不超过256的字符串。不可以包含 URL 关键字，否则推拉流失败。仅支持数字，英文字符 和 '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。
extraInfo string 流附加信息
Source:

ZegoStreamRelayCDNInfo

转推 CDN 信息
Type:
  • Object
Properties:
Name Type Description
url string CDN 推流的 URL
state ZegoStreamRelayCDNState 转推状态
updateReason ZegoStreamRelayCDNUpdateReason 转推状态变更的原因
stateTime number 状态发生的时间，UNIX 时间戳，单位为毫秒
Source:

ZegoUser

用户对象
Type:
  • Object
Properties:
Name Type Description
userID string 用户 ID，最大 64 字节的字符串。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。仅支持数字，英文字符 和 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。
userName string 用户名，最大长度不超过 256 字节的字符串。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
Source:

ZegoVideoConfig

视频配置
Type:
  • Object
Properties:
Name Type Description
captureWidth number 采集分辨率宽度，控制摄像头图像采集的宽度。SDK 要求设置此成员为偶数。仅摄像头启动前且没有使用自定义视频采集时，设置有效。出于性能考虑，SDK 在采集摄像头画面后、渲染预览画面之前，就将视频帧缩放为编码分辨率，因此预览画面的分辨率是编码分辨率，如果您需要预览画面的分辨率为此值，请先调用 [setCapturePipelineScaleMode] 将采集缩放模式改为 [Post]
captureHeight number 采集分辨率高度，控制摄像头图像采集的高度。SDK 要求设置此成员为偶数。仅摄像头启动前且没有使用自定义视频采集时，设置有效。出于性能考虑，SDK 在采集摄像头画面后、渲染预览画面之前，就将视频帧缩放为编码分辨率，因此预览画面的分辨率是编码分辨率，如果您需要预览画面的分辨率为此值，请先调用 [setCapturePipelineScaleMode] 将采集缩放模式改为 [Post]
encodeWidth number 编码分辨率宽度，控制编码器编码推流的图像宽度。SDK 要求设置此成员为偶数。推流前后设置均可生效
encodeHeight number 编码分辨率高度，控制编码器编码推流的图像高度。SDK 要求设置此成员为偶数。推流前后设置均可生效
fps number 帧率，控制摄像头采集帧率以及编码器编码帧率的大小。仅摄像头启动前设置有效
bitrate number 码率，单位为 kbps。推流前后设置均可生效
codecID ZegoVideoCodecID 要使用的编码器，默认为 default。仅在推流前设置生效
Source:

ZegoView

视图对象
Type:
  • Object
Properties:
Name Type Description
viewMode ZegoViewMode 视图模式，默认为 ZegoViewModeAspectFit
backgroundColor number 背景颜色，格式为 0xRRGGBB，默认为黑色即 0x000000
canvas canvas html canvas element
preserveDrawingBuffer boolean webgl context 保存缓存
Source:

ZegoVoiceChangerParam

变声器参数
Type:
  • Object
Properties:
Name Type Description
pitch number 音高参数，取值范围 [-8.0, 8.0]，数值越大声音越尖，设为 0.0 即关闭变声器。注意：变声音效只针对采集的声音有效。
Source:

ZegoWatermark

水印对象
Type:
  • Object
Properties:
Name Type Description
imageURL string 水印图片路径。支持本地文件绝对路径 (file://xxx)。 格式支持 png、jpg。
layout ZegoRect 水印图片的大小方位
Source: