zego_uikit_prebuilt_live_streaming library

Classes

AdvanceInvitationAcceptData
AdvanceInvitationRequestData
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
LiveStreamingControllerSwipingImpl
Here are the APIs related to swiping
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
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
ZegoLiveStreamingAudioVideoEvents
events about audio-video
ZegoLiveStreamingAudioVideoViewConfig
Configuration options for audio/video views.
ZegoLiveStreamingBottomMenuBarButtonStyle
Button style for the bottom toolbar, allowing customization of button icons or text.
ZegoLiveStreamingBottomMenuBarConfig
Configuration options for the bottom menu bar (toolbar).
ZegoLiveStreamingCoHostAudienceEvents
Audience Related Events of CoHost
ZegoLiveStreamingCoHostCoHostEvents
Co-Host Related Events of CoHost
ZegoLiveStreamingCoHostConfig
ZegoLiveStreamingCoHostEvents
CoHost Related Events
ZegoLiveStreamingCoHostHostEvents
Host Related Events of CoHost
ZegoLiveStreamingControllerAudioVideoAudioOutputImpl
ZegoLiveStreamingControllerAudioVideoCameraImpl
ZegoLiveStreamingControllerAudioVideoImpl
Here are the APIs related to audio video.
ZegoLiveStreamingControllerAudioVideoMicrophoneImpl
ZegoLiveStreamingControllerCoHostImpl
Here are the APIs related to inviting co-hosts to connect.
ZegoLiveStreamingControllerMessageImpl
Here are the APIs related to message.
ZegoLiveStreamingControllerMinimizingImpl
Here are the APIs related to screen sharing.
ZegoLiveStreamingControllerPKImpl
Here are the APIs related to PK.
ZegoLiveStreamingControllerRoomImpl
Here are the APIs related to screen sharing.
ZegoLiveStreamingControllerUserImpl
Here are the APIs related to audio video.
ZegoLiveStreamingDialogInfo
Dialog information. Used to control whether certain features display a dialog, such as whether to show a confirmation dialog when request camera permission.
ZegoLiveStreamingDurationConfig
Live Streaming timing configuration.
ZegoLiveStreamingDurationEvents
ZegoLiveStreamingEffectConfig
Configuration options for voice changer, beauty effects and reverberation effects.
ZegoLiveStreamingEndEvent
ZegoLiveStreamingIncomingPKBattleRequestCancelledEvent
ZegoLiveStreamingIncomingPKBattleRequestReceivedEvent
ZegoLiveStreamingIncomingPKBattleRequestUser
ZegoLiveStreamingInRoomMessageConfig
Control options for the bottom-left message list.
ZegoLiveStreamingInRoomMessageEvents
ZegoLiveStreamingLeaveConfirmationEvent
ZegoLiveStreamingMediaPlayerConfig
media player config
ZegoLiveStreamingMemberButtonConfig
Configuration for the member button of top bar.
ZegoLiveStreamingMemberListConfig
Configuration for the member list.
ZegoLiveStreamingMemberListEvents
ZegoLiveStreamingMenuBarExtendButton
Extension buttons for the bottom toolbar.
ZegoLiveStreamingPKBattleConfig
Used to configure the parameters related to PK battles
ZegoLiveStreamingPKEvents
pk related events
ZegoLiveStreamingPKMixerLayout
Inheritance of the hybrid layout parent class allows you to return your custom coordinates and modify the layout of the mixed stream. You can refer to ZegoLiveStreamingPKPreferGridMixerLayout or ZegoPKV2GridMixerLayout.
ZegoLiveStreamingPKServiceResult
result of request in pk service
ZegoLiveStreamingPKServiceSendRequestResult
result of send request in pk service
ZegoLiveStreamingPKUser
ZegoLiveStreamingPreviewConfig
Used to configure the parameters related to the preview of the live streaming.
ZegoLiveStreamingRoomEvents
events about room
ZegoLiveStreamingScreenController
Here are the APIs related to screen sharing.
ZegoLiveStreamingSwipingConfig
Live Streaming swiping configuration.
ZegoLiveStreamingTopMenuBarConfig
Configuration options for the top menu bar (toolbar).
ZegoLiveStreamingTopMenuBarEvents
ZegoLiveStreamingUserEvents
events about user
ZegoMemberList
ZegoMicrophoneStateIcon
monitor the microphone status changes, when the status changes, the corresponding icon is automatically switched
ZegoMoreButton
more button of menu bar
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
ZegoUIKit APIs Features
ZegoUIKitDefaultTheme
ZegoUIKitError
ZegoUIKitErrorCode
uikit-${library_type}-${error_type}-${error_code} 3-xx-xxx-xxx
ZegoUIKitExpressEventInterface
Example:
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:
ZegoUIKitPrebuiltLiveStreaming APIs Events Configs Migration_v3.x
Live Streaming Widget.
ZegoUIKitPrebuiltLiveStreamingConfig
Configuration for initializing the Live Streaming
ZegoUIKitPrebuiltLiveStreamingController
Used to control the live streaming functionality.
ZegoUIKitPrebuiltLiveStreamingEvents
You can listen to events that you are interested in here, such as Co-hosting
ZegoUIKitPrebuiltLiveStreamingInnerText
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.
ZegoUIKitPrebuiltLiveStreamingMiniOverlayMachine
ZegoUIKitPrebuiltLiveStreamingMiniOverlayPage
The page can be minimized within the app
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
VoiceChangerType
Enumeration of voice changer types.
ZegoAudioVideoContainerSource
ZegoAudioVideoResourceMode
Stream Resource Mode
ZegoAvatarAlignment
Specifies the alignment of an avatar.
ZegoBeautyPluginEffectsType
ZegoBeautyPluginSegmentationScaleMode
ZegoDeviceType
ZegoInRoomMessageState
in-room message send state
ZegoLiveStreamingAudienceConnectState
only for audience or co-host, connection state
ZegoLiveStreamingEndReason
The default behavior is to return to the previous page.
ZegoLiveStreamingMenuBarButtonName
This enum type is used in ZegoUIKitPrebuiltLiveStreamingConfig.bottomMenuBarConfig.
ZegoLiveStreamingMiniOverlayPageState
mini state
ZegoLiveStreamingPKBattleRejectCode
reject code in pk service
ZegoLiveStreamingPKBattleState
state in pk service
ZegoLiveStreamingRole
Live streaming roles.
ZegoLiveStreamingState
Live streaming state
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

Extensions

BackgroundMessageTypeExtension on BackgroundMessageType
BeautyEffectTypeExtension on BeautyEffectType
ReverbTypeExtension on ReverbType
RoomPropertyKeyExtension on RoomPropertyKey
VoiceChangerTypeExtension on VoiceChangerType
ZegoLiveStreamingAudienceEventsExtension on ZegoUIKitPrebuiltLiveStreamingAudienceEvents
ZegoLiveStreamingConfigDeprecated on ZegoUIKitPrebuiltLiveStreamingConfig
ZegoLiveStreamingControllerDeprecated on ZegoUIKitPrebuiltLiveStreamingController
ZegoLiveStreamingControllerRoomImplDeprecated on ZegoLiveStreamingControllerRoomImpl
ZegoLiveStreamingControllerUserImplDeprecated on ZegoLiveStreamingControllerUserImpl
ZegoLiveStreamingDurationEventsDeprecatedExtension on ZegoLiveStreamingDurationEvents
ZegoLiveStreamingEventsDeprecated on ZegoUIKitPrebuiltLiveStreamingEvents
ZegoLiveStreamingHostEventsExtension on ZegoUIKitPrebuiltLiveStreamingHostEvents
ZegoLiveStreamingPKBattleConfigDeprecatedExtension on ZegoLiveStreamingPKBattleConfig
ZegoLiveStreamingPKEventsExtension on ZegoLiveStreamingPKEvents
ZegoMixerOutputExtesion on ZegoMixerOutput
ZegoMixerOutputVideoConfigExtesion on ZegoMixerOutputVideoConfig
ZegoMixerStartResultExtesion on ZegoMixerStartResult
ZegoMixerTaskExtesion on ZegoMixerTask
ZegoSignalingPluginIOSMultiCertificateExtension on ZegoSignalingPluginMultiCertificate
ZegoStreamTypeExtension on ZegoStreamType
ZegoUIKitDeviceExceptionTypeExtension on ZegoUIKitDeviceExceptionType
ZegoUIKitMediaPlayStateExtension on ZegoUIKitMediaPlayState
ZegoUIKitPrebuiltLiveStreamingConfigDeprecatedExtensionV340 on ZegoUIKitPrebuiltLiveStreamingConfig
ZegoUIKitTrafficControlPropertyExtension on ZegoUIKitTrafficControlProperty
ZegoViewBuilderMapExtraInfoKeyExtension on ZegoViewBuilderMapExtraInfoKey

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
PrebuiltLiveStreamingMiniOverlayPageState = ZegoLiveStreamingMiniOverlayPageState
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.
ZegoBottomMenuBarButtonStyle = ZegoLiveStreamingBottomMenuBarButtonStyle
ZegoBottomMenuBarConfig = ZegoLiveStreamingBottomMenuBarConfig
ZegoDialogInfo = ZegoLiveStreamingDialogInfo
ZegoEffectConfig = ZegoLiveStreamingEffectConfig
ZegoFontSizeResolver = double Function(num fontSize, ZegoScreenUtil instance)
ZegoIncomingPKBattleRequestCancelledEvent = ZegoLiveStreamingIncomingPKBattleRequestCancelledEvent
ZegoIncomingPKBattleRequestCancelledEventV2 = ZegoIncomingPKBattleRequestCancelledEvent
ZegoIncomingPKBattleRequestReceivedEvent = ZegoLiveStreamingIncomingPKBattleRequestReceivedEvent
ZegoIncomingPKBattleRequestReceivedEventV2 = ZegoIncomingPKBattleRequestReceivedEvent
ZegoIncomingPKBattleRequestTimeoutEvent = ZegoLiveStreamingIncomingPKBattleRequestTimeoutEvent
ZegoIncomingPKBattleRequestTimeoutEventV2 = ZegoIncomingPKBattleRequestTimeoutEvent
ZegoInnerText = ZegoUIKitPrebuiltLiveStreamingInnerText
ZegoInRoomMessageConfig = ZegoLiveStreamingInRoomMessageConfig
ZegoInRoomMessageItemBuilder = Widget Function(BuildContext context, ZegoInRoomMessage message, Map<String, dynamic> extraInfo)
Chat message list builder for customizing the display of chat messages.
ZegoInRoomMessageViewConfig = ZegoLiveStreamingInRoomMessageConfig
ZegoInRoomMessageViewItemPressEvent = void Function(ZegoInRoomMessage message)
ZegoLiveDurationConfig = ZegoLiveStreamingDurationConfig
ZegoLiveStreamingAudioVideoContainerBuilder = Widget? Function(BuildContext context, List<ZegoUIKitUser> allUsers, List<ZegoUIKitUser> audioVideoUsers, ZegoAudioVideoView audioVideoViewCreator(ZegoUIKitUser))
ZegoLiveStreamingConnectEvent = void Function(ZegoUIKitUser audience)
ZegoLiveStreamingPKBattleHostReconnectingBuilder = Widget Function(BuildContext context, ZegoUIKitUser? host, Map<String, dynamic> extraInfo)
This function should return a Widget that is used to customize the UI displayed when the host reconnects in a PK battle.
ZegoLiveStreamingPKBattleStateV2 = ZegoLiveStreamingPKBattleState
ZegoLiveStreamingPKBattleV2Config = ZegoLiveStreamingPKBattleConfig
ZegoLiveStreamingPKBattleViewBuilder = Widget Function(BuildContext context, List<ZegoUIKitUser?> hosts, Map<String, dynamic> extraInfo)
This typedef defines a callback function for building custom components for the PK Battle view.
ZegoLiveStreamingPKController = ZegoLiveStreamingControllerPKImpl
ZegoLiveStreamingPKControllerV2 = ZegoLiveStreamingPKController
ZegoLiveStreamingPKMixerDefaultLayout = ZegoLiveStreamingPKPreferGridMixerLayout
ZegoLiveStreamingStartLiveButtonBuilder = Widget Function(BuildContext context, VoidCallback startLive)
A callback function for customizing the start live button It should return a Widget that represents the custom start live button.
ZegoMediaPlayerConfig = ZegoLiveStreamingMediaPlayerConfig
ZegoMemberButtonConfig = ZegoLiveStreamingMemberButtonConfig
ZegoMemberListConfig = ZegoLiveStreamingMemberListConfig
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 = ZegoLiveStreamingMenuBarButtonName
ZegoMenuBarExtendButton = ZegoLiveStreamingMenuBarExtendButton
ZegoMiniOverlayPage = ZegoUIKitPrebuiltLiveStreamingMiniOverlayPage
ZegoNotificationMessageItemBuilder = Widget Function(BuildContext context, ZegoInRoomMessage message, Map<String, dynamic> extraInfo)
ZegoNotificationUserItemBuilder = Widget Function(BuildContext context, ZegoUIKitUser user, Map<String, dynamic> extraInfo)
ZegoOutgoingPKBattleRequestAcceptedEvent = ZegoLiveStreamingOutgoingPKBattleRequestAcceptedEvent
ZegoOutgoingPKBattleRequestAcceptedEventV2 = ZegoOutgoingPKBattleRequestAcceptedEvent
ZegoOutgoingPKBattleRequestRejectedEvent = ZegoLiveStreamingOutgoingPKBattleRequestRejectedEvent
ZegoOutgoingPKBattleRequestRejectedEventV2 = ZegoOutgoingPKBattleRequestRejectedEvent
ZegoOutgoingPKBattleRequestTimeoutEvent = ZegoLiveStreamingOutgoingPKBattleRequestTimeoutEvent
ZegoOutgoingPKBattleRequestTimeoutEventV2 = ZegoOutgoingPKBattleRequestTimeoutEvent
ZegoPKBattleEndedEvent = ZegoLiveStreamingPKBattleEndedEvent
ZegoPKBattleEndedEventV2 = ZegoPKBattleEndedEvent
ZegoPKBattleUserOfflineEvent = ZegoLiveStreamingPKBattleUserOfflineEvent
ZegoPKBattleUserOfflineEventV2 = ZegoPKBattleUserOfflineEvent
ZegoPKBattleUserQuitEvent = ZegoLiveStreamingPKBattleUserQuitEvent
ZegoPKBattleUserQuitEventV2 = ZegoPKBattleUserQuitEvent
ZegoPKMixerDefaultLayout = ZegoLiveStreamingPKMixerDefaultLayout
ZegoPKMixerLayout = ZegoLiveStreamingPKMixerLayout
ZegoPKV2MixerLayout = ZegoLiveStreamingPKMixerLayout
ZegoPlayCoHostAudioVideoCallback = bool Function(ZegoUIKitUser localUser, ZegoLiveStreamingRole localRole, ZegoUIKitUser coHost)
ZegoPluginAdapterMessageHandler = dynamic Function(AppLifecycleState appLifecycleState)
ZegoPrebuiltAudioVideoViewConfig = ZegoLiveStreamingAudioVideoViewConfig
ZegoPresetResolution = ZegoVideoConfigPreset
ZegoRebuildFactor = bool Function(MediaQueryData old, MediaQueryData data)
ZegoScreenUtilInitBuilder = Widget Function(BuildContext context, Widget? child)
ZegoSignalingPluginZPNsThroughMessageHandler = void Function(ZPNsMessage message)
ZegoStartLiveButtonBuilder = ZegoLiveStreamingStartLiveButtonBuilder
ZegoTopMenuBarConfig = ZegoLiveStreamingTopMenuBarConfig
ZegoTranslationText = ZegoInnerText
ZegoUIKitPrebuiltLiveStreamingAudienceEvents = ZegoLiveStreamingCoHostAudienceEvents
ZegoUIKitPrebuiltLiveStreamingHostEvents = ZegoLiveStreamingCoHostHostEvents
ZegoUIKitPrebuiltLiveStreamingPKUser = ZegoLiveStreamingPKUser
ZegoUIKitPrebuiltLiveStreamingPKV2Events = ZegoLiveStreamingPKEvents