ZegoLiveStreamingMenuBarButtonName enum

This enum type is used in ZegoUIKitPrebuiltLiveStreamingConfig.bottomMenuBarConfig.

Please note that these buttons are not role-specific and can be added to anyone's toolbar. The Live Streaming SDK simply defaults to defining which buttons can be displayed on the corresponding role's toolbar.

For example, if you don't want co-hosts to control their own microphone, you can exclude the toggleMicrophoneButton from ZegoBottomMenuBarConfig.coHostButtons.

Inheritance

Constructors

ZegoLiveStreamingMenuBarButtonName()
const

Values

toggleCameraButton → const ZegoLiveStreamingMenuBarButtonName

Button for controlling the camera switch.

toggleMicrophoneButton → const ZegoLiveStreamingMenuBarButtonName

Button for controlling the microphone switch.

switchCameraButton → const ZegoLiveStreamingMenuBarButtonName

Button for switching between front and rear cameras.

switchAudioOutputButton → const ZegoLiveStreamingMenuBarButtonName
leaveButton → const ZegoLiveStreamingMenuBarButtonName
coHostControlButton → const ZegoLiveStreamingMenuBarButtonName
beautyEffectButton → const ZegoLiveStreamingMenuBarButtonName

Button for controlling the display or hiding of the beauty effect adjustment panel.

Typically, only the host and co-hosts will be open the camera, so this button is usually displayed on their toolbars.

soundEffectButton → const ZegoLiveStreamingMenuBarButtonName

Button for controlling the display or hiding of the sound effect adjustment panel.

Typically, only the host and co-hosts will be speaking, so this button is usually displayed on their toolbars.

enableChatButton → const ZegoLiveStreamingMenuBarButtonName

Button to disable/enable chat in the live streaming.

This will apply to everyone in the room except the host.

toggleScreenSharingButton → const ZegoLiveStreamingMenuBarButtonName

Button for toggling screen sharing.

chatButton → const ZegoLiveStreamingMenuBarButtonName

Button to open/hide the chat UI.

minimizingButton → const ZegoLiveStreamingMenuBarButtonName

Button for minimizing the current ZegoUIKitPrebuiltLiveStreaming widget within the app.

When clicked, the ZegoUIKitPrebuiltLiveStreaming widget will shrink into a small draggable widget within the app.

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

expanding → const ZegoLiveStreamingMenuBarButtonName

Used in toolbar layout, similar to the Expanded widget in Flutter.

It is used to expand the spacing between buttons. Please note that if you are using index with ZegoMenuBarExtendButton, this expanding also occupies a position.

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<ZegoLiveStreamingMenuBarButtonName>
A constant List of the values in this enum, in order of their declaration.