ZegoUIKitPrebuiltLiveAudioRoom class 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.

Inheritance

Constructors

ZegoUIKitPrebuiltLiveAudioRoom({Key? key, required int appID, required String appSign, required String userID, required String userName, required String roomID, required ZegoUIKitPrebuiltLiveAudioRoomConfig config, ZegoUIKitPrebuiltLiveAudioRoomEvents? events})
const

Properties

appID → int
You can create a project and obtain an appID from the ZEGOCLOUD Admin Console.
final
appSign → String
You can create a project and obtain an appSign from the ZEGOCLOUD Admin Console.
final
config → ZegoUIKitPrebuiltLiveAudioRoomConfig
Initialize the configuration for the voice chat room.
final
events → ZegoUIKitPrebuiltLiveAudioRoomEvents?
Initialize the event for the voice chat room.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
roomID → String
The ID of the audio chat room. This ID serves as a unique identifier for the room, so you need to ensure its uniqueness. It can be any valid string. Users who enter the same roomID will be logged into the same room to chat or listen to others.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
userID → String
The ID of the currently logged-in user. It can be any valid string. Typically, you would use the ID from your own user system, such as Firebase.
final
userName → String
The name of the currently logged-in user. It can be any valid string. Typically, you would use the name from your own user system, such as Firebase.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ZegoUIKitPrebuiltLiveAudioRoom>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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