ZegoExpressDefines.h

Include By

  • ZegoExpressEventHandler.h
  • ZegoExpressEngine+MediaPlayer.h

Includes

  • Foundation/Foundation.h
  • CoreGraphics/CoreGraphics.h
  • AVFoundation/AVFoundation.h
  • ZegoExpressErrorCode.h
  • UIKit/UIKit.h

Inner Class

Z

Z
ZegoLogConfig ZegoCustomVideoCaptureConfig ZegoCustomVideoRenderConfig
ZegoEngineConfig ZegoRoomConfig ZegoVideoConfig
ZegoUser ZegoStream ZegoCanvas
ZegoPublishStreamQuality ZegoCDNConfig ZegoStreamRelayCDNInfo
ZegoPlayerConfig ZegoPlayStreamQuality ZegoDeviceInfo
ZegoBeautifyOption ZegoMixerAudioConfig ZegoMixerVideoConfig
ZegoMixerInput ZegoMixerOutput ZegoWatermark
ZegoMixerTask ZegoBroadcastMessageInfo ZegoBarrageMessageInfo
ZegoVideoFrameParam ZegoVideoEncodedFrameParam ZegoAudioFrameParam
ZegoAudioConfig ZegoAudioMixingData ZegoMediaPlayer

Define Lists

Enum Lists

Typedef Lists

Define Docs

ZGView

Initial: ZGView UIView

ZGImage

Initial: ZGImage UIImage

ZEGO_EXPRESS_VIDEO_SDK

Initial: ZEGO_EXPRESS_VIDEO_SDK 1

ZEGO_EXPRESS_AUDIO_SDK

Initial: ZEGO_EXPRESS_AUDIO_SDK 1

Enum Docs

ZegoScenario

应用使用场景

Enumerator
ZegoScenarioGeneral 通用场景
ZegoScenarioCommunication 实时通讯
ZegoScenarioLive 直播场景

ZegoLanguage

语言

Enumerator
ZegoLanguageEnglish 英文
ZegoLanguageChinese 中文

ZegoEngineState

引擎状态

Enumerator
ZegoEngineStateStart 引擎已开启
ZegoEngineStateStop 引擎已停止

ZegoRoomState

房间状态

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

ZegoPublishChannel

推流通道

Enumerator
ZegoPublishChannelMain 主推流通道
ZegoPublishChannelAux 辅推流通道

ZegoViewMode

视频渲染模式

Enumerator
ZegoViewModeAspectFit 等比缩放，可能有黑边
ZegoViewModeAspectFill 等比缩放填充整个 View，可能有部分被裁减
ZegoViewModeScaleToFill 填充整个 View，图像可能被拉伸

ZegoVideoMirrorMode

预览或拉流端的镜像模式

Enumerator
ZegoVideoMirrorModeOnlyPreviewMirror 只有本地预览时才是镜像画面，默认采用此模式
ZegoVideoMirrorModeBothMirror 本地预览和拉流端看到的视频都是镜像画面
ZegoVideoMirrorModeNoMirror 本地预览和拉流端看到的视频都不是镜像画面
ZegoVideoMirrorModeOnlyPublishMirror 只有拉流端看到的视频才是镜像画面

ZegoPublisherState

推流状态

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

ZegoVideoConfigPreset

视频配置分辨率与比特率预设枚举。预设的分辨率分别针对移动端与桌面端做了适配。在移动端上 height 长于 width，而桌面端相反。例如 1080p 在移动端上实际为 1080(w) x 1920(h)，而在桌面端上实际为 1920(w) x 1080(h)

Enumerator
ZegoVideoConfigPreset180P 设置分辨率为 320x180，默认采用 15 fps，码率 300 kbps
ZegoVideoConfigPreset270P 设置分辨率为 480x270，默认采用 15 fps，码率 400 kbps
ZegoVideoConfigPreset360P 设置分辨率为 640x360，默认采用 15 fps，码率 600 kbps
ZegoVideoConfigPreset540P 设置分辨率为 960x540，默认采用 15 fps，码率 1200 kbps
ZegoVideoConfigPreset720P 设置分辨率为 1280x720，默认采用 15 fps，码率 1500 kbps
ZegoVideoConfigPreset1080P 设置分辨率为 1920x1080，默认采用 15 fps，码率 3000 kbps

ZegoStreamQualityLevel

流质量等级

Enumerator
ZegoStreamQualityLevelExcellent 质量极好
ZegoStreamQualityLevelGood 质量好
ZegoStreamQualityLevelMedium 质量正常
ZegoStreamQualityLevelBad 质量差
ZegoStreamQualityLevelDie 质量异常

ZegoAudioChannel

音频声道

Enumerator
ZegoAudioChannelMono 单声道
ZegoAudioChannelStereo 双声道

ZegoAudioCodecID

音频编码器

Enumerator
ZegoAudioCodecIDDefault default
ZegoAudioCodecIDNormal Normal.
ZegoAudioCodecIDNormal2 Normal2.
ZegoAudioCodecIDNormal3 Normal3.
ZegoAudioCodecIDLow Low.
ZegoAudioCodecIDLow2 Low2.
ZegoAudioCodecIDLow3 Low3.

ZegoVideoCodecID

视频编码器

Enumerator
ZegoVideoCodecIDDefault 默认编码
ZegoVideoCodecIDSVC SVC.
ZegoVideoCodecIDVP8 VP8.

ZegoPlayerVideoLayer

拉流播放的视频分层

Enumerator
ZegoPlayerVideoLayerAuto 根据网络状态选择图层
ZegoPlayerVideoLayerBase 指定拉基本层（小分辨率）
ZegoPlayerVideoLayerBaseExtend 指定拉扩展层（大分辨率)

ZegoAECMode

回声消除模式

Enumerator
ZegoAECModeAggressive 激进的回声抵消，可能会影响音质稍微明显，但是回声会消除得很干净
ZegoAECModeMedium 适度的回声抵消，就是可能会稍微影响一点点音质，但是残留的回声会更少
ZegoAECModeSoft 舒适的回声抵消，就是回声抵消基本不会影响声音的音质，可能有时会残留一点回声，但不会影响正常听音

ZegoTrafficControlProperty

当发生流量控制时可供调节的属性（位掩码枚举）

Enumerator
ZegoTrafficControlPropertyBasic 基础属性
ZegoTrafficControlPropertyAdaptiveFPS 调整帧率
ZegoTrafficControlPropertyAdaptiveResolution 调整分辨率
ZegoTrafficControlPropertyAdaptiveAudioBitrate 调整音频码率

ZegoTrafficControlMinVideoBitrateMode

流控触发最低码率时的视频发送模式

Enumerator
ZegoTrafficControlMinVideoBitrateModeNoVideo 低于设置的最低码率时，停止视频发送
ZegoTrafficControlMinVideoBitrateModeUltraLowFPS 低于设置的最低码率时，视频以极低的频率发送（不超过 2 FPS)

ZegoPlayerState

拉流状态

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

ZegoPlayerMediaEvent

拉流媒体事件

Enumerator
ZegoPlayerMediaEventAudioBreakOccur 拉流端出现音频卡顿事件
ZegoPlayerMediaEventAudioBreakResume 拉流端音频卡顿事件结束
ZegoPlayerMediaEventVideoBreakOccur 拉流端出现视频卡顿事件
ZegoPlayerMediaEventVideoBreakResume 拉流端视频卡顿事件结束

ZegoUpdateType

更新类型

Enumerator
ZegoUpdateTypeAdd 添加
ZegoUpdateTypeDelete 删除

ZegoStreamRelayCDNState

转推 CDN 状态

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

ZegoStreamRelayCDNUpdateReason

转发 CDN 状态改变原因

Enumerator
ZegoStreamRelayCDNUpdateReasonNone 无
ZegoStreamRelayCDNUpdateReasonServerError 服务器错误
ZegoStreamRelayCDNUpdateReasonHandshakeFailed 握手失败
ZegoStreamRelayCDNUpdateReasonAccessPointError 接入点错误
ZegoStreamRelayCDNUpdateReasonCreateStreamFailed 创建流失败
ZegoStreamRelayCDNUpdateReasonBadName BAD NAME.
ZegoStreamRelayCDNUpdateReasonCDNServerDisconnected CDN 服务器主动断开
ZegoStreamRelayCDNUpdateReasonDisconnected 主动断开

ZegoBeautifyFeature

美颜特性（位掩码枚举）

Enumerator
ZegoBeautifyFeatureNone 无美颜
ZegoBeautifyFeaturePolish 磨皮
ZegoBeautifyFeatureWhiten 锐化
ZegoBeautifyFeatureSkinWhiten 皮肤美白
ZegoBeautifyFeatureSharpen 全屏美白

ZegoRemoteDeviceState

远端设备状态

Enumerator
ZegoRemoteDeviceStateOpen 设备开启
ZegoRemoteDeviceStateGenericError 设备关闭：一般性设备错误
ZegoRemoteDeviceStateInvalidID 设备关闭：无效的设备 ID
ZegoRemoteDeviceStateNoAuthorization 设备关闭：无权限
ZegoRemoteDeviceStateZeroFPS 设备关闭：采集帧率为 0
ZegoRemoteDeviceStateInUseByOther 设备关闭：设备被占用
ZegoRemoteDeviceStateUnplugged 设备关闭：设备未插入或被拔出
ZegoRemoteDeviceStateRebootRequired 设备关闭：由于系统原因需要重启后才能进行下一次修改，否则重新打开也不生效
ZegoRemoteDeviceStateSystemMediaServicesLost 设备关闭：系统媒体服务停止，如 iOS 平台下，当系统检测到当前压力巨大（如播放大量动画），则有可能会将媒体相关服务全部停用
ZegoRemoteDeviceStateDisable 设备关闭：禁用采集
ZegoRemoteDeviceStateMute 设备关闭：远端设备被静音
ZegoRemoteDeviceStateInterruption 设备关闭：设备被中断，如电话事件打断等
ZegoRemoteDeviceStateInBackground 设备关闭：用户 App 退到后台
ZegoRemoteDeviceStateMultiForegroundApp 设备关闭：当前前台同时存在多个 App，如 iPad 应用分屏下，系统会禁止所有应用使用摄像头
ZegoRemoteDeviceStateBySystemPressure 设备关闭：系统处于高负载压力下，可能导致设备异常

ZegoAudioDeviceType

音频设备类型

Enumerator
ZegoAudioDeviceTypeInput 音频输入设备
ZegoAudioDeviceTypeOutput 音频输出设备

ZegoMixerInputContentType

混流内容类型

Enumerator
ZegoMixerInputContentTypeAudio 音频混流内容类型
ZegoMixerInputContentTypeVideo 视频混流内容类型

ZegoCapturePipelineScaleMode

视频采集缩放时机

Enumerator
ZegoCapturePipelineScaleModePre 采集后立即进行缩放，默认
ZegoCapturePipelineScaleModePost 编码时进行缩放

ZegoVideoFrameFormat

视频帧格式

Enumerator
ZegoVideoFrameFormatUnknown 未知格式，将取平台默认值
ZegoVideoFrameFormatI420 I420 (YUV420Planar) 格式
ZegoVideoFrameFormatNV12 NV12 (YUV420SemiPlanar) 格式
ZegoVideoFrameFormatNV21 NV21 (YUV420SemiPlanar) 格式
ZegoVideoFrameFormatBGRA32 BGRA32 格式
ZegoVideoFrameFormatRGBA32 RGBA32 格式
ZegoVideoFrameFormatARGB32 ARGB32 格式
ZegoVideoFrameFormatABGR32 ABGR32 格式
ZegoVideoFrameFormatI422 I422 (YUV422Planar) 格式

ZegoVideoEncodedFrameFormat

编码视频帧格式

Enumerator
ZegoVideoEncodedFrameFormatAVCC AVC AVCC 格式
ZegoVideoEncodedFrameFormatAnnexB AVC Annex-B 格式

ZegoVideoBufferType

视频帧数据类型

Enumerator
ZegoVideoBufferTypeUnknown 未知类型
ZegoVideoBufferTypeRawData 裸数据类型视频帧
ZegoVideoBufferTypeEncodedData 编码类型视频帧
ZegoVideoBufferTypeGLTexture2D OpenGL Texture 2D 类型视频帧
ZegoVideoBufferTypeCVPixelBuffer CVPixelBuffer 类型视频帧

ZegoVideoFrameFormatSeries

视频帧格式系列

Enumerator
ZegoVideoFrameFormatSeriesRGB RGB 系列
ZegoVideoFrameFormatSeriesYUV YUV 系列

ZegoVideoFlipMode

视频帧翻转模式

Enumerator
ZegoVideoFlipModeNone 不翻转
ZegoVideoFlipModeX X 轴翻转

ZegoAudioConfigPreset

音频配置类型

Enumerator
ZegoAudioConfigPresetBasicQuality 基础音质
ZegoAudioConfigPresetStandardQuality 标准音质
ZegoAudioConfigPresetStandardQualityStereo 标准音质-双声道
ZegoAudioConfigPresetHighQuality 高音质
ZegoAudioConfigPresetHighQualityStereo 高音质-双声道

ZegoMediaPlayerState

播放器状态

Enumerator
ZegoMediaPlayerStateNoPlay 不在播放
ZegoMediaPlayerStatePlaying 播放中
ZegoMediaPlayerStatePausing 暂停播放
ZegoMediaPlayerStatePlayEnded 播放结束

ZegoMediaPlayerNetworkEvent

播放器网络事件

Enumerator
ZegoMediaPlayerNetworkEventBufferBegin 网络资源播放不畅，开始尝试缓存数据
ZegoMediaPlayerNetworkEventBufferEnded 网络资源可以顺畅播放

ZegoVolumeType

音量类型

Enumerator
ZegoVolumeTypeLocal 本地音量
ZegoVolumeTypeRemote 远端音量

ZegoAudioSampleRate

音频采样率

Enumerator
ZegoAudioSampleRateUnknown 未知
ZegoAudioSampleRate8K 8K
ZegoAudioSampleRate16K 16K
ZegoAudioSampleRate22K 22.05K
ZegoAudioSampleRate24K 24K
ZegoAudioSampleRate32K 32K
ZegoAudioSampleRate44K 44.1K
ZegoAudioSampleRate48K 48K

Typedef Docs

ZegoDestroyCompletionCallback

public void(^ ZegoDestroyCompletionCallback ()

引擎异步销毁完成的回调

ZegoPublisherSetStreamExtraInfoCallback

public void(^ ZegoPublisherSetStreamExtraInfoCallback ()

更新流附加信息接口的回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []

ZegoPublisherUpdateCdnUrlCallback

public void(^ ZegoPublisherUpdateCdnUrlCallback ()

添加/删除转推 CDN 接口的回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []

ZegoMixerStartCallback

public void(^ ZegoMixerStartCallback ()

开始混流任务的结果的回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []
extendedData 扩展信息

ZegoMixerStopCallback

public void(^ ZegoMixerStopCallback ()

结束混流任务的结果的回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []

ZegoIMSendBroadcastMessageCallback

public void(^ ZegoIMSendBroadcastMessageCallback ()

发送房间聊天消息的回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []
messageID 此消息的 ID

ZegoIMSendBarrageMessageCallback

public void(^ ZegoIMSendBarrageMessageCallback ()

发送房间弹幕消息的回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []
messageID 此消息的 ID

ZegoIMSendCustomCommandCallback

public void(^ ZegoIMSendCustomCommandCallback ()

发送房间自定义信令的回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []

ZegoMediaPlayerLoadResourceCallback

public void(^ ZegoMediaPlayerLoadResourceCallback ()

播放器加载资源完成回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []

ZegoMediaPlayerSeekToCallback

public void(^ ZegoMediaPlayerSeekToCallback ()

播放器设置指定播放进度回调

Parameters
errorCode 错误码，详情请参考常用错误码文档 []