ZegoLiveStreamingPKBattleConfig class
Used to configure the parameters related to PK battles
This class is used for the ZegoUIKitPrebuiltLiveStreamingConfig.pkBattle property.
- Available Extensions
Constructors
- ZegoLiveStreamingPKBattleConfig({int userReconnectingSecond = 5, int userDisconnectedSecond = 90, ZegoLiveStreamingPKMixerLayout? mixerLayout, Rect containerRect()?, double? topPadding, ZegoLiveStreamingPKBattleHostReconnectingBuilder? hostReconnectingBuilder, ZegoLiveStreamingPKBattleViewBuilder? foregroundBuilder, ZegoLiveStreamingPKBattleViewBuilder? topBuilder, ZegoLiveStreamingPKBattleViewBuilder? bottomBuilder, @Deprecated('Use topPadding instead$deprecatedTipsV330') double? pKBattleViewTopPadding, @Deprecated('Use foregroundBuilder instead$deprecatedTipsV330') ZegoLiveStreamingPKBattleViewBuilder? pkBattleViewForegroundBuilder, @Deprecated('Use topBuilder instead$deprecatedTipsV330') ZegoLiveStreamingPKBattleViewBuilder? pkBattleViewTopBuilder, @Deprecated('Use bottomBuilder instead$deprecatedTipsV330') ZegoLiveStreamingPKBattleViewBuilder? pkBattleViewBottomBuilder})
Properties
- bottomBuilder ↔ ZegoLiveStreamingPKBattleViewBuilder?
-
To add custom components on the bottom edge of the PKBattleView.
getter/setter pair
- containerRect ↔ (Rect Function()?)
-
view rect, default is full
getter/setter pair
- foregroundBuilder ↔ ZegoLiveStreamingPKBattleViewBuilder?
-
To overlay custom components on the PKBattleView.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- hostReconnectingBuilder ↔ ZegoLiveStreamingPKBattleHostReconnectingBuilder?
-
When the connected host gets offline due to exceptions, SDK defaults to show "Host is reconnecting".
To customize the content that displays when the connected host gets offline.
getter/setter pair
- mixerLayout ↔ ZegoLiveStreamingPKMixerLayout?
-
you can custom coordinates and modify the PK layout.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- topBuilder ↔ ZegoLiveStreamingPKBattleViewBuilder?
-
To add custom components on the top edge of the PKBattleView.
getter/setter pair
- topPadding ↔ double?
-
The distance that the top edge is inset from the top of the stack.
If containerRect is set, then topPadding will be invalid
getter/setter pair
- userDisconnectedSecond ↔ int
-
When a PK user loses connection for more than userDisconnectedSecond,
they will be automatically kicked out of the PK.
getter/setter pair
- userReconnectingSecond ↔ int
-
If the connection with a PK user is lost for a userReconnectingSecond period of time,
it will trigger hostReconnectingBuilder, which waits for the user to reconnect.
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