zego_uikit_prebuilt_video_conference
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
-
Configuration options for the bottom menu bar (toolbar).
You can use the ZegoUIKitPrebuiltVideoConferenceConfig.
bottomMenuBarConfig
property to set the properties inside this class.
-
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
-
-
ZegoInRoomChatViewConfig
-
Control options for the bottom-left message list.
This class is used for the
chatViewConfig
property of ZegoUIKitPrebuiltVideoConferenceConfig.
-
ZegoInRoomCommandReceivedData
-
-
ZegoInRoomMessage
-
in-room message
-
ZegoInRoomMessageInput
-
-
ZegoInRoomMessageView
-
-
ZegoInRoomMessageViewItem
-
-
ZegoInRoomNotificationView
-
-
ZegoInRoomNotificationViewConfig
-
This class is used for the
notificationViewConfig
property of ZegoUIKitPrebuiltVideoConferenceConfig.
-
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
-
ZegoLeaveConfirmDialogInfo
-
the configuration for the leave confirmation dialog
You can use the ZegoUIKitPrebuiltVideoConferenceConfig.
leaveConfirmDialogInfo
property to set the properties inside this class.
-
ZegoMemberList
-
-
ZegoMemberListConfig
-
Configuration for the member list.
You can use the ZegoUIKitPrebuiltVideoConferenceConfig.
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.
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.
-
ZegoRoomLoginResult
-
Login room result callback.
-
ZegoScreenSharingToggleButton
-
-
ZegoScreenSharingView
-
display user screensharing information,
and z order of widget(from bottom to top) is:
-
ZegoScreenSharingViewController
-
-
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
-
Configuration options for the top menu bar (toolbar).
You can use the ZegoUIKitPrebuiltVideoConferenceConfig.
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:
-
ZegoUIKitPrebuiltVideoConference
Get started
APIs
Events
Configs
-
Video Conference Widget.
You can embed this widget into any page of your project to integrate the functionality of a video conference.
You can refer to our documentation,
or our sample code.
-
ZegoUIKitPrebuiltVideoConferenceConfig
-
Configuration for initializing the Video Conference
This class is used as the
config
parameter for the constructor of ZegoUIKitPrebuiltVideoConference.
-
ZegoUIKitPrebuiltVideoConferenceController
-
Used to control the video conference room functionality.
If the default video conference room UI and interactions do not meet your requirements, you can use this ZegoUIKitPrebuiltVideoConferenceController to actively control the business logic.
This class is used by setting the
controller
parameter in the constructor of ZegoUIKitPrebuiltVideoConference.
-
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..
-
ZegoVideoConferenceRoomController
-
Here are the APIs related to room.
-
ZegoVideoConferenceScreenController
-
Here are the APIs related to screen sharing.
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, )
-
type of audio video view background builder
-
ZegoAudioVideoViewFilter
= List<ZegoUIKitUser> Function(List<ZegoUIKitUser>)
-
sort
-
ZegoAudioVideoViewForegroundBuilder
= Widget Function(BuildContext context, Size size, ZegoUIKitUser? user, )
-
type of audio video view foreground builder
-
ZegoAudioVideoViewSorter
= List<ZegoUIKitUser> Function(List<ZegoUIKitUser>)
-
sort
-
ZegoAvatarBuilder
= Widget? Function(BuildContext context, Size size, ZegoUIKitUser? user, )
-
A typedef for the avatar builder function.
-
ZegoFontSizeResolver
= double Function(num fontSize, ZegoScreenUtil instance)
-
-
ZegoInRoomMessageItemBuilder
= Widget Function(BuildContext context, ZegoInRoomMessage message, )
-
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, )
-
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, )
-
-
ZegoNotificationUserItemBuilder
= Widget Function(BuildContext context, ZegoUIKitUser user, )
-
-
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)
-