ZegoUIKitPrebuiltLiveAudioRoomConfig class

Configuration for initializing the Live Audio Room. This class is used as the config parameter for the constructor of ZegoUIKitPrebuiltLiveAudioRoom.

Available Extensions

Constructors

ZegoUIKitPrebuiltLiveAudioRoomConfig({bool turnOnMicrophoneWhenJoining = true, bool useSpeakerWhenJoining = true, ZegoLiveAudioRoomDialogInfo? confirmDialogInfo, bool rootNavigator = false, Widget? foreground, Widget? background, String? userAvatarUrl, Map<String, String> userInRoomAttributes = const {}, Map<String, String> advanceConfigs = const {}, ZegoUIKitPrebuiltLiveAudioRoomInnerText? translationText, ZegoLiveAudioRoomSeatConfig? seat, ZegoLiveAudioRoomTopMenuBarConfig? topMenuBar, ZegoLiveAudioRoomBottomMenuBarConfig? bottomMenuBar, ZegoLiveAudioRoomLayoutConfig? layout, ZegoLiveAudioRoomInRoomMessageConfig? message, ZegoLiveAudioRoomMemberListConfig? memberList, ZegoLiveAudioRoomAudioEffectConfig? effect, ZegoLiveAudioRoomLiveDurationConfig? duration, ZegoLiveAudioRoomMediaPlayerConfig? mediaPlayer, ZegoLiveAudioRoomBackgroundMediaConfig? backgroundMedia})
ZegoUIKitPrebuiltLiveAudioRoomConfig.audience()
Default initialization parameters for the audience. If a configuration item does not meet your expectations, you can directly override its value.
ZegoUIKitPrebuiltLiveAudioRoomConfig.host()
Default initialization parameters for the host. If a configuration item does not meet your expectations, you can directly override its value.

Properties

advanceConfigs ↔ Map<String, String>
Set advanced engine configuration, Used to enable advanced functions. For details, please consult ZEGO technical support.
getter/setter pair
audioEffect ↔ ZegoLiveAudioRoomAudioEffectConfig
You can use this to modify your voice and control reverb.
getter/setter pair
background ↔ Widget?
The background of the audio chat room.
getter/setter pair
backgroundMedia ↔ ZegoLiveAudioRoomBackgroundMediaConfig
the config of background music, the feature currently only works for the host
getter/setter pair
bottomMenuBar ↔ ZegoLiveAudioRoomBottomMenuBarConfig
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
confirmDialogInfo ↔ ZegoLiveAudioRoomDialogInfo?
Confirmation dialog information when leaving the audio chat room. If not set, clicking the exit button will directly exit the audio chat room. 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
duration ↔ ZegoLiveAudioRoomLiveDurationConfig
Live audio room timing configuration.
getter/setter pair
emptyAreaBuilder ↔ (Widget Function(BuildContext context)?)
The blank space between seat and bottomBar, which can be used to place custom widgets freely.
getter/setter pair
foreground ↔ Widget?
The foreground of the live audio room.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
innerText ↔ ZegoUIKitPrebuiltLiveAudioRoomInnerText
Configuration options for modifying all text content on the UI. All visible text content on the UI can be modified using this single property.
getter/setter pair
inRoomMessage ↔ ZegoLiveAudioRoomInRoomMessageConfig
Configuration options for the message list.
getter/setter pair
mediaPlayer ↔ ZegoLiveAudioRoomMediaPlayerConfig
the config of media player
getter/setter pair
memberList ↔ ZegoLiveAudioRoomMemberListConfig
Configuration related to the bottom member list, including displaying the member list, member list styles, and more.
getter/setter pair
role ↔ ZegoLiveAudioRoomRole
Specifies the initial role when joining the live audio room. The role change after joining is not constrained by this property.
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
seat ↔ ZegoLiveAudioRoomSeatConfig
Configuration for all seats.
getter/setter pair
topMenuBar ↔ ZegoLiveAudioRoomTopMenuBarConfig
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
turnOnMicrophoneWhenJoining ↔ bool
Whether to open the microphone when joining the audio chat room.
getter/setter pair
userAvatarUrl ↔ String?
Set the avatar URL for the current user.
getter/setter pair
userInRoomAttributes ↔ Map<String, String>
Set the attributes for the current user in the current joined audio room. userAvatarUrl actually uses this attribute and occupies a property with the key "avatar".
getter/setter pair
useSpeakerWhenJoining ↔ bool
Whether to use the speaker to play audio when joining the audio chat room. 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