zego_uikit_prebuilt_live_audio_room library

Classes

AdvanceInvitationAcceptData
AdvanceInvitationRequestData
AdvanceInvitationUser
invitation user info in advance mode
AudioRoomMessageControllerImpl
Here are the APIs related to message.
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
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
ZegoLiveAudioRoomAudioEffectConfig
Configuration options for voice changer and reverberation effects. This class is used for the audioEffect property in ZegoUIKitPrebuiltLiveAudioRoomConfig.
ZegoLiveAudioRoomAudioVideoEvents
events about audio-video
ZegoLiveAudioRoomBackgroundMediaConfig
Live Audio Room background media configuration.
ZegoLiveAudioRoomBottomMenuBarConfig
Configuration options for the bottom menu bar (toolbar). You can set the properties of this class through the ZegoUIKitPrebuiltLiveAudioRoomConfig.bottomMenuBar attribute.
ZegoLiveAudioRoomControllerAudioVideoImpl
Here are the APIs related to audio video
ZegoLiveAudioRoomControllerMediaImpl
media series API
ZegoLiveAudioRoomControllerMinimizingImpl
Here are the APIs related to minimizing.
ZegoLiveAudioRoomControllerRoomImpl
Here are the APIs related to screen sharing.
ZegoLiveAudioRoomControllerSeatAudienceImpl
APIs of audience
ZegoLiveAudioRoomControllerSeatHostImpl
APIs of host
ZegoLiveAudioRoomControllerSeatImpl
Here are the APIs related to seat.
ZegoLiveAudioRoomControllerSeatMicrophoneMuteStateImpl
ZegoLiveAudioRoomControllerSeatSpeakerImpl
APIs of speaker
ZegoLiveAudioRoomControllerUserImpl
Here are the APIs related to screen sharing.
ZegoLiveAudioRoomDialogInfo
Dialog information. Used to control whether certain features display a dialog, such as whether to show a confirmation dialog before leaving the audio chat room. This class is used for setting some text in ZegoUIKitPrebuiltLiveAudioRoomInnerText and ZegoUIKitPrebuiltLiveAudioRoomConfig.confirmDialogInfo.
ZegoLiveAudioRoomDurationEvents
events about duration
ZegoLiveAudioRoomEndEvent
ZegoLiveAudioRoomInRoomMessageConfig
Control options for the bottom-left message list. This class is used for the ZegoUIKitPrebuiltLiveAudioRoomConfig.inRoomMessage.
ZegoLiveAudioRoomInRoomMessageEvents
events about in-room message
ZegoLiveAudioRoomLayoutConfig
Seat layout configuration options. This type is used for the ZegoUIKitPrebuiltLiveAudioRoomConfig.layoutConfig property.
ZegoLiveAudioRoomLayoutRowConfig
Configuration for each row in the seat layout. This type is used for the ZegoUIKitPrebuiltLiveAudioRoomConfig.layoutConfig.rowConfigs property.
ZegoLiveAudioRoomLeaveConfirmationEvent
ZegoLiveAudioRoomLiveDurationConfig
Live Audio Room timing configuration.
ZegoLiveAudioRoomMediaPlayerConfig
media player config
ZegoLiveAudioRoomMemberListConfig
Configuration for the member list.
ZegoLiveAudioRoomMemberListEvents
events about member list
ZegoLiveAudioRoomRoomEvents
events about room
ZegoLiveAudioRoomSeatAudienceEvents
events about seat's audience
ZegoLiveAudioRoomSeatConfig
Configuration options for controlling seat behavior and style. This type is used for the seat property in ZegoUIKitPrebuiltLiveAudioRoomConfig.
ZegoLiveAudioRoomSeatEvents
events about seats
ZegoLiveAudioRoomSeatHostEvents
events about seat's host
ZegoLiveAudioRoomTopMenuBarConfig
Configuration options for the top menu bar (toolbar).
ZegoLiveAudioRoomUserEvents
events about user
ZegoLiveStreamingControllerAudioVideoAudioOutputImpl
ZegoLiveStreamingControllerAudioVideoCameraImpl
ZegoLiveStreamingControllerAudioVideoMicrophoneImpl
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:
ZegoUIKitPrebuiltLiveAudioRoom APIs Events Configs Migration_v3.x
Live Audio Room Widget. You can embed this widget into any page of your project to integrate the functionality of a audio chat room. You can refer to our documentation, or our sample code.
ZegoUIKitPrebuiltLiveAudioRoomConfig
Configuration for initializing the Live Audio Room. This class is used as the config parameter for the constructor of ZegoUIKitPrebuiltLiveAudioRoom.
ZegoUIKitPrebuiltLiveAudioRoomController
Used to control the audio chat room functionality.
ZegoUIKitPrebuiltLiveAudioRoomEvents
You can listen to events that you are interested in here, such as Co-hosting
ZegoUIKitPrebuiltLiveAudioRoomInnerText
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.
ZegoUIKitPrebuiltLiveAudioRoomMiniOverlayPage
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
ZegoLiveAudioRoomEndReason
The default behavior is to return to the previous page.
ZegoLiveAudioRoomLayoutAlignment
The alignment of the seat layout. This enum type is used for the alignment property in ZegoLiveAudioRoomLayoutRowConfig.
ZegoLiveAudioRoomMenuBarButtonName
These are the predefined buttons that can be added to the top or bottom toolbar.
ZegoLiveAudioRoomMiniOverlayPageState
page state of current minimize page
ZegoLiveAudioRoomRole
User roles in the live audio room. This enum type is used for the role property in ZegoUIKitPrebuiltLiveAudioRoomConfig.
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

deprecatedTips → const String
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

LiveAudioRoomMiniOverlayPageState = ZegoLiveAudioRoomMiniOverlayPageState
MediaInfo = ZegoUIKitMediaInfo
MediaPlayResult = ZegoUIKitMediaPlayResult
MediaPlayState = ZegoUIKitMediaPlayState
MediaSeekToResult = ZegoUIKitMediaSeekToResult
MediaType = ZegoUIKitMediaType
ZegoAudioEffectConfig = ZegoLiveAudioRoomAudioEffectConfig
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.
ZegoBackgroundMediaConfig = ZegoLiveAudioRoomBackgroundMediaConfig
ZegoBottomMenuBarConfig = ZegoLiveAudioRoomBottomMenuBarConfig
ZegoDialogInfo = ZegoLiveAudioRoomDialogInfo
ZegoFontSizeResolver = double Function(num fontSize, ZegoScreenUtil instance)
ZegoInnerText = ZegoUIKitPrebuiltLiveAudioRoomInnerText
ZegoInRoomMessageConfig = ZegoLiveAudioRoomInRoomMessageConfig
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)
ZegoLiveAudioRoomController = ZegoUIKitPrebuiltLiveAudioRoomController
ZegoLiveDurationConfig = ZegoLiveAudioRoomLiveDurationConfig
ZegoMediaPlayerConfig = ZegoLiveAudioRoomMediaPlayerConfig
ZegoMemberListConfig = ZegoLiveAudioRoomMemberListConfig
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 = ZegoLiveAudioRoomMenuBarButtonName
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)
ZegoTopMenuBarConfig = ZegoLiveAudioRoomTopMenuBarConfig