zego_uikit_prebuilt_call library

Classes

ButtonIcon
GridLayoutDelegate
two layout mode:
GridLayoutSizedItem
IZegoUIKitPlugin
Permission
Defines the permissions which can be checked and requested.
PermissionWithService
A special kind of permission, used to access a service.
RoomProperty
StyleIconUrls
UIKitImage
ValueNotifierSliderVisibility
ZegoAcceptInvitationButton
ZegoAccurateSeekConfig
Precise seek configuration
ZegoAndroidNotificationConfig
ZegoAudioConfig
Audio configuration.
ZegoAudioDataCallbackBitMask
Audio data callback function enable bitmask enumeration.
ZegoAudioEffectPlayConfig
AudioEffectPlayer play configuration.
ZegoAudioEffectPlayer
Audio effect player.
ZegoAudioEffectPlayerLoadResourceResult
Callback for audio effect player loads resources.
ZegoAudioEffectPlayerSeekToResult
Callback for audio effect player seek to playback progress.
ZegoAudioFrameParam
Parameter object for audio frame.
ZegoAudioMixingData
audio mixing data.
ZegoAudioVideoContainer
container of audio video view, it will layout views by layout mode and config
ZegoAudioVideoView
display user audio and video information, and z order of widget(from bottom to top) is:
ZegoAutoMixerTask
Auto mix stream task object.
ZegoAvatar
ZegoAvatarConfig
ZegoBarrageMessageInfo
Barrage message info.
ZegoBeautifyFeature
Beauty feature (bitmask enumeration).
ZegoBeautifyOption
Beauty configuration options.
ZegoBeautyEffectSlider
ZegoBottomMenuBarConfig
ZegoBroadcastMessageInfo
Broadcast message info.
ZegoCallInvitationData
ZegoCallInvitationInnerText
ZegoCallUser
ZegoCameraStateIcon
monitor the camera status changes, when the status changes, the corresponding icon is automatically switched
ZegoCancelInvitationButton
ZegoCanvas
View object.
ZegoCDNConfig
CDN config object.
ZegoCopyrightedMusic
ZegoCopyrightedMusicConfig
CopyrightedMusic play configuration.
ZegoCopyrightedMusicDownloadResult
Callback for download song or accompaniment.
ZegoCopyrightedMusicGetKrcLyricByTokenResult
Get krc format lyrics complete callback.
ZegoCopyrightedMusicGetLrcLyricResult
Get lrc format lyrics complete callback.
ZegoCopyrightedMusicGetMusicByTokenResult
Callback for acquire songs or accompaniment through authorization token.
ZegoCopyrightedMusicGetSharedConfig
The configuration of getting shared resource.
ZegoCopyrightedMusicGetStandardPitchResult
Get standard pitch data complete callback.
ZegoCopyrightedMusicInitResult
Callback for copyrighted music init.
ZegoCopyrightedMusicRequestAccompanimentClipResult
Callback for request accompaniment clip.
ZegoCopyrightedMusicRequestAccompanimentResult
Callback for request accompaniment.
ZegoCopyrightedMusicRequestConfig
The configuration of requesting resource.
ZegoCopyrightedMusicRequestSongResult
Callback for request song.
ZegoCopyrightedMusicSendExtendedRequestResult
Callback for copyrighted music init.
ZegoCrossAppInfo
Cross APP playing stream configuration.
ZegoCustomAudioConfig
Custom audio configuration.
ZegoCustomAudioProcessConfig
Customize the audio processing configuration object.
ZegoCustomVideoCaptureConfig
Custom video capture configuration.
ZegoDataRecordConfig
Record config.
ZegoDataRecordProgress
File recording progress.
ZegoDeviceInfo
Device Info.
ZegoDraggableBottomSheet
Partially visible bottom sheet that can be dragged into the screen. Provides different views for expanded and collapsed states
ZegoEffectsBeautyParam
Beauty configuration param.
ZegoEngineConfig
Advanced engine configuration.
ZegoEngineProfile
Profile for create engine
ZegoErrorCode
ZegoExpressEngine
ZegoFontStyle
Font style.
ZegoHangUpConfirmDialogInfo
ZegoIMSendBarrageMessageResult
Callback for sending barrage message.
ZegoIMSendBroadcastMessageResult
Callback for sending broadcast messages.
ZegoIMSendCustomCommandResult
Callback for sending custom command.
ZegoInRoomChatView
ZegoInRoomCommandReceivedData
ZegoInRoomMessage
ZegoInRoomMessageInput
ZegoInRoomMessageView
ZegoInRoomNotificationView
ZegoInRoomNotificationViewItem
ZegoLabelInfo
Label info.
ZegoLayout
layout config
ZegoLayoutGallery
picture in picture layout
ZegoLayoutGalleryConfig
layout config of gallery
ZegoLayoutPictureInPicture
picture in picture layout
ZegoLayoutPictureInPictureConfig
layout config of picture in picture
ZegoLeaveButton
quit room/channel/group
ZegoLogConfig
Log config.
ZegoMediaPlayer
Zego MediaPlayer.
ZegoMediaPlayerLoadResourceResult
Callback for media player loads resources.
ZegoMediaPlayerSeekToResult
Callback for media player seek to playback progress.
ZegoMediaPlayerTakeSnapshotResult
The callback of the screenshot of the media player playing screen
ZegoMemberList
ZegoMemberListConfig
ZegoMicrophoneStateIcon
monitor the microphone status changes, when the status changes, the corresponding icon is automatically switched
ZegoMixerAudioConfig
Mix stream audio configuration.
ZegoMixerImageInfo
Set the image information of a single input stream in the mux.
ZegoMixerInput
Mixer input.
ZegoMixerOutput
Mixer output object.
ZegoMixerOutputVideoConfig
Mix stream output video config object.
ZegoMixerStartResult
Results of starting a mixer task.
ZegoMixerStopResult
Results of stoping a mixer task.
ZegoMixerTask
Mix stream task object.
ZegoMixerVideoConfig
Mix stream video config object.
ZegoMoreButton
more button of menu bar
ZegoNetworkProbeConfig
Network probe config
ZegoNetworkProbeHttpResult
http probe result
ZegoNetworkProbeResult
Network probe result
ZegoNetworkProbeTcpResult
tcp probe result
ZegoNetworkProbeTracerouteResult
traceroute result
ZegoNetworkProbeUdpResult
udp probe result
ZegoNetWorkResourceCache
Media player network cache information
ZegoNetworkSpeedTestConfig
Network speed test config
ZegoNetworkSpeedTestQuality
network speed test quality
ZegoNetworkTimeInfo
The NTP info
ZegoPerformanceStatus
System performance monitoring status
ZegoPlayerConfig
Advanced player configuration.
ZegoPlayerTakeSnapshotResult
Results of take play stream snapshot.
ZegoPlayStreamQuality
Played stream quality information.
ZegoPrebuiltAudioVideoViewConfig
ZegoPublisherConfig
Advanced publisher configuration.
ZegoPublisherSetStreamExtraInfoResult
Callback for setting stream extra information.
ZegoPublisherTakeSnapshotResult
Results of take publish stream snapshot.
ZegoPublisherUpdateCdnUrlResult
Callback for add/remove CDN URL.
ZegoPublishStreamQuality
Published stream quality information.
ZegoRangeAudio
ZegoRealTimeSequentialDataManager
ZegoRealTimeSequentialDataSentResult
Callback for sending real-time sequential data.
ZegoRefuseInvitationButton
ZegoReverbAdvancedParam
Audio reverberation advanced parameters.
ZegoReverbEchoParam
Audio reverberation echo parameters.
ZegoRingtoneConfig
ZegoRoomConfig
Advanced room configuration.
ZegoRoomExtraInfo
Room extra information.
ZegoRoomLoginResult
Login room result callback.
ZegoRoomLogoutResult
Logout room result callback.
ZegoRoomSetRoomExtraInfoResult
Callback for setting room extra information.
ZegoSEIConfig
SEI configuration
ZegoSendCallInvitationButton
ZegoServiceValueIcon
ZegoSignalingInRoomTextMessage
ZegoSignalingPluginNotificationConfig
ZegoSignalingPluginResult
signaling plugin function result
ZegoSignalingRoomBatchPropertiesData
ZegoSignalingRoomPropertiesData
ZegoSignalingUserInRoomAttributesData
ZegoSoundLevelConfig
Configuration for start sound level monitor.
ZegoSoundLevelInfo
Sound level info object.
ZegoStartInvitationButton
ZegoStream
Stream object.
ZegoStreamRelayCDNInfo
Relay to CDN info.
ZegoSwitchAudioOutputButton
button used to switch audio output route between speaker or system device
ZegoSwitchCameraButton
switch cameras
ZegoTextIconButton
text button icon button text+icon button
ZegoToggleCameraButton
button used to open/close camera
ZegoToggleMicrophoneButton
button used to open/close microphone
ZegoTopMenuBarConfig
ZegoTrafficControlProperty
Traffic control property (bitmask enumeration).
ZegoUIKit
ZegoUIKitDefaultTheme
ZegoUIKitPrebuiltCall
ZegoUIKitPrebuiltCallConfig
ZegoUIKitPrebuiltCallInvitationEvents
ZegoUIKitPrebuiltCallWithInvitation
ZegoUIKitRoom
ZegoUIKitRoomState
ZegoUIKitSignalingPluginImpl
ZegoUIKitUser
ZegoUser
User object.
ZegoVideoConfig
Video config.
ZegoVoiceChangerParam
Voice changer parameter.
ZegoWatermark
Watermark object.

Enums

BeautyEffectType
GridLayoutAlignment
NotificationItemType
PermissionStatus
Defines the state of a Permission.
PluginConnectionState
PluginRoomState
ReverbType
RoomPropertyKey
ServiceStatus
Defines the different states a service can be in.
SoundWaveType
the style of sound waves
VoiceChangerType
ZegoAECMode
Audio echo cancellation mode.
ZegoANSMode
Active Noise Suppression mode.
ZegoAudioCaptureStereoMode
Audio capture stereo mode.
ZegoAudioChannel
Audio channel type.
ZegoAudioCodecID
Audio codec ID.
ZegoAudioConfigPreset
Audio Config Preset.
ZegoAudioDeviceMode
Audio device mode.
ZegoAudioDeviceType
Audio device type.
ZegoAudioEffectPlayState
AudioEffectPlayer state.
ZegoAudioRoute
Audio route
ZegoAudioSampleRate
audio sample rate.
ZegoAudioSourceType
Audio capture source type.
ZegoAudioVADStableStateMonitorType
stable voice activity detection type
ZegoAudioVADType
voice activity detection type
ZegoAvatarAlignment
ZegoCallType
ZegoCameraExposureMode
Camera exposure mode.
ZegoCameraFocusMode
Camera focus mode.
ZegoCapturePipelineScaleMode
Capture pipeline scale mode.
ZegoCDNProtocol
CDN network protocol types supported by ZEGO
ZegoCopyrightedMusicBillingMode
VOD billing mode.
ZegoCopyrightedMusicResourceType
The music resource type. For ZegoCopyrightedMusicRequestConfig and ZegoCopyrightedMusicGetSharedConfig.
ZegoCopyrightedMusicType
The music resource type. For querycache interface.
ZegoDataRecordState
Record state.
ZegoDataRecordType
Record type.
ZegoDeviceExceptionType
The exception type for the device.
ZegoDeviceType
Device type.
ZegoElectronicEffectsMode
Mode of Electronic Effects.
ZegoEncodeProfile
video encode profile.
ZegoEngineState
engine state.
ZegoFeatureType
SDK feature type.
ZegoFontType
Font type.
ZegoInRoomMessageState
ZegoLanguage
Language.
ZegoLowlightEnhancementMode
Low light enhanced mode.
ZegoMediaPlayerAudioChannel
Audio channel.
ZegoMediaPlayerAudioTrackMode
Player audio track mode.
ZegoMediaPlayerNetworkEvent
Player network event.
ZegoMediaPlayerState
Player state.
ZegoMenuBarButtonName
prefab button on menu bar
ZegoMenuBarStyle
ZegoMixerInputContentType
Mix stream content type.
ZegoMixRenderMode
Mixing stream video view render mode.
ZegoNetworkMode
Network mode
ZegoNetworkSpeedTestType
network speed test type
ZegoOrientationMode
Orientation mode of the video.
ZegoPlayerMediaEvent
Media event when playing.
ZegoPlayerState
Playing stream status.
ZegoPlayerVideoLayer
Player video layer.
ZegoPublishChannel
Publish channel.
ZegoPublisherState
Publish stream status.
ZegoRangeAudioMicrophoneState
Range audio microphone state.
ZegoRangeAudioMode
Range audio mode
ZegoRemoteDeviceState
Remote device status.
ZegoResourceType
Resource Type.
ZegoReverbPreset
Reverberation preset value.
ZegoRoomMode
Room mode.
ZegoRoomState
Room state.
ZegoRoomStateChangedReason
Room state change reason.
ZegoScenario
Room scenario.
ZegoSEIType
SEI type
ZegoSignalingRoomAttributesUpdateAction
Room attributes update action.
ZegoStreamAlignmentMode
Stream alignment mode.
ZegoStreamCensorshipMode
Publish CensorshipMode.
ZegoStreamEvent
Publish or play stream event
ZegoStreamQualityLevel
Stream quality level.
ZegoStreamRelayCDNState
State of CDN relay.
ZegoStreamRelayCDNUpdateReason
Reason for state of CDN relay changed.
ZegoStreamResourceMode
Stream Resource Mode
ZegoSuperResolutionState
Super resolution mode.
ZegoTrafficControlFocusOnMode
Factors that trigger traffic control
ZegoTrafficControlMinVideoBitrateMode
Video transmission mode when current bitrate is lower than the set minimum bitrate.
ZegoUIKitPluginType
ZegoUpdateType
Update type.
ZegoVideoBufferType
Video frame buffer type.
ZegoVideoCodecBackend
Backend implementation of video codec.
ZegoVideoCodecID
Video codec ID.
ZegoVideoConfigPreset
Video configuration resolution and bitrate preset enumeration. The preset resolutions are adapted for mobile and desktop. On mobile, height is longer than width, and desktop is the opposite. For example, 1080p is actually 1080(w) x 1920(h) on mobile and 1920(w) x 1080(h) on desktop.
ZegoVideoFlipMode
Video frame flip mode.
ZegoVideoFrameFormat
Video frame format.
ZegoVideoFrameFormatSeries
Video frame format series.
ZegoVideoMirrorMode
Mirror mode for previewing or playing the of the stream.
ZegoVideoStreamType
Video stream type
ZegoViewBuilderMapExtraInfoKey
ZegoViewMode
Video rendering fill mode.
ZegoViewPosition
position of small audio video view
ZegoVoiceChangerPreset
Voice changer preset value.
ZegoVolumeType
volume type.

Extensions

BeautyEffectTypeExtension on BeautyEffectType
FuturePermissionStatusGetters on Future<PermissionStatus>
Utility getter extensions for the Future<PermissionStatus> type.
FutureServiceStatusGetters on Future<ServiceStatus>
Utility getter extensions for the Future<ServiceStatus> type.
PermissionActions on Permission
Actions that can be executed on a permission.
PermissionCheckShortcuts on Permission
Shortcuts for checking the status of a Permission.
PermissionListActions on List<Permission>
Actions that can be taken on a List of Permissions.
PermissionStatusGetters on PermissionStatus
Utility getter extensions for the PermissionStatus type.
ReverbTypeExtension on ReverbType
RoomPropertyKeyExtension on RoomPropertyKey
ServicePermissionActions on PermissionWithService
Actions that apply only to permissions that have an associated service.
ServiceStatusGetters on ServiceStatus
Utility getter extensions for the ServiceStatus type.
VoiceChangerTypeExtension on VoiceChangerType
ZegoCallTypeExtension on ZegoCallType
ZegoExpressAssetsUtils on ZegoExpressEngine
ZegoExpressCanvasViewUtils on ZegoExpressEngine
ZegoExpressEngineAudioEffectPlayer on ZegoExpressEngine
ZegoExpressEngineCopyrightedMusic on ZegoExpressEngine
ZegoExpressEngineCustomAudioIO on ZegoExpressEngine
ZegoExpressEngineCustomVideoIO on ZegoExpressEngine
ZegoExpressEngineDeprecatedApi on ZegoExpressEngine
ZegoExpressEngineDevice on ZegoExpressEngine
ZegoExpressEngineIM on ZegoExpressEngine
ZegoExpressEngineMediaPlayer on ZegoExpressEngine
ZegoExpressEngineMixer on ZegoExpressEngine
ZegoExpressEnginePlayer on ZegoExpressEngine
ZegoExpressEnginePreprocess on ZegoExpressEngine
ZegoExpressEnginePublisher on ZegoExpressEngine
ZegoExpressEngineRangeAudio on ZegoExpressEngine
ZegoExpressEngineRecord on ZegoExpressEngine
ZegoExpressEngineRoom on ZegoExpressEngine
ZegoExpressEngineUtilities on ZegoExpressEngine
ZegoUIKitPrebuiltCallConfigExtension on ZegoUIKitPrebuiltCallConfig

Constants

controlBarButtonBackgroundColor → const Color
param_1 → const String
%0: is a string placeholder, represents the first parameter of prompt, in here, default is user name
removeUserInRoomCommandKey → const String
turnCameraOffInRoomCommandKey → const String
turnCameraOnInRoomCommandKey → const String
turnMicrophoneOffInRoomCommandKey → const String
turnMicrophoneOnInRoomCommandKey → const String

Functions

avatarItem(BuildContext context, ZegoUIKitUser user, ZegoAvatarBuilder? builder) → Widget
openAppSettings() → Future<bool>
Opens the app settings page.
requestPermission(Permission permission) → Future<bool>
showAlertDialog(BuildContext context, String title, String content, List<Widget> actions, {TextStyle? titleStyle, TextStyle? contentStyle, MainAxisAlignment? actionsAlignment, Color? backgroundColor}) → Future<bool>
showTopModalSheet<T>(BuildContext context, Widget widget, {bool barrierDismissible = true}) → Future<T?>
userNameItem(String name) → Widget

Typedefs

PrebuiltConfigQuery = ZegoUIKitPrebuiltCallConfig Function(ZegoCallInvitationData)
ZegoAudioVideoViewBackgroundBuilder = Widget Function(BuildContext context, Size size, ZegoUIKitUser? user, Map extraInfo)
type of audio video view background builder
ZegoAudioVideoViewForegroundBuilder = Widget Function(BuildContext context, Size size, ZegoUIKitUser? user, Map extraInfo)
type of audio video view foreground builder
ZegoAudioVideoViewSorter = List<ZegoUIKitUser> Function(List<ZegoUIKitUser>)
sort
ZegoAvatarBuilder = Widget Function(BuildContext context, Size size, ZegoUIKitUser? user, Map extraInfo)
ZegoInRoomMessageItemBuilder = Widget Function(BuildContext context, ZegoInRoomMessage message, Map extraInfo)
ZegoInvitationType = ZegoCallType
ZegoMemberListItemBuilder = Widget Function(BuildContext context, Size size, ZegoUIKitUser user, Map extraInfo)
type of audio video view background builder
ZegoMemberListSorter = List<ZegoUIKitUser> Function(ZegoUIKitUser localUser, List<ZegoUIKitUser> remoteUsers)
sort
ZegoNotificationMessageItemBuilder = Widget Function(BuildContext context, ZegoInRoomMessage message, Map extraInfo)
ZegoNotificationUserItemBuilder = Widget Function(BuildContext context, ZegoUIKitUser user, Map extraInfo)
ZegoUIKitPrebuiltCallInvitationService = ZegoUIKitPrebuiltCallWithInvitation