ZegoUIKitPrebuiltVideoConferenceConfig class

Configuration for initializing the Video Conference This class is used as the config parameter for the constructor of ZegoUIKitPrebuiltVideoConference.

Constructors

ZegoUIKitPrebuiltVideoConferenceConfig({bool turnOnCameraWhenJoining = true, bool turnOnMicrophoneWhenJoining = true, bool useSpeakerWhenJoining = true, bool rootNavigator = false, ZegoAvatarBuilder? avatarBuilder, Widget? foreground, Widget? background, ZegoLeaveConfirmDialogInfo? leaveConfirmDialogInfo, dynamic onError(ZegoUIKitError)?, Future<bool?> onLeaveConfirmation(BuildContext context)?, VoidCallback? onLeave, Future<void> onMeRemovedFromRoom(String)?, Future<bool> onCameraTurnOnByOthersConfirmation(BuildContext context)?, Future<bool> onMicrophoneTurnOnByOthersConfirmation(BuildContext context)?, ZegoPrebuiltAudioVideoViewConfig? audioVideoViewConfig, ZegoTopMenuBarConfig? topMenuBarConfig, ZegoBottomMenuBarConfig? bottomMenuBarConfig, ZegoMemberListConfig? memberListConfig, ZegoInRoomNotificationViewConfig? notificationViewConfig, ZegoInRoomChatViewConfig? chatViewConfig})

Properties

audioVideoViewConfig ↔ ZegoPrebuiltAudioVideoViewConfig
Configuration options for audio/video views.
getter/setter pair
avatarBuilder ↔ ZegoAvatarBuilder?
Use this to customize the avatar, and replace the default avatar with it.
getter/setter pair
background ↔ Widget?
The background of the video conference.
getter/setter pair
bottomMenuBarConfig ↔ ZegoBottomMenuBarConfig
Configuration options for the bottom menu bar (toolbar). You can use these options to customize the appearance and behavior of the bottom menu bar.
getter/setter pair
chatViewConfig ↔ ZegoInRoomChatViewConfig
Configuration related to the bottom-left message list.
getter/setter pair
foreground ↔ Widget?
The foreground of the video conference.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
layout ↔ ZegoLayout?
Layout-related configuration. You can choose your layout here.
getter/setter pair
leaveConfirmDialogInfo ↔ ZegoLeaveConfirmDialogInfo?
Confirmation dialog information when leaving the video conference. If not set, clicking the exit button will directly exit the video conference. If set, a confirmation dialog will be displayed when clicking the exit button, and you will need to confirm the exit before actually exiting.
getter/setter pair
memberListConfig ↔ ZegoMemberListConfig
Configuration related to the bottom member list, including displaying the member list, member list styles, and more.
getter/setter pair
notificationViewConfig ↔ ZegoInRoomNotificationViewConfig
Configuration related to the notification message list.
getter/setter pair
onCameraTurnOnByOthersConfirmation ↔ (Future<bool> Function(BuildContext context)?)
This callback method is called when someone requests to open your camera.
getter/setter pair
onError ↔ (dynamic Function(ZegoUIKitError)?)
error stream
getter/setter pair
onLeave ↔ VoidCallback?
This callback is triggered after leaving the vide conference. You can perform business-related prompts or other actions in this callback. The default behavior is to return to the previous page. If you override this callback, you must perform the page navigation yourself, otherwise the user will remain on the conference page.
getter/setter pair
onLeaveConfirmation ↔ (Future<bool?> Function(BuildContext context)?)
Confirmation callback method before leaving the video conference.
getter/setter pair
onMeRemovedFromRoom ↔ (Future<void> Function(String)?)
This callback is triggered when local user removed from video conference
getter/setter pair
onMicrophoneTurnOnByOthersConfirmation ↔ (Future<bool> Function(BuildContext context)?)
This callback method is called when someone requests to open your microphone.
getter/setter pair
rootNavigator ↔ bool
same as Flutter's Navigator's param If rootNavigator is set to true, the state from the furthest instance of this class is given instead. Useful for pushing contents above all subsequent instances of Navigator.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
topMenuBarConfig ↔ ZegoTopMenuBarConfig
Configuration options for the top menu bar (toolbar). You can use these options to customize the appearance and behavior of the top menu bar.
getter/setter pair
turnOnCameraWhenJoining ↔ bool
Whether to open the camera when joining the video conference.
getter/setter pair
turnOnMicrophoneWhenJoining ↔ bool
Whether to open the microphone when joining the video conference.
getter/setter pair
useSpeakerWhenJoining ↔ bool
Whether to use the speaker to play audio when joining the video conference. The default value is true. If this value is set to false, the system's default playback device, such as the earpiece or Bluetooth headset, will be used for audio playback.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited