ZegoLiveAudioRoomMenuBarButtonName enum

These are the predefined buttons that can be added to the top or bottom toolbar.

This enum type is used in ZegoUIKitPrebuiltLiveAudioRoomConfig.bottomMenuBar and ZegoUIKitPrebuiltLiveAudioRoomConfig.topMenuBar. Please note that these buttons are not role-specific and can be added to anyone's toolbar. The Live Audio Room SDK simply defaults to defining which buttons can be displayed on the corresponding role's toolbar.

For example, if you don't want the speaker on the seat to be able to turn off their microphone, you can exclude the toggleMicrophoneButton from ZegoLiveAudioRoomBottomMenuBarConfig.speakerButtons. For example, if your business scenario allows audiences to view the member list or you don't want audiences to view the member list, and so on. For example, if your business scenario only allows the host to invite audiences to the seat and doesn't allow audiences to apply as speakers, you can exclude the applyToTakeSeatButton from ZegoLiveAudioRoomBottomMenuBarConfig.audienceButtons.

Inheritance

Constructors

ZegoLiveAudioRoomMenuBarButtonName()
const

Values

leaveButton → const ZegoLiveAudioRoomMenuBarButtonName

Button for leaving the audio chat room. You can proactively add a leave button to the bottom or top toolbar to optimize the interaction experience based on your business needs.

toggleMicrophoneButton → const ZegoLiveAudioRoomMenuBarButtonName

Button for controlling the microphone switch.

showMemberListButton → const ZegoLiveAudioRoomMenuBarButtonName

Button for controlling the visibility of the member list.

soundEffectButton → const ZegoLiveAudioRoomMenuBarButtonName

Button for controlling the display or hiding of the sound effect adjustment panel. Typically, only the host and speakers will be speaking, so this button is usually displayed on their toolbars.

applyToTakeSeatButton → const ZegoLiveAudioRoomMenuBarButtonName

Button for audience members to apply for a seat and join others in a voice chat. Typically placed on the audience toolbar.

minimizingButton → const ZegoLiveAudioRoomMenuBarButtonName

Button for minimizing the current ZegoUIKitPrebuiltLiveAudioRoom widget within the app. When clicked, the ZegoUIKitPrebuiltLiveAudioRoom widget will shrink into a small draggable widget within the app.

If you need to nest some widgets in ZegoUIKitPrebuiltLiveAudioRoom, please use foreground nesting, otherwise these widgets will be lost when you minimize and restore the ZegoUIKitPrebuiltLiveAudioRoom

closeSeatButton → const ZegoLiveAudioRoomMenuBarButtonName

Button for toggling the seat availability. When the seat is open, all audience members can freely choose an empty seat to join and start chatting with others. If the seat is closed, audience members need to request permission from the host or be invited by the host to occupy a seat.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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

Constants

values → const List<ZegoLiveAudioRoomMenuBarButtonName>
A constant List of the values in this enum, in order of their declaration.