ZEGO::EXPRESS

Inner Class

I Z

I
IZegoCustomVideoCaptureHandler IZegoCustomVideoRenderHandler IZegoEventHandler
IZegoExpressEngine IZegoMediaPlayer IZegoMediaPlayerAudioHandler
IZegoMediaPlayerEventHandler IZegoMediaPlayerVideoHandler

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

Enum Lists

Typedef Lists

Enum Docs

ZegoScenario

Application scenario.

Enumerator
ZEGO_SCENARIO_GENERAL General scenario.
ZEGO_SCENARIO_COMMUNICATION Communication scenario.
ZEGO_SCENARIO_LIVE Live scenario.

ZegoLanguage

Language.

Enumerator
ZEGO_LANGUAGE_ENGLISH English.
ZEGO_LANGUAGE_CHINESE Chinese.

ZegoRoomState

Room state.

Enumerator
ZEGO_ROOM_STATE_DISCONNECTED Unconnected state, enter this state before logging in and after exiting the room.
ZEGO_ROOM_STATE_CONNECTING The state that the connection is being requested.
ZEGO_ROOM_STATE_CONNECTED The status that is successfully connected.

ZegoPublishChannel

Publish channel.

Enumerator
ZEGO_PUBLISH_CHANNEL_MAIN Main publish channel.
ZEGO_PUBLISH_CHANNEL_AUX Auxiliary publish channel.

ZegoViewMode

Video rendering mode.

Enumerator
ZEGO_VIEW_MODE_ASPECT_FIT The proportional scaling up, there may be black borders.
ZEGO_VIEW_MODE_ASPECT_FILL The proportional zoom fills the entire View and may be partially cut.
ZEGO_VIEW_MODE_SCALE_TO_FILL Fill the entire view, the image may be stretched.

ZegoVideoMirrorMode

Mirror mode for previewing or playing the of the stream.

Enumerator
ZEGO_VIDEO_MIRROR_MODE_ONLY_PREVIEW_MIRROR The mirror image only for previewing locally.
ZEGO_VIDEO_MIRROR_MODE_BOTH_MIRROR Both the video previewed locally and the far end playing the stream will see mirror image.
ZEGO_VIDEO_MIRROR_MODE_NO_MIRROR Both the video previewed locally and the far end playing the stream will not see mirror image.
ZEGO_VIDEO_MIRROR_MODE_ONLY_PUBLISH_MIRROR The mirror image only for far end playing the stream.

ZegoPublisherState

Publish stream status.

Enumerator
ZEGO_PUBLISHER_STATE_NO_PUBLISH The state is not published, and it is in this state before publishing the stream.
ZEGO_PUBLISHER_STATE_PUBLISH_REQUESTING The state that it is requesting to publish the stream.
ZEGO_PUBLISHER_STATE_PUBLISHING The state that the stream is being published, entering the state indicates that the stream has been successfully published, and the user can communicate normally.

ZegoVideoConfigPreset

Video configuration resolution and bitrate preset enumeration.

Enumerator
ZEGO_VIDEO_CONFIG_PRESET_180P Set the resolution to 320x180, the default is 15 fps, the code rate is 300 kbps.
ZEGO_VIDEO_CONFIG_PRESET_270P Set the resolution to 480x270, the default is 15 fps, the code rate is 400 kbps.
ZEGO_VIDEO_CONFIG_PRESET_360P Set the resolution to 640x360, the default is 15 fps, the code rate is 600 kbps.
ZEGO_VIDEO_CONFIG_PRESET_540P Set the resolution to 960x540, the default is 15 fps, the code rate is 1200 kbps.
ZEGO_VIDEO_CONFIG_PRESET_720P Set the resolution to 1280x720, the default is 15 fps, the code rate is 1500 kbps.
ZEGO_VIDEO_CONFIG_PRESET_1080P Set the resolution to 1920x1080, the default is 15 fps, the code rate is 3000 kbps.

ZegoStreamQualityLevel

Stream quality level.

Enumerator
ZEGO_STREAM_QUALITY_LEVEL_EXCELLENT Excellent.
ZEGO_STREAM_QUALITY_LEVEL_GOOD Good.
ZEGO_STREAM_QUALITY_LEVEL_MEDIUM Normal.
ZEGO_STREAM_QUALITY_LEVEL_BAD Bad.
ZEGO_STREAM_QUALITY_LEVEL_DIE Failed.

ZegoAudioChannel

Audio channel type.

Enumerator
ZEGO_AUDIO_CHANNEL_MONO MONO.
ZEGO_AUDIO_CHANNEL_STEREO STEREO.

ZegoAudioCodecID

Audio Codec ID.

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

Video Codec ID.

Enumerator
ZEGO_VIDEO_CODEC_ID_DEFAULT default
ZEGO_VIDEO_CODEC_ID_SVC SVC.
ZEGO_VIDEO_CODEC_ID_VP8 VP8.

ZegoOrientation

Video screen rotation direction.

Enumerator
ZEGO_ORIENTATION_0 Not rotate.
ZEGO_ORIENTATION_90 Rotate 90 degrees counterclockwise.
ZEGO_ORIENTATION_180 Rotate 180 degrees counterclockwise.
ZEGO_ORIENTATION_270 Rotate 270 degrees counterclockwise.

ZegoPlayerVideoLayer

Player video layer.

Enumerator
ZEGO_PLAYER_VIDEO_LAYER_AUTO The layer to be played depends on the network status.
ZEGO_PLAYER_VIDEO_LAYER_BASE Play the base layer (small resolution)
ZEGO_PLAYER_VIDEO_LAYER_BASE_EXTEND Play the extend layer (big resolution)

ZegoAECMode

Audio echo cancellation mode.

Enumerator
ZEGO_AEC_MODE_AGGRESSIVE Aggressive echo cancellation may affect the sound quality slightly, but the echo will be very clean.
ZEGO_AEC_MODE_MEDIUM Moderate echo cancellation, which may slightly affect a little bit of sound, but the residual echo will be less.
ZEGO_AEC_MODE_SOFT Comfortable echo cancellation, that is, echo cancellation does not affect the sound quality of the sound, and sometimes there may be a little echo, but it will not affect the normal listening.

ZegoTrafficControlProperty

Traffic control property (bitmask enumeration)

Enumerator
ZEGO_TRAFFIC_CONTROL_PROPERTY_BASIC Basic.
ZEGO_TRAFFIC_CONTROL_PROPERTY_ADAPTIVE_FPS Adaptive FPS.
ZEGO_TRAFFIC_CONTROL_PROPERTY_ADAPTIVE_RESOLUTION Adaptive resolution.
ZEGO_TRAFFIC_CONTROL_PROPERTY_ADAPTIVE_AUDIO_BITRATE Adaptive Audio bitrate.

ZegoTrafficControlMinVideoBitrateMode

Video transmission mode when current bitrate is lower than the set minimum bitrate.

Enumerator
ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_MODE_NO_VIDEO Stop video transmission when current bitrate is lower than the set minimum bitrate.
ZEGO_TRAFFIC_CONTROL_MIN_VIDEO_BITRATE_MODE_ULTRA_LOW_FPS Video is sent at a very low frequency (no more than 2fps) which is lower than the set minimum bitrate.

ZegoPlayerState

Playing stream status.

Enumerator
ZEGO_PLAYER_STATE_NO_PLAY The state of the flow is not played, and it is in this state before the stream is played.
ZEGO_PLAYER_STATE_PLAY_REQUESTING The state that the stream is being requested for playing.
ZEGO_PLAYER_STATE_PLAYING The state that the stream is being playing, entering the state indicates that the stream has been successfully played, and the user can communicate normally.

ZegoPlayerMediaEvent

Media event when playing.

Enumerator
ZEGO_PLAYER_MEDIA_EVENT_AUDIO_BREAK_OCCUR Audio stuck event when playing.
ZEGO_PLAYER_MEDIA_EVENT_AUDIO_BREAK_RESUME Audio stuck event recovery when playing.
ZEGO_PLAYER_MEDIA_EVENT_VIDEO_BREAK_OCCUR Video stuck event when playing.
ZEGO_PLAYER_MEDIA_EVENT_VIDEO_BREAK_RESUME Video stuck event recovery when playing.

ZegoUpdateType

Update type.

Enumerator
ZEGO_UPDATE_TYPE_ADD Add.
ZEGO_UPDATE_TYPE_DELETE Delete.

ZegoStreamRelayCDNState

State of CDN relay.

Enumerator
ZEGO_STREAM_RELAY_CDN_STATE_NO_RELAY The state indicates that there is no CDN relay.
ZEGO_STREAM_RELAY_CDN_STATE_RELAY_REQUESTING The CDN relay is being requested.
ZEGO_STREAM_RELAY_CDN_STATE_RELAYING Entering this status indicates that the CDN relay has been successful.

ZegoStreamRelayCDNUpdateReason

Reason for state of CDN relay changed.

Enumerator
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_NONE No error.
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_SERVER_ERROR Server error.
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_HANDSHAKE_FAILED Handshake error.
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_ACCESS_POINT_ERROR Access point error.
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_CREATE_STREAM_FAILED Stream create failure.
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_BAD_NAME Bad name.
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_CDN_SERVER_DISCONNECTED CDN server actively disconnected.
ZEGO_STREAM_RELAY_CDN_UPDATE_REASON_DISCONNECTED Active disconnect.

ZegoRemoteDeviceState

Remote device status.

Enumerator
ZEGO_REMOTE_DEVICE_STATE_OPEN Device on.
ZEGO_REMOTE_DEVICE_STATE_GENERIC_ERROR General device error.
ZEGO_REMOTE_DEVICE_STATE_INVALID_ID Invalid device ID.
ZEGO_REMOTE_DEVICE_STATE_NO_AUTHORIZATION No permission.
ZEGO_REMOTE_DEVICE_STATE_ZERO_FPS Captured frame rate is 0.
ZEGO_REMOTE_DEVICE_STATE_IN_USE_BY_OTHER The device is occupied.
ZEGO_REMOTE_DEVICE_STATE_UNPLUGGED The device is not plugged in or unplugged.
ZEGO_REMOTE_DEVICE_STATE_REBOOT_REQUIRED The system needs to be restarted.
ZEGO_REMOTE_DEVICE_STATE_SYSTEM_MEDIA_SERVICES_LOST System media services stop, such as under the iOS platform, when the system detects that the current pressure is huge (such as playing a lot of animation), it is possible to disable all media related services.
ZEGO_REMOTE_DEVICE_STATE_DISABLE Capturing disabled.
ZEGO_REMOTE_DEVICE_STATE_MUTE The remote device is muted.
ZEGO_REMOTE_DEVICE_STATE_INTERRUPTION The device is interrupted, such as a phone call interruption, etc.
ZEGO_REMOTE_DEVICE_STATE_IN_BACKGROUND There are multiple apps at the same time in the foreground, such as the iPad app split screen, the system will prohibit all apps from using the camera.
ZEGO_REMOTE_DEVICE_STATE_MULTI_FOREGROUND_APP CDN server actively disconnected.
ZEGO_REMOTE_DEVICE_STATE_BY_SYSTEM_PRESSURE The system is under high load pressure and may cause abnormal equipment.

ZegoAudioDeviceType

Audio device type.

Enumerator
ZEGO_AUDIO_DEVICE_TYPE_INPUT Audio input type.
ZEGO_AUDIO_DEVICE_TYPE_OUTPUT Audio output type.

ZegoMixerInputContentType

Mix stream content type.

Enumerator
ZEGO_MIXER_INPUT_CONTENT_TYPE_AUDIO Mix stream for audio only.
ZEGO_MIXER_INPUT_CONTENT_TYPE_VIDEO Mix stream for both audio and video.

ZegoCapturePipelineScaleMode

Capture pipeline scale mode.

Enumerator
ZEGO_CAPTURE_PIPELINE_SCALE_MODE_PRE Zoom immediately after acquisition, default.
ZEGO_CAPTURE_PIPELINE_SCALE_MODE_POST Scaling while encoding.

ZegoVideoFrameFormat

Video frame format.

Enumerator
ZEGO_VIDEO_FRAME_FORMAT_UNKNOWN Unknown format, will take platform default.
ZEGO_VIDEO_FRAME_FORMAT_I420 I420 (YUV420Planar) format.
ZEGO_VIDEO_FRAME_FORMAT_NV12 NV12 (YUV420SemiPlanar) format.
ZEGO_VIDEO_FRAME_FORMAT_NV21 NV21 (YUV420SemiPlanar) format.
ZEGO_VIDEO_FRAME_FORMAT_BGRA32 BGRA32 format.
ZEGO_VIDEO_FRAME_FORMAT_RGBA32 RGBA32 format.
ZEGO_VIDEO_FRAME_FORMAT_ARGB32 ARGB32 format.
ZEGO_VIDEO_FRAME_FORMAT_ABGR32 ABGR32 format.
ZEGO_VIDEO_FRAME_FORMAT_I422 I422 (YUV422Planar) format.

ZegoVideoBufferType

Video frame buffer type.

Enumerator
ZEGO_VIDEO_BUFFER_TYPE_UNKNOWN Raw data type video frame.
ZEGO_VIDEO_BUFFER_TYPE_RAW_DATA Raw data type video frame.

ZegoVideoFrameFormatSeries

Video frame format series.

Enumerator
ZEGO_VIDEO_FRAME_FORMAT_SERIES_RGB RGB series.
ZEGO_VIDEO_FRAME_FORMAT_SERIES_YUV YUV series.

ZegoVideoFlipMode

Video frame flip mode.

Enumerator
ZEGO_VIDEO_FLIP_MODE_NONE No flip.
ZEGO_VIDEO_FLIP_MODE_X X-axis flip.

ZegoAudioConfigPreset

Audio Config Preset.

Enumerator
ZEGO_AUDIO_CONFIG_PRESET_BASIC_QUALITY basic-quality
ZEGO_AUDIO_CONFIG_PRESET_STANDARD_QUALITY standard-quality
ZEGO_AUDIO_CONFIG_PRESET_STANDARD_QUALITY_STEREO standard-quality-stereo
ZEGO_AUDIO_CONFIG_PRESET_HIGH_QUALITY high-quality
ZEGO_AUDIO_CONFIG_PRESET_HIGH_QUALITY_STEREO high-quality-stereo

ZegoMediaPlayerState

Player state.

Enumerator
ZEGO_MEDIA_PLAYER_STATE_NO_PLAY Not playing.
ZEGO_MEDIA_PLAYER_STATE_PLAYING Playing.
ZEGO_MEDIA_PLAYER_STATE_PAUSING Pausing.
ZEGO_MEDIA_PLAYER_STATE_PLAY_ENDED End of play.

ZegoMediaPlayerNetworkEvent

Player network event.

Enumerator
ZEGO_MEDIA_PLAYER_NETWORK_EVENT_BUFFER_BEGIN Network resources are not playing well, and start trying to cache data.
ZEGO_MEDIA_PLAYER_NETWORK_EVENT_BUFFER_ENDED Network resources can be played smoothly.

Typedef Docs

ZegoDestroyCompletionCallback

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

Callback for asynchronous destruction completion.

ZegoPublisherSetStreamExtraInfoCallback

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

Callback for updating stream extra information.

Parameters
errorCode Error code, please refer to the common error code document [] for details

ZegoPublisherUpdateCdnUrlCallback

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

Callback for add/remove CDN URL.

Parameters
errorCode Error code, please refer to the common error code document [] for details

ZegoMixerStartCallback

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

Results of starting a mixer task.

Parameters
errorCode Error code, please refer to the common error code document [] for details
extendedData Extended Information

ZegoMixerStopCallback

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

Results of stoping a mixer task.

Parameters
errorCode Error code, please refer to the common error code document [] for details

ZegoIMSendBroadcastMessageCallback

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

Callback for sending broadcast messages.

Parameters
errorCode Error code, please refer to the common error code document [] for details
messageID ID of this message

ZegoIMSendBarrageMessageCallback

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

Callback for sending barrage message.

Parameters
errorCode Error code, please refer to the common error code document [] for details
messageID ID of this message

ZegoIMSendCustomCommandCallback

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

Callback for sending custom command.

Parameters
errorCode Error code, please refer to the common error code document [] for details

ZegoMediaPlayerLoadResourceCallback

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

Callback for media player loads resources.

Parameters
errorCode Error code, please refer to the common error code document [] for details

ZegoMediaPlayerSeekToCallback

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

Callback for media player seek to playback progress.

Parameters
errorCode Error code, please refer to the common error code document [] for details

ZegoAudioSpectrum

public std::vector< float > ZegoAudioSpectrum ()

ZegoView

public void * ZegoView ()