zego_uikit_prebuilt_call library

Classes

AdvanceInvitationUser
invitation user info in advance mode
ButtonIcon
Describes the icon resources for Zego UIKit.
GridLayoutDelegate
A delegate class for a grid layout with two layout modes: auto fill mode and sized mode.
GridLayoutSizedItem
InvitationUser
invitation user info
RoomProperty
ValueNotifierSliderVisibility
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:
ZegoAvatar
ZegoAvatarConfig
Configuration for the avatar in Zego UI Kit.
ZegoBeautyError
ZegoBeautyErrorCode
uikit-${library_type}-${error_type}-${error_code} 3-xx-xxx-xxx
ZegoBeautyParamConfig
ZegoBeautyPluginConfig
config of beauty plugin
ZegoBeautyPluginFaceDetectionData
ZegoBeautyPluginInnerText
inner text config of beauty plugin
ZegoBeautyPluginUIConfig
Zego Beauty Plugin UI Config
ZegoCallAndroidNotificationChannelConfig
ZegoCallAndroidNotificationConfig
android notification config
ZegoCallAudioEffectConfig
Configuration options for voice changer, beauty effects and reverberation effects.
ZegoCallAudioVideoEvents
events about audio-video
ZegoCallAudioVideoViewConfig
Configuration options for audio/video views. You can use the ZegoUIKitPrebuiltCallConfig.audioVideoView property to set the properties inside this class. These options allow you to customize the display effects of the audio/video views, such as showing microphone status and usernames. If you need to customize the foreground or background of the audio/video view, you can use foregroundBuilder and backgroundBuilder. If you want to hide user avatars or sound waveforms in audio mode, you can set showAvatarInAudioMode and showSoundWavesInAudioMode to false.
ZegoCallBottomMenuBarConfig
Configuration options for the bottom menu bar (toolbar). You can use the ZegoUIKitPrebuiltCallConfig.bottomMenuBar property to set the properties inside this class.
ZegoCallButtonUIConfig
ZegoCallControllerAudioVideoAudioOutputImpl
ZegoCallControllerAudioVideoCameraImpl
ZegoCallControllerAudioVideoImpl
Here are the APIs related to audio video.
ZegoCallControllerAudioVideoMicrophoneImpl
ZegoCallControllerInvitationImpl
Here are the APIs related to invitation.
ZegoCallControllerMinimizingImpl
ZegoCallControllerPermissionImpl
Here are the APIs related to audio video.
ZegoCallControllerPIPImpl
Here are the APIs related to audio video.
ZegoCallControllerRoomImpl
Here are the APIs related to screen sharing.
ZegoCallControllerScreenSharingImpl
ZegoCallControllerUserImpl
Here are the APIs related to user
ZegoCallDurationConfig
Call timing configuration. You can use the ZegoUIKitPrebuiltCallConfig.duration property to set the properties inside this class.
ZegoCallEndEvent
ZegoCallHangUpConfirmationEvent
ZegoCallHangUpConfirmDialogConfig
Confirmation dialog when hang up the call.
ZegoCallHangUpConfirmDialogInfo
ZegoCallingBuilderInfo
ZegoCallInRoomChatViewConfig
Control options for the bottom-left message list. This class is used for the chatView property of ZegoUIKitPrebuiltCallConfig.
ZegoCallInvitationConfig
ZegoCallInvitationData
ZegoCallInvitationInCallingConfig
ZegoCallInvitationInnerText
Control the text on the UI. Modify the values of the corresponding properties to modify the text on the UI. You can also change it to other languages. This class is used for the ZegoUIKitPrebuiltCall.innerText property. Note that the placeholder %0 in the text will be replaced with the corresponding username.
ZegoCallInvitationInviteeUIConfig
ZegoCallInvitationInviterUIConfig
ZegoCallInvitationMissedCallConfig
ZegoCallInvitationNotificationConfig
ZegoCallInvitationNotifyPopUpUIConfig
ZegoCallInvitationPermissions
ZegoCallInvitationServiceAPIImpl
Here are the APIs related to invitation.
ZegoCallInvitationServiceIOSCallKitPrivatePrivateImpl
Here are the APIs related to invitation.
ZegoCallInvitationServicePrivateImpl
Here are the APIs related to invitation.
ZegoCallInvitationUIConfig
ZegoCallIOSNotificationConfig
iOS notification config
ZegoCallMemberListConfig
Configuration for the member list. You can use the ZegoUIKitPrebuiltCallConfig.memberList property to set the properties inside this class.
ZegoCallPermissionConfirmDialogConfig
Confirmation dialog when requestPermission.
ZegoCallPermissionConfirmDialogInfo
ZegoCallPIPAndroidConfig
android pip only available on SDK higher than 26(>=26)
ZegoCallPIPConfig
pip config
ZegoCallRequiredUserConfig
Necessary participants to participate in the call.
ZegoCallRingtoneConfig
online call ringtone config Note that it only works for online calls. If it is offline, please configure it in the zego console
ZegoCallRoomEvents
events about room
ZegoCallTopMenuBarConfig
Configuration options for the top menu bar (toolbar). You can use the ZegoUIKitPrebuiltCallConfig.topMenuBar property to set the properties inside this class.
ZegoCallUser
User In Call
ZegoCallUserConfig
ZegoCallUserEvents
events about user
ZegoCameraStateIcon
monitor the camera status changes, when the status changes, the corresponding icon is automatically switched
ZegoDraggableBottomSheet
Partially visible bottom sheet that can be dragged into the screen. Provides different views for expanded and collapsed states
ZegoFontSizeResolvers
ZegoInputBoardWrapper
ZegoInRoomChatView
ZegoInRoomCommandReceivedData
ZegoInRoomMessage
in-room message
ZegoInRoomMessageInput
ZegoInRoomMessageView
ZegoInRoomMessageViewItem
ZegoInRoomNotificationView
ZegoInRoomNotificationViewItem
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
ZegoMemberList
ZegoMicrophoneStateIcon
monitor the microphone status changes, when the status changes, the corresponding icon is automatically switched
ZegoMoreButton
more button of menu bar
ZegoOutsideRoomAudioVideoViewList
display user audio and video information without join room(live/conference), and z order of widget(from bottom to top) is:
ZegoOutsideRoomAudioVideoViewListConfig
ZegoOutsideRoomAudioVideoViewListController
ZegoOutsideRoomAudioVideoViewListItemStyle
item style
ZegoOutsideRoomAudioVideoViewListStyle
view style
ZegoOutsideRoomAudioVideoViewStreamUser
stream information to pull
ZegoRoomLoginResult
Login room result callback.
ZegoScreenSharingAutoStopSettings
ZegoScreenSharingCountDownStopSettings
ZegoScreenSharingToggleButton
ZegoScreenSharingView
display user screensharing information, and z order of widget(from bottom to top) is:
ZegoScreenSharingViewController
ZegoSendCallingInvitationButton
This button is used to invite again when already in calling
ZegoSendCallingInvitationList
ZegoSendCallInvitationButton
This button is used to send a call invitation to one or more specified users.
ZegoServiceValueIcon
ZegoSignalingError
signaling error
ZegoSignalingErrorCode
uikit-${library_type}-${error_type}-${error_code} 3-xx-xxx-xxx
ZegoSignalingPluginEndInvitationResult
end invitation result
ZegoSignalingPluginIncomingInvitationCancelPushConfig
Description:Offline push configuration for cancel invitation
ZegoSignalingPluginInRoomCommandMessageResult
ZegoSignalingPluginInvitationUserInfo
Call invitation user information.
ZegoSignalingPluginInvitationUserStateChangedEvent
ZegoSignalingPluginQuitInvitationResult
quit invitation result
ZegoSignalingPluginVoIPConfig
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
ZegoUIKit APIs Features
ZegoUIKitAdvanceInvitationAcceptProtocol
ZegoUIKitAdvanceInvitationSendProtocol
ZegoUIKitDefaultTheme
ZegoUIKitError
ZegoUIKitErrorCode
uikit-${library_type}-${error_type}-${error_code} 3-xx-xxx-xxx
ZegoUIKitExpressEventInterface
Example:
ZegoUIKitInvitationSendProtocol
ZegoUIKitMediaContainer
container of media,
ZegoUIKitMediaEventInterface
Example:
ZegoUIKitMediaInfo
Media Infomration of media file.
ZegoUIKitMediaPlayer
You can use this control to play audio or video.
ZegoUIKitMediaPlayResult
media play result
ZegoUIKitMediaSeekToResult
seek result of media
ZegoUIKitMediaView
display user media view, and z order of widget(from bottom to top) is:
ZegoUIKitPrebuiltCall APIs Events Configs Components Migration_v4.x
Call Widget. You can embed this widget into any page of your project to integrate the functionality of a call. You can refer to our documentation, or our sample code.
ZegoUIKitPrebuiltCallConfig
Configuration for initializing the Call This class is used as the config parameter for the constructor of ZegoUIKitPrebuiltCall.
ZegoUIKitPrebuiltCallController
Used to control the call functionality.
ZegoUIKitPrebuiltCallEvents
ZegoUIKitPrebuiltCallInvitationEvents
Invitation-related event notifications and callbacks. You can listen to events that you are interested in here.
ZegoUIKitPrebuiltCallInvitationService
To receive the call invites from others and let the calling notification show on the top bar when receiving it, you will need to initialize the call invitation service (ZegoUIKitPrebuiltCallInvitationService) first.
ZegoUIKitPrebuiltCallMiniOverlayMachine
ZegoUIKitPrebuiltCallMiniOverlayPage
The page can be minimized within the app
ZegoUIKitPrebuiltCallMiniPopScope
When minimizing, it is not allowed to directly return to the previous page, otherwise the page will be destroyed
ZegoUIKitPublishStreamQuality
Published stream quality information.
ZegoUIKitReceiveSEIEvent
receive SEI from remote
ZegoUIKitReceiveTurnOnLocalMicrophoneEvent
ZegoUIKitRoom
ZegoUIKitRoomState
ZegoUIKitRoomStatusResult
ZegoUIKitUser
ZegoUIKitUserPropertiesNotifier
ZegoUIKitVideoConfig
configuration parameters for audio and video streaming, such as Resolution, Frame rate, Bit rate..

Enums

AdvanceInvitationState
invitation state in advance mode
AudioVideoViewFullScreeMode
BackgroundMessageType
Background MessageT ype
BeautyEffectType
Enumeration of beauty effect types.
GridLayoutAlignment
InvitationState
invitation state
NotificationItemType
ReverbType
Enumeration of reverb types.
RoomPropertyKey
VoiceChangerType
Enumeration of voice changer types.
ZegoAudioVideoContainerSource
ZegoAudioVideoResourceMode
Stream Resource Mode
ZegoAvatarAlignment
Specifies the alignment of an avatar.
ZegoBeautyPluginEffectsType
ZegoBeautyPluginSegmentationScaleMode
ZegoCallEndReason
The default behavior is to return to the previous page.
ZegoCallInvitationPermission
ZegoCallInvitationType
Call Type
ZegoCallMenuBarButtonName
Predefined buttons that can be added to the top or bottom toolbar. By configuring these options, users can customize their own top menu bar or bottom toolbar. This enum type is used in ZegoUIKitPrebuiltCallConfig.bottomMenuBarConfig and ZegoUIKitPrebuiltCallConfig.topMenuBarConfig.
ZegoCallMenuBarStyle
This enum consists of two style options: light and dark. T he light style represents a light theme with a transparent background, while the dark style represents a dark theme with a black background. You can use these options to set the desired theme style for the menu bar.
ZegoCallMiniOverlayPageState
The current state of the minimized interface can be described as follows:
ZegoDeviceType
ZegoInRoomMessageState
in-room message send state
ZegoInRoomMessageType
ZegoNetworkMode
Network mode
ZegoOutsideRoomAudioVideoViewListPlayMode
play mode
ZegoPiPStatus
ZegoRoomStateChangedReason
Room state change reason.
ZegoScenario
Room scenario.
ZegoShowFullscreenModeToggleButtonRules
Specifies the rules for showing the fullscreen mode toggle button.
ZegoShowToggleFullscreenButtonMode
ZegoSignalingPluginCallUserState
ZegoSignalingPluginConnectionAction
ZegoSignalingPluginConnectionState
ZegoSignalingPluginInvitationMode
ZegoSignalingPluginInvitationUserState
Call invitation user state.
ZegoSignalingPluginMultiCertificate
ZegoSignalingPluginRoomAction
ZegoSignalingPluginRoomState
ZegoStreamType
ZegoUIKitAudioRoute
Audio route
ZegoUIKitDeviceExceptionType
ZegoUIKitInnerSEIType
ZegoUIKitMediaPlayState
media play state normal process: noPlay->loadReady->playing->playEnded
ZegoUIKitMediaType
media type
ZegoUIKitPluginType
plugin type
ZegoUIKitTrafficControlProperty
Traffic control property (bitmask enumeration).
ZegoViewBuilderMapExtraInfoKey
ZegoViewPosition
position of small audio video view

Extensions

BackgroundMessageTypeExtension on BackgroundMessageType
BeautyEffectTypeExtension on BeautyEffectType
ReverbTypeExtension on ReverbType
RoomPropertyKeyExtension on RoomPropertyKey
VoiceChangerTypeExtension on VoiceChangerType
ZegoCallAndroidNotificationConfigDeprecated4150 on ZegoCallAndroidNotificationConfig
ZegoCallControllerInvitationImplDeprecated on ZegoCallControllerInvitationImpl
ZegoCallInvitationConfigDeprecated4150 on ZegoCallInvitationConfig
ZegoCallInvitationInnerTextForCallInvitationServicePrivate on ZegoCallInvitationInnerText
ZegoCallInvitationMissedCallConfigDeprecated4152 on ZegoCallInvitationMissedCallConfig
ZegoCallInvitationUIConfigDeprecated4110 on ZegoCallInvitationUIConfig
ZegoCallInvitationUIConfigDeprecated420 on ZegoCallInvitationUIConfig
ZegoCallInvitationUIConfigDeprecated440 on ZegoUIKitPrebuiltCallConfig
ZegoCallPipStatus on PiPStatus
ZegoCallRingtoneConfigDeprecated on ZegoCallRingtoneConfig
ZegoCallRingtoneConfigForCallInvitationServicePrivate on ZegoCallRingtoneConfig
ZegoCallTypeExtension on ZegoCallInvitationType
ZegoMixerOutputnExtension on ZegoMixerOutput
ZegoMixerOutputVideoConfignExtension on ZegoMixerOutputVideoConfig
ZegoMixerStartResultExtesion on ZegoMixerStartResult
ZegoMixerTaskExtension on ZegoMixerTask
ZegoPublishStreamQualityExtension on ZegoPublishStreamQuality
ZegoSignalingPluginIOSMultiCertificateExtension on ZegoSignalingPluginMultiCertificate
ZegoStreamTypeExtension on ZegoStreamType
ZegoUIKitDeviceExceptionTypeExtension on ZegoUIKitDeviceExceptionType
ZegoUIKitMediaPlayStateExtension on ZegoUIKitMediaPlayState
ZegoUIKitPrebuiltCallConfigDeprecated on ZegoUIKitPrebuiltCallConfig
ZegoUIKitPrebuiltCallConfigExtension on ZegoUIKitPrebuiltCallConfig
ZegoUIKitPrebuiltCallConfigParameterDeprecated on ZegoUIKitPrebuiltCallConfig
ZegoUIKitPrebuiltCallControllerDeprecated on ZegoUIKitPrebuiltCallController
ZegoUIKitPrebuiltCallControllerInvitationDeprecated on ZegoUIKitPrebuiltCallController
ZegoUIKitPrebuiltCallInvitationEventsDeprecated4152 on ZegoUIKitPrebuiltCallInvitationEvents
ZegoUIKitTrafficControlPropertyExtension on ZegoUIKitTrafficControlProperty
ZegoViewBuilderMapExtraInfoKeyExtension on ZegoViewBuilderMapExtraInfoKey

Constants

clearMessageInRoomCommandKey → const String
deprecatedTipsV400 → const String
deprecatedTipsV4100 → const String
deprecatedTipsV4120 → const String
deprecatedTipsV4150 → const String
deprecatedTipsV4152 → const String
deprecatedTipsV419 → const String
deprecatedTipsV420 → const String
deprecatedTipsV440 → const String
deprecatedTipsV491 → const String
deprecatedTipsV4_11_0 → const String
deprecatedTipsV4_1_10 → const String
isScreenSharingExtraInfoKey → const String
muteModeCommandKey → const String
param_1 → const String
%0: is a string placeholder, represents the first parameter of prompt
removeUserInRoomCommandKey → const String
The keys below are not allowed to be modified because they are compatible with the web.
turnCameraOffInRoomCommandKey → const String
turnCameraOnInRoomCommandKey → const String
turnMicrophoneOffInRoomCommandKey → const String
turnMicrophoneOnInRoomCommandKey → const String
userIDCommandKey → const String
zegoStreamTypeMediaText → const String
zegoStreamTypeScreenSharingText → const String

Properties

attributeKeyAvatar → String
no setter

Functions

avatarItem(BuildContext context, ZegoUIKitUser user, ZegoAvatarBuilder? builder) → Widget
requestPermission(Permission permission) → Future<bool>
showAlertDialog(BuildContext? context, String title, String content, List<Widget> actions, {TextStyle? titleStyle, TextStyle? contentStyle, MainAxisAlignment? actionsAlignment, Color? backgroundColor, Brightness? backgroundBrightness}) → Future<bool>
showCallingInvitationListSheet(BuildContext context, {required List<ZegoCallUser> waitingSelectUsers, required void onPressed(List<ZegoCallUser> selectedUsers), bool defaultChecked = true, List<ZegoCallUser> selectedUsers = const [], List<ZegoCallUser> userSort(List<ZegoCallUser>)?, bool rootNavigator = false, ButtonIcon? buttonIcon, Size? buttonIconSize, Size? buttonSize, ZegoAvatarBuilder? avatarBuilder, Color? userNameColor, Color? backgroundColor, String? popUpTitle, TextStyle? popUpTitleStyle, Widget? popUpBackIcon, Widget? inviteButtonIcon}) → void
Display a call invitation list pop-up.
showTopModalSheet<T>(BuildContext? context, Widget widget, {bool barrierDismissible = true}) → Future<bool>
userNameItem(String name) → Widget

Typedefs

CallEndCallback = ZegoCallEndCallback
CallHangUpConfirmationCallback = ZegoCallHangUpConfirmationCallback
MediaInfo = ZegoUIKitMediaInfo
MediaPlayResult = ZegoUIKitMediaPlayResult
MediaPlayState = ZegoUIKitMediaPlayState
MediaSeekToResult = ZegoUIKitMediaSeekToResult
MediaType = ZegoUIKitMediaType
PrebuiltCallMiniOverlayPageState = ZegoCallMiniOverlayPageState
PrebuiltConfigQuery = ZegoCallPrebuiltConfigQuery
ZegoAndroidNotificationConfig = ZegoCallAndroidNotificationConfig
ZegoAudioVideoViewBackgroundBuilder = Widget Function(BuildContext context, Size size, ZegoUIKitUser? user, Map<String, dynamic> extraInfo)
type of audio video view background builder
ZegoAudioVideoViewFilter = List<ZegoUIKitUser> Function(List<ZegoUIKitUser>)
sort
ZegoAudioVideoViewForegroundBuilder = Widget Function(BuildContext context, Size size, ZegoUIKitUser? user, Map<String, dynamic> 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<String, dynamic> extraInfo)
A typedef for the avatar builder function.
ZegoBottomMenuBarConfig = ZegoCallBottomMenuBarConfig
ZegoCallAudioVideoContainerBuilder = Widget? Function(BuildContext context, List<ZegoUIKitUser> allUsers, List<ZegoUIKitUser> audioVideoUsers, ZegoAudioVideoView audioVideoViewCreator(ZegoUIKitUser))
ZegoCallEndCallback = void Function(ZegoCallEndEvent event, VoidCallback defaultAction)
ZegoCallHangUpConfirmationCallback = Future<bool> Function(ZegoCallHangUpConfirmationEvent event, Future<bool> defaultAction())
ZegoCallingBackgroundBuilder = Widget? Function(BuildContext context, Size size, ZegoCallingBuilderInfo info)
ZegoCallingBackgroundBuilderInfo = ZegoCallAudioEffectConfig
ZegoCallingForegroundBuilder = Widget? Function(BuildContext context, Size size, ZegoCallingBuilderInfo info)
ZegoCallingPageBuilder = Widget? Function(BuildContext context, ZegoCallingBuilderInfo info)
ZegoCallInvitationNotifyDialogBuilder = Widget Function(ZegoCallInvitationData invitationData)
ZegoCallType = ZegoCallInvitationType
ZegoFontSizeResolver = double Function(num fontSize, ZegoScreenUtil instance)
ZegoHangUpConfirmDialogInfo = ZegoCallHangUpConfirmDialogInfo
ZegoInRoomChatViewConfig = ZegoCallInRoomChatViewConfig
ZegoInRoomMessageItemBuilder = Widget Function(BuildContext context, ZegoInRoomMessage message, Map<String, dynamic> extraInfo)
Chat message list builder for customizing the display of chat messages.
ZegoInRoomMessageViewItemPressEvent = void Function(ZegoInRoomMessage message)
ZegoInvitationType = ZegoCallInvitationType
ZegoIOSNotificationConfig = ZegoCallIOSNotificationConfig
ZegoLiveStreamingAudioEffectConfig = ZegoCallAudioEffectConfig
ZegoMemberListConfig = ZegoCallMemberListConfig
ZegoMemberListItemBuilder = Widget Function(BuildContext context, Size size, ZegoUIKitUser user, Map<String, dynamic> extraInfo)
Type definition for builder of custom member list item view.
ZegoMemberListSorter = List<ZegoUIKitUser> Function(ZegoUIKitUser localUser, List<ZegoUIKitUser> remoteUsers)
sort
ZegoMenuBarButtonName = ZegoCallMenuBarButtonName
ZegoMenuBarStyle = ZegoCallMenuBarStyle
ZegoMiniOverlayPage = ZegoUIKitPrebuiltCallMiniOverlayPage
ZegoNotificationMessageItemBuilder = Widget Function(BuildContext context, ZegoInRoomMessage message, Map<String, dynamic> extraInfo)
ZegoNotificationUserItemBuilder = Widget Function(BuildContext context, ZegoUIKitUser user, Map<String, dynamic> extraInfo)
ZegoPluginAdapterMessageHandler = dynamic Function(AppLifecycleState appLifecycleState)
ZegoPrebuiltAudioVideoViewConfig = ZegoCallAudioVideoViewConfig
ZegoPresetResolution = ZegoVideoConfigPreset
ZegoRebuildFactor = bool Function(MediaQueryData old, MediaQueryData data)
ZegoRingtoneConfig = ZegoCallRingtoneConfig
ZegoScreenUtilInitBuilder = Widget Function(BuildContext context, Widget? child)
ZegoSignalingPluginZPNsThroughMessageHandler = void Function(ZPNsMessage message)
ZegoTopMenuBarConfig = ZegoCallTopMenuBarConfig
ZegoUIKitCallEndEvent = ZegoCallEndEvent
ZegoUIKitCallEndReason = ZegoCallEndReason
ZegoUIKitCallHangUpConfirmationEvent = ZegoCallHangUpConfirmationEvent
ZegoUIKitPrebuiltCallAudioVideoEvents = ZegoCallAudioVideoEvents
ZegoUIKitPrebuiltCallRoomEvents = ZegoCallRoomEvents
ZegoUIKitPrebuiltCallUserEvents = ZegoCallUserEvents