ZEGO::EXPRESS

Inner Class

I Z

I
IZegoAudioMixingHandler IZegoCustomVideoCaptureHandler IZegoCustomVideoRenderHandler
IZegoEventHandler IZegoExpressEngine IZegoMediaPlayer
IZegoMediaPlayerAudioHandler IZegoMediaPlayerEventHandler IZegoMediaPlayerVideoHandler

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

Enum Lists

Typedef Lists

Enum Docs

ZegoScenario

应用使用场景

Enumerator
ZEGO_SCENARIO_GENERAL 通用场景
ZEGO_SCENARIO_COMMUNICATION 实时通讯
ZEGO_SCENARIO_LIVE 直播场景

ZegoLanguage

语言

Enumerator
ZEGO_LANGUAGE_ENGLISH 英文
ZEGO_LANGUAGE_CHINESE 中文

ZegoEngineState

引擎状态

Enumerator
ZEGO_ENGINE_STATE_START 引擎已开启
ZEGO_ENGINE_STATE_STOP 引擎已停止

ZegoRoomState

房间状态

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

ZegoPublishChannel

推流通道

Enumerator
ZEGO_PUBLISH_CHANNEL_MAIN 主推流通道
ZEGO_PUBLISH_CHANNEL_AUX 辅推流通道

ZegoViewMode

视频渲染模式

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

ZegoVideoMirrorMode

预览或拉流端的镜像模式

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

ZegoPublisherState

推流状态

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

ZegoVideoConfigPreset

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

Enumerator
ZEGO_VIDEO_CONFIG_PRESET_180P 设置分辨率为 320x180，默认采用 15 fps，码率 300 kbps
ZEGO_VIDEO_CONFIG_PRESET_270P 设置分辨率为 480x270，默认采用 15 fps，码率 400 kbps
ZEGO_VIDEO_CONFIG_PRESET_360P 设置分辨率为 640x360，默认采用 15 fps，码率 600 kbps
ZEGO_VIDEO_CONFIG_PRESET_540P 设置分辨率为 960x540，默认采用 15 fps，码率 1200 kbps
ZEGO_VIDEO_CONFIG_PRESET_720P 设置分辨率为 1280x720，默认采用 15 fps，码率 1500 kbps
ZEGO_VIDEO_CONFIG_PRESET_1080P 设置分辨率为 1920x1080，默认采用 15 fps，码率 3000 kbps

ZegoStreamQualityLevel

流质量等级

Enumerator
ZEGO_STREAM_QUALITY_LEVEL_EXCELLENT 质量极好
ZEGO_STREAM_QUALITY_LEVEL_GOOD 质量好
ZEGO_STREAM_QUALITY_LEVEL_MEDIUM 质量正常
ZEGO_STREAM_QUALITY_LEVEL_BAD 质量差
ZEGO_STREAM_QUALITY_LEVEL_DIE 质量异常

ZegoAudioChannel

音频声道

Enumerator
ZEGO_AUDIO_CHANNEL_MONO 单声道
ZEGO_AUDIO_CHANNEL_STEREO 双声道

ZegoAudioCodecID

音频编码器

Enumerator
ZEGO_AUDIO_CODEC_ID_DEFAULT default
ZEGO_AUDIO_CODEC_ID_NORMAL Normal.
ZEGO_AUDIO_CODEC_ID_NORMAL2 Normal2.
ZEGO_AUDIO_CODEC_ID_NORMAL3 Normal3.
ZEGO_AUDIO_CODEC_ID_LOW Low.
ZEGO_AUDIO_CODEC_ID_LOW2 Low2.
ZEGO_AUDIO_CODEC_ID_LOW3 Low3.

ZegoVideoCodecID

视频编码器

Enumerator
ZEGO_VIDEO_CODEC_ID_DEFAULT 默认编码
ZEGO_VIDEO_CODEC_ID_SVC SVC.
ZEGO_VIDEO_CODEC_ID_VP8 VP8.

ZegoOrientation

视频画面旋转方向枚举

Enumerator
ZEGO_ORIENTATION_0 不旋转
ZEGO_ORIENTATION_90 逆时针旋转 90 度
ZEGO_ORIENTATION_180 逆时针旋转 180 度
ZEGO_ORIENTATION_270 逆时针旋转 270 度

ZegoPlayerVideoLayer

拉流播放的视频分层

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

ZegoAECMode

回声消除模式

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

ZegoTrafficControlProperty

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

Enumerator
ZEGO_TRAFFIC_CONTROL_PROPERTY_BASIC 基础属性
ZEGO_TRAFFIC_CONTROL_PROPERTY_ADAPTIVE_FPS 调整帧率
ZEGO_TRAFFIC_CONTROL_PROPERTY_ADAPTIVE_RESOLUTION 调整分辨率
ZEGO_TRAFFIC_CONTROL_PROPERTY_ADAPTIVE_AUDIO_BITRATE 调整音频码率

ZegoTrafficControlMinVideoBitrateMode

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

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

ZegoPlayerState

拉流状态

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

ZegoPlayerMediaEvent

拉流媒体事件

Enumerator
ZEGO_PLAYER_MEDIA_EVENT_AUDIO_BREAK_OCCUR 拉流端出现音频卡顿事件
ZEGO_PLAYER_MEDIA_EVENT_AUDIO_BREAK_RESUME 拉流端音频卡顿事件结束
ZEGO_PLAYER_MEDIA_EVENT_VIDEO_BREAK_OCCUR 拉流端出现视频卡顿事件
ZEGO_PLAYER_MEDIA_EVENT_VIDEO_BREAK_RESUME 拉流端视频卡顿事件结束

ZegoUpdateType

更新类型

Enumerator
ZEGO_UPDATE_TYPE_ADD 添加
ZEGO_UPDATE_TYPE_DELETE 删除

ZegoStreamRelayCDNState

转推 CDN 状态

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

ZegoStreamRelayCDNUpdateReason

转发 CDN 状态改变原因

Enumerator
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_NONE 无
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_SERVER_ERROR 服务器错误
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_HANDSHAKE_FAILED 握手失败
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_ACCESS_POINT_ERROR 接入点错误
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_CREATE_STREAM_FAILED 创建流失败
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_BAD_NAME BAD NAME.
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_CDN_SERVER_DISCONNECTED CDN 服务器主动断开
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_DISCONNECTED 主动断开

ZegoRemoteDeviceState

远端设备状态

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

ZegoAudioDeviceType

音频设备类型

Enumerator
ZEGO_AUDIO_DEVICE_TYPE_INPUT 音频输入设备
ZEGO_AUDIO_DEVICE_TYPE_OUTPUT 音频输出设备

ZegoMixerInputContentType

混流内容类型

Enumerator
ZEGO_MIXER_INPUT_CONTENT_TYPE_AUDIO 音频混流内容类型
ZEGO_MIXER_INPUT_CONTENT_TYPE_VIDEO 视频混流内容类型

ZegoCapturePipelineScaleMode

视频采集缩放时机

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

ZegoVideoFrameFormat

视频帧格式

Enumerator
ZEGO_VIDEO_FRAME_FORMAT_UNKNOWN 未知格式，将取平台默认值
ZEGO_VIDEO_FRAME_FORMAT_I420 I420 (YUV420Planar) 格式
ZEGO_VIDEO_FRAME_FORMAT_NV12 NV12 (YUV420SemiPlanar) 格式
ZEGO_VIDEO_FRAME_FORMAT_NV21 NV21 (YUV420SemiPlanar) 格式
ZEGO_VIDEO_FRAME_FORMAT_BGRA32 BGRA32 格式
ZEGO_VIDEO_FRAME_FORMAT_RGBA32 RGBA32 格式
ZEGO_VIDEO_FRAME_FORMAT_ARGB32 ARGB32 格式
ZEGO_VIDEO_FRAME_FORMAT_ABGR32 ABGR32 格式
ZEGO_VIDEO_FRAME_FORMAT_I422 I422 (YUV422Planar) 格式

ZegoVideoEncodedFrameFormat

编码视频帧格式

Enumerator
ZEGO_VIDEO_ENCODED_FRAME_FORMAT_AVCC AVC AVCC 格式
ZEGO_VIDEO_ENCODED_FRAME_FORMAT_ANNEXB AVC Annex-B 格式

ZegoVideoBufferType

视频帧数据类型

Enumerator
ZEGO_VIDEO_BUFFER_TYPE_UNKNOWN 未知类型
ZEGO_VIDEO_BUFFER_TYPE_RAW_DATA 裸数据类型视频帧
ZEGO_VIDEO_BUFFER_TYPE_ENCODED_DATA 编码类型视频帧

ZegoVideoFrameFormatSeries

视频帧格式系列

Enumerator
ZEGO_VIDEO_FRAME_FORMAT_SERIES_RGB RGB 系列
ZEGO_VIDEO_FRAME_FORMAT_SERIES_YUV YUV 系列

ZegoVideoFlipMode

视频帧翻转模式

Enumerator
ZEGO_VIDEO_FLIP_MODE_NONE 不翻转
ZEGO_VIDEO_FLIP_MODE_X X 轴翻转

ZegoAudioConfigPreset

音频配置类型

Enumerator
ZEGO_AUDIO_CONFIG_PRESET_BASIC_QUALITY 基础音质
ZEGO_AUDIO_CONFIG_PRESET_STANDARD_QUALITY 标准音质
ZEGO_AUDIO_CONFIG_PRESET_STANDARD_QUALITY_STEREO 标准音质-双声道
ZEGO_AUDIO_CONFIG_PRESET_HIGH_QUALITY 高音质
ZEGO_AUDIO_CONFIG_PRESET_HIGH_QUALITY_STEREO 高音质-双声道

ZegoMediaPlayerState

播放器状态

Enumerator
ZEGO_MEDIA_PLAYER_STATE_NO_PLAY 不在播放
ZEGO_MEDIA_PLAYER_STATE_PLAYING 播放中
ZEGO_MEDIA_PLAYER_STATE_PAUSING 暂停播放
ZEGO_MEDIA_PLAYER_STATE_PLAY_ENDED 播放结束

ZegoMediaPlayerNetworkEvent

播放器网络事件

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

ZegoVolumeType

音量类型

Enumerator
ZEGO_VOLUME_TYPE_LOCAL 本地音量
ZEGO_VOLUME_TYPE_REMOTE 远端音量

ZegoAudioSampleRate

音频采样率

Enumerator
ZEGO_AUDIO_SAMPLE_RATE_UNKNOWN 未知
ZEGO_AUDIO_SAMPLE_RATE_8K 8K
ZEGO_AUDIO_SAMPLE_RATE_16K 16K
ZEGO_AUDIO_SAMPLE_RATE_22K 22.05K
ZEGO_AUDIO_SAMPLE_RATE_24K 24K
ZEGO_AUDIO_SAMPLE_RATE_32K 32K
ZEGO_AUDIO_SAMPLE_RATE_44K 44.1K
ZEGO_AUDIO_SAMPLE_RATE_48K 48K

Typedef Docs

ZegoDestroyCompletionCallback

public std::function< void()> ZegoDestroyCompletionCallback ()

引擎异步销毁完成的回调

ZegoPublisherSetStreamExtraInfoCallback

public std::function< void(int errorCode)> ZegoPublisherSetStreamExtraInfoCallback ()

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

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

ZegoPublisherUpdateCdnUrlCallback

public std::function< void(int errorCode)> ZegoPublisherUpdateCdnUrlCallback ()

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

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

ZegoMixerStartCallback

public std::function< void(int errorCode, std::string extendedData)> ZegoMixerStartCallback ()

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

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

ZegoMixerStopCallback

public std::function< void(int errorCode)> ZegoMixerStopCallback ()

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

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

ZegoIMSendBroadcastMessageCallback

public std::function< void(int errorCode, unsigned long long messageID)> ZegoIMSendBroadcastMessageCallback ()

发送房间聊天消息的回调

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

ZegoIMSendBarrageMessageCallback

public std::function< void(int errorCode, std::string messageID)> ZegoIMSendBarrageMessageCallback ()

发送房间弹幕消息的回调

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

ZegoIMSendCustomCommandCallback

public std::function< void(int errorCode)> ZegoIMSendCustomCommandCallback ()

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

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

ZegoMediaPlayerLoadResourceCallback

public std::function< void(int errorCode)> ZegoMediaPlayerLoadResourceCallback ()

播放器加载资源完成回调

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

ZegoMediaPlayerSeekToCallback

public std::function< void(int errorCode)> ZegoMediaPlayerSeekToCallback ()

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

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

ZegoAudioSpectrum

public std::vector< float > ZegoAudioSpectrum ()

ZegoView

public void * ZegoView ()