TUILiveBattleManager

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveBattleManager @ TUIKitEngine
Live stream Battle relevant APIs

TUILiveBattleManager

TUILiveBattleObserver

Function List
Description
Notification received for the start of Battle
Notification received for the end of Battle
Notification received for user joined Battle
Notification received for user logout from Battle
Notification received for user's Battle score update
Callee receives the Battle invitation notification
Callee receives the Battle cancellation notification
Notification received for Battle processing timeout
Caller receives callee's agreement notification
Caller receives callee's rejection notification

TUILiveBattleManager

Function List
Description
Add event callback
Remove event callback
Initiate a Battle request
Cancel a Battle request
Accept a Battle request
Deny a Battle request
Logout of Battle

Structure Data Type

Function List
Description
Battle user information
Battle Configuration
Battle info
Battle request result

Enumeration Types

Enumeration Types
Description
Battle invitation status
The causes for the end of Battle

onBattleStarted

Notification received for the start of Battle
OnBattleStarted onBattleStarted = (TUIBattleInfo battleInfo) {};
Parameter
Description
battleInfo
Battle info.

onBattleEnded

Notification received for the end of Battle
OnBattleEnded onBattleEnded = (TUIBattleInfo battleInfo, TUIBattleStoppedReason reason) {};
Parameter
Description
battleInfo
Battle info.
reason
The causes for the end of Battle.

onUserJoinBattle

Notification received for user joined Battle
OnUserJoinBattle onUserJoinBattle = (String battleId, TUIBattleUser battleUser) {};
Parameter
Description
battleId
Battle ID.
battleUser
Battle user information.

onUserExitBattle

Notification received for user logout from Battle
OnUserExitBattle onUserExitBattle = (String battleId, TUIBattleUser battleUser) {};
Parameter
Description
battleId
Battle ID.
battleUser
Battle user information.

onBattleScoreChanged

Notification received for user's Battle score update
OnBattleScoreChanged onBattleScoreChanged = (String battleId, List<TUIBattleUser> battleUserList) {};
Parameter
Description
battleId
Battle ID.
battleUserList
Battle user information.

onBattleRequestReceived

Callee receives the Battle invitation notification
OnBattleRequestReceived onBattleRequestReceived =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
Parameter
Description
battleInfo
Battle info.
inviter
User information that initiates an invitation.
invitee
User information that receives an invitation.

onBattleRequestCancelled

Callee receives the Battle cancellation notification
OnBattleRequestCancelled onBattleRequestCancelled =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
Parameter
Description
battleInfo
Battle info.
inviter
User information that initiates an invitation.
invitee
User information that receives an invitation.

onBattleRequestTimeout

Notification received for Battle processing timeout
OnBattleRequestTimeout onBattleRequestTimeout =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
Parameter
Description
battleInfo
Battle info.
inviter
User information that initiates an invitation.
invitee
User information that receives an invitation.

onBattleRequestAccept

Caller receives callee's agreement notification
OnBattleRequestAccept onBattleRequestAccept =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
Parameter
Description
battleInfo
Battle info.
inviter
User information that initiates an invitation.
invitee
User information that receives an invitation.

onBattleRequestReject

Caller receives callee's rejection notification
OnBattleRequestReject onBattleRequestAccept =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
Parameter
Description
battleInfo
Battle info.
inviter
User information that initiates an invitation.
invitee
User information that receives an invitation.

addObserver

Add event callback
void addObserver(TUILiveBattleObserver observer);
Parameter
Description
observer
The instances being listened to.

removeObserver

Remove event callback
void removeObserver(TUILiveBattleObserver observer);
Parameter
Description
observer
The instances being listened to.

requestBattle:userIdList

Initiate a Battle request
Future<TUIValueCallBack<TUIBattleRequestResult>> requestBattle
(TUIBattleConfig config,
List<String> userIdList,
int timeout);
Parameter
Description
config
Battle Configuration Information.
userIdList
User ID List to be invited.
timeout
Timeout Time

cancelBattleRequest

Cancel a Battle request
Future<TUIActionCallback> cancelBattleRequest(String battleId, List<String> userIdList);
Parameter
Description
battleId
Battle ID.
userIdList
User ID List to be cancelled.

acceptBattle

Accept a Battle request
Future<TUIActionCallback> acceptBattle(String battleId);
Parameter
Description
battleId
Battle ID.

rejectBattle

Deny a Battle request
Future<TUIActionCallback> rejectBattle(String battleId);
Parameter
Description
battleId
Battle ID.

exitBattle

Logout of Battle
Future<TUIActionCallback> exitBattle(String battleId);
Parameter
Description
battleId
Battle ID.

TUIBattleUser

Battle user information
Enumeration Types
Description
roomId
Battle room ID.
userId
Battle user ID.
userName
Battle user nickname.
avatarUrl
Battle user avatar address.
score
Battle score.

TUIBattleConfig

<Battle Configuration>
Enumeration Types
Description
duration
Maximum duration of Battle (unit: seconds).
needResponse
Whether the invited user needs to reply with consent or refusal.
extensionInfo
Extended information of Battle.

TUIBattleInfo

Battle info
Enumeration Types
Description
battleId
Battle ID.
config
Battle Configuration.
inviter
Battle initiator.
inviteeList
Invite Battle members.
startTime
Mark the start time stamp of Battle (unit: seconds).
endTime
Mark the end time stamp of Battle (unit: seconds).

TUIBattleRequestResult

Enumeration Types
Description
battleInfo
Battle info.
requestMap
Battle request result

TUIBattleCode

<Battle Invitation Status>
Error Example
Value
Description
unknown
-1
Default status.
success
0
Battle request sent successfully.
roomNotExists
1
The invited room does not exist.
battling
2
The invited room is already in the Battle.
battlingOtherRoom
3
The invited room is already in a Battle with another room.
roomExit
4
The room has exited.
retry
5
Internal error, recommend retry once.

TUIBattleStoppedReason

The causes for the end of Battle
Error Example
Value
Description
timeOver
0
Battle reaches the maximum duration and ends due to overtime.
otherExit
1
Other users in Battle have all logged out.