zego_uikit_prebuilt_live_streaming 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
LiveStreamingControllerSwipingImpl
Here are the APIs related to screen sharing.
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
ZegoBottomMenuBarButtonStyle
Button style for the bottom toolbar, allowing customization of button icons or text.
ZegoBottomMenuBarConfig
Configuration options for the bottom menu bar (toolbar).
ZegoCameraStateIcon
monitor the camera status changes, when the status changes, the corresponding icon is automatically switched
ZegoDialogInfo
Dialog information. Used to control whether certain features display a dialog, such as whether to show a confirmation dialog when request camera permission.
ZegoDraggableBottomSheet
Partially visible bottom sheet that can be dragged into the screen. Provides different views for expanded and collapsed states
ZegoEffectConfig
Configuration options for voice changer, beauty effects and reverberation effects.
ZegoFontSizeResolvers
ZegoIncomingPKBattleRequestCancelledEvent
ZegoIncomingPKBattleRequestCancelledEventV2
ZegoIncomingPKBattleRequestReceivedEventV2
ZegoIncomingPKBattleRequestUserV2
ZegoInnerText
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.
ZegoInputBoardWrapper
ZegoInRoomChatView
ZegoInRoomCommandReceivedData
ZegoInRoomMessage
in-room message
ZegoInRoomMessageConfig
Control options for the bottom-left message list.
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
ZegoLiveDurationConfig
Live Streaming timing configuration.
ZegoLiveStreamingConnectController
Here are the APIs related to connect.
ZegoLiveStreamingConnectInviteController
Here are the APIs related to inviting co-hosts to connect.
ZegoLiveStreamingMessageController
Here are the APIs related to message.
ZegoLiveStreamingMinimizingController
Here are the APIs related to screen sharing.
ZegoLiveStreamingPKBattleConfig
Used to configure the parameters related to PK battles
ZegoLiveStreamingPKBattleEvents
ZegoLiveStreamingPKBattleStreamCreator
ZegoLiveStreamingPKBattleV2Config
Used to configure the parameters related to PK battles
ZegoLiveStreamingPKControllerV2
Here are the APIs related to PK.
ZegoLiveStreamingPKV2View
ZegoLiveStreamingPKV2ViewState
ZegoLiveStreamingPreviewConfig
Used to configure the parameters related to the preview of the live streaming.
ZegoLiveStreamingScreenController
Here are the APIs related to screen sharing.
ZegoLiveStreamingSwipingConfig
Live Streaming swiping configuration.
ZegoMediaPlayerConfig
media player config
ZegoMemberButtonConfig
Configuration for the member button of top bar.
ZegoMemberList
ZegoMemberListConfig
Configuration for the member list.
ZegoMenuBarExtendButton
Extension buttons for the bottom toolbar.
ZegoMicrophoneStateIcon
monitor the microphone status changes, when the status changes, the corresponding icon is automatically switched
ZegoMoreButton
more button of menu bar
ZegoPKV2MixerLayout
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 ZegoPKV2PreferGridMixerLayout or ZegoPKV2GridMixerLayout.
ZegoPrebuiltAudioVideoViewConfig
Configuration options for audio/video views.
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
ZegoTopMenuBarConfig
Configuration options for the top menu bar (toolbar).
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:
ZegoUIKitPrebuiltLiveStreaming
Live Streaming Widget.
ZegoUIKitPrebuiltLiveStreamingAudienceEvents
Audience Related Events
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
ZegoUIKitPrebuiltLiveStreamingHostEvents
Host Related Events
ZegoUIKitPrebuiltLiveStreamingPKService
ZegoUIKitPrebuiltLiveStreamingPKUser
ZegoUIKitPrebuiltLiveStreamingPKV2
ZegoUIKitPrebuiltLiveStreamingPKV2Events
pk(version 2) related events
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
ZegoLiveStreamingPKBattleState
ZegoLiveStreamingPKBattleStateV2
ZegoLiveStreamingRole
Live streaming roles.
ZegoLiveStreamingState
Live streaming state
ZegoMenuBarButtonName
This enum type is used in ZegoUIKitPrebuiltLiveStreamingConfig.bottomMenuBarConfig.
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.
roomPropKeyHost → const String
roomPropKeyPKUsers → const String
roomPropKeyRequestID → const String
turnCameraOffInRoomCommandKey → const String
turnCameraOnInRoomCommandKey → const String
turnMicrophoneOffInRoomCommandKey → const String
turnMicrophoneOnInRoomCommandKey → const String
userIDCommandKey → const String
zegoPK2MixerCanvasHeight → const double
height of mixer canvas
zegoPK2MixerCanvasWidth → const double
width of mixer canvas

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.
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.
ZegoInRoomMessageViewConfig = ZegoInRoomMessageConfig
ZegoInRoomMessageViewItemPressEvent = void Function(ZegoInRoomMessage message)
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.
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.
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)
ZegoPKV2MixerDefaultLayout = ZegoPKV2PreferGridMixerLayout
ZegoPlayCoHostAudioVideoCallback = bool Function(ZegoUIKitUser localUser, ZegoLiveStreamingRole localRole, ZegoUIKitUser coHost)
ZegoPluginAdapterMessageHandler = dynamic Function(AppLifecycleState appLifecycleState)
ZegoPrebuiltVideoConfig = ZegoUIKitVideoConfig
ZegoPresetResolution = ZegoVideoConfigPreset
ZegoRebuildFactor = bool Function(MediaQueryData old, MediaQueryData data)
ZegoScreenUtilInitBuilder = Widget Function(BuildContext context, Widget? child)
ZegoSignalingPluginZPNsThroughMessageHandler = void Function(ZPNsMessage message)
ZegoStartLiveButtonBuilder = 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.
ZegoUIKitPrebuiltLiveStreamingService = ZegoUIKitPrebuiltLiveStreamingPKService