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
ZegoAndroidNotificationConfig
android notification config
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
ZegoBottomMenuBarConfig
Configuration options for the bottom menu bar (toolbar). You can use the ZegoUIKitPrebuiltCallConfig.bottomMenuBarConfig property to set the properties inside this class.
ZegoCallDurationConfig
Call timing configuration. You can use the ZegoUIKitPrebuiltCallConfig.durationConfig property to set the properties inside this class.
ZegoCallingBackgroundBuilderInfo
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 ZegoUIKitPrebuiltLiveAudioRoomConfig.innerText property. Note that the placeholder %0 in the text will be replaced with the corresponding username.
ZegoCallInvitationUIConfig
ZegoCallUser
User In Call
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
ZegoHangUpConfirmDialogInfo
the configuration for the hang-up confirmation dialog You can use the ZegoUIKitPrebuiltCallConfig.hangUpConfirmDialogInfo property to set the properties inside this class.
ZegoInputBoardWrapper
ZegoInRoomChatView
ZegoInRoomChatViewConfig
Control options for the bottom-left message list. This class is used for the chatViewConfig property of ZegoUIKitPrebuiltCallConfig.
ZegoInRoomCommandReceivedData
ZegoInRoomMessage
in-room message
ZegoInRoomMessageInput
ZegoInRoomMessageView
ZegoInRoomMessageViewItem
ZegoInRoomNotificationView
ZegoInRoomNotificationViewItem
ZegoIOSNotificationConfig
iOS notification config
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
ZegoMemberListConfig
Configuration for the member list. You can use the ZegoUIKitPrebuiltCallConfig.memberListConfig property to set the properties inside this class.
ZegoMicrophoneStateIcon
monitor the microphone status changes, when the status changes, the corresponding icon is automatically switched
ZegoMoreButton
more button of menu bar
ZegoPrebuiltAudioVideoViewConfig
Configuration options for audio/video views. You can use the ZegoUIKitPrebuiltCallConfig.audioVideoViewConfig 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.
ZegoRingtoneConfig
ringtone config
ZegoRoomLoginResult
Login room result callback.
ZegoScreenSharingToggleButton
ZegoScreenSharingView
display user screensharing information, and z order of widget(from bottom to top) is:
ZegoScreenSharingViewController
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
ZegoTopMenuBarConfig
Configuration options for the top menu bar (toolbar). You can use the ZegoUIKitPrebuiltCallConfig.topMenuBarConfig property to set the properties inside this class.
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
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. If the default call UI and interactions do not meet your requirements, you can use this ZegoUIKitPrebuiltCallController to actively control the business logic. This class is used by setting the controller parameter in the constructor of ZegoUIKitPrebuiltCall.
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
ZegoUIKitReceiveSEIEvent
receive SEI from remote
ZegoUIKitReceiveTurnOnLocalMicrophoneEvent
ZegoUIKitRoom
ZegoUIKitRoomState
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
SoundWaveType
Sound wave effect types.
VoiceChangerType
Enumeration of voice changer types.
ZegoAudioVideoContainerSource
ZegoAudioVideoResourceMode
Stream Resource Mode
ZegoAvatarAlignment
Specifies the alignment of an avatar.
ZegoBeautyPluginEffectsType
ZegoBeautyPluginSegmentationScaleMode
ZegoCallType
Call Type
ZegoDeviceType
ZegoInRoomMessageState
in-room message send state
ZegoMenuBarButtonName
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.
ZegoMenuBarStyle
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.
ZegoNetworkMode
Network mode
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

Constants

isScreenSharingExtraInfoKey → const String
messageTypePayloadKey → const String
muteModeCommandKey → const String
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

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>
showTopModalSheet<T>(BuildContext? context, Widget widget, {bool barrierDismissible = true}) Future<bool>
userNameItem(String name) Widget

Typedefs

MediaInfo = ZegoUIKitMediaInfo
MediaPlayResult = ZegoUIKitMediaPlayResult
MediaPlayState = ZegoUIKitMediaPlayState
MediaSeekToResult = ZegoUIKitMediaSeekToResult
MediaType = ZegoUIKitMediaType
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.
ZegoCallingBackgroundBuilder = Widget? Function(BuildContext context, Size size, ZegoCallingBackgroundBuilderInfo info)
ZegoFontSizeResolver = double Function(num fontSize, ZegoScreenUtil instance)
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)
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
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)
ZegoPresetResolution = ZegoVideoConfigPreset
ZegoRebuildFactor = bool Function(MediaQueryData old, MediaQueryData data)
ZegoScreenUtilInitBuilder = Widget Function(BuildContext context, Widget? child)
ZegoSignalingPluginZPNsThroughMessageHandler = void Function(ZPNsMessage message)