类型定义
类型 | 含义 |
连线时的布局模式 | |
连线用户数据 | |
PK 用户视图位置数据 | |
PK 请求结果回调 | |
连麦时的视图挂件 widget 构造器 | |
连线时的视图挂件 widget 构造器 | |
PK 时对应主播视频上面的视图挂件 widget 构造器 | |
PK 时全屏的视图挂件 widget 构造器 | |
自定义视图挂件 widget 构造器 | |
连麦的用户列表发生改变的回调 | |
收到连麦请求的回调 | |
收到取消连麦请求的回调 | |
连麦请求被同意的回调 | |
连麦请求被拒绝的回调 | |
连麦请求超时的回调 | |
主播断开和此观众连麦的回调 | |
观众主动断开连线的回调 | |
跨房连线的房间列表发生改变回调 | |
收到跨房连线请求的回调 | |
收到取消跨房连线请求的回调 | |
收到同意跨房连线的回调 | |
收到拒绝跨房连线的回调 | |
收到跨房连线超时的回调 | |
收到断开跨房连线的回调 | |
收到 PK 开始的回调 | |
收到 PK 结束的回调 | |
收到有人加入 PK 结束的回调 | |
收到有人离开 PK 结束的回调 | |
收到 PK 比分发生变化的回调 | |
收到 PK 请求的回调 | |
收到取消 PK 请求的回调 | |
收到 PK 请求超时的回调 | |
收到同意 PK 请求的回调 | |
收到拒绝 PK 请求的回调 | |
收到房间销毁的回调 |
LayoutMode
麦位列表的布局模式
枚举值 | 含义 |
focus | 聚焦布局 |
grid | 宫格布局 |
vertical | 纵向布局 |
free | 自定义布局 |
CoHostUser
连线用户数据
属性 | 类型 | 描述 |
connectionUser | 连线用户个人信息 | |
hasAudioStream | bool | 连线用户音频流信息 |
hasVideoStream | bool | 连线用户视频流信息 |
BattleUserWidgetModel
属性 | 类型 | 描述 |
battleUser | PK 用户个人信息 | |
rect | Rect | PK 用户视图位置信息 |
BattleRequestCallback
PK 请求结果回调
属性 | 类型 | 描述 |
battleId | String | PK 唯一标识符 |
requestedUserList | PK 邀请用户列表 | |
onError | PK 邀请错误结果 |
CoGuestWidgetBuilder
连麦时的视图挂件
widget 构造器typedef CoGuestWidgetBuilder = Widget Function(BuildContext context,TUIUserInfo userInfo);
参数：
参数 | 类型 | 含义 |
context | BuildContext | 上下文 |
userInfo | 连麦者用户信息 |
CoHostWidgetBuilder
连麦时的视图挂件
widget 构造器typedef CoHostWidgetBuilder = Widget Function(BuildContext context,CoHostUser userInfo);
参数：
参数 | 类型 | 含义 |
context | BuildContext | 上下文 |
userInfo | 连线用户数据 |
BattleWidgetBuilder
PK时对应主播视频上面的视图挂件
widget 构造器typedef BattleWidgetBuilder = Widget Function(BuildContext context,TUIBattleUser userInfo);
参数：
参数 | 类型 | 含义 |
context | BuildContext | 上下文 |
userInfo | 参与 PK 的用户信息 |
BattleContainerWidgetBuilder
PK 时全屏的视图挂件
widget 构造器typedef BattleContainerWidgetBuilder = Widget Function(BuildContext context,List<BattleUserWidgetModel> battleModels);
参数：
参数 | 类型 | 含义 |
context | BuildContext | 上下文 |
battleModels | PK 中用户的视图位置布局信息 |
VideoWidgetBuilder
自定义视图挂件 widget 构造器
typedef OnSeatWidgetTap = void Function(TUISeatInfo seatInfo);
参数：
参数 | 类型 | 含义 |
seatInfo | 麦位信息 |
OnConnectedUsersUpdated
连麦的用户列表发生改变的回调
typedef OnConnectedUsersUpdated = void Function(List<TUIUserInfo> userList,List<TUIUserInfo> joinList,List<TUIUserInfo> leaveList);
参数：
参数 | 类型 | 含义 |
userList | 连麦用户列表 | |
joinList | 加入连麦的用户列表 | |
leaveList | 离开连麦的用户列表 |
OnUserConnectionRequest
收到连麦请求的回调
typedef OnUserConnectionRequest = void Function(TUIUserInfo inviterUser);
参数：
参数 | 类型 | 含义 |
inviterUser | 连麦用户信息 |
OnUserConnectionCancelled
收到取消连麦请求的回调
typedef OnUserConnectionCancelled = void Function(TUIUserInfo inviterUser);
参数：
参数 | 类型 | 含义 |
inviterUser | 连麦用户信息 |
OnUserConnectionAccepted
连麦请求被同意的回调
typedef OnUserConnectionAccepted = void Function(TUIUserInfo userInfo);
参数：
参数 | 类型 | 含义 |
userInfo | 连麦用户信息 |
OnUserConnectionRejected
连麦请求被拒绝的回调
typedef OnUserConnectionRejected = void Function(TUIUserInfo userInfo);
参数：
参数 | 类型 | 含义 |
userInfo | 连麦用户信息 |
OnUserConnectionTimeout
连麦请求超时的回调
typedef OnUserConnectionTimeout = void Function(TUIUserInfo userInfo);
参数：
参数 | 类型 | 含义 |
userInfo | 连麦用户信息 |
OnUserConnectionTerminated
主播断开和此观众连麦的回调
typedef OnUserConnectionRejected = void Function();
OnUserConnectionExited
观众主动断开连线的回调
typedef OnUserConnectionExited = void Function(TUIUserInfo userInfo);
参数：
参数 | 类型 | 含义 |
userInfo | 连麦用户信息 |
OnConnectedRoomsUpdated
跨房连线的房间列表发生改变回调
typedef OnConnectedRoomsUpdated = void Function(List<TUIConnectionUser> hostUserList);
参数：
参数 | 类型 | 含义 |
hostUserList | 连线用户列表 |
OnCrossRoomConnectionRequest
收到跨房连线请求的回调
typedef OnCrossRoomConnectionRequest = void Function(TUIConnectionUser hostUser);
参数：
参数 | 类型 | 含义 |
hostUser | 连线用户 |
OnCrossRoomConnectionCancelled
收到取消跨房连线请求的回调
typedef OnCrossRoomConnectionCancelled = void Function(TUIConnectionUser hostUser);
参数：
参数 | 类型 | 含义 |
hostUser | 连线用户 |
OnCrossRoomConnectionAccepted
收到同意跨房连线的回调
typedef OnCrossRoomConnectionAccepted = void Function(TUIConnectionUser hostUser);
参数：
参数 | 类型 | 含义 |
hostUser | 连线用户 |
OnCrossRoomConnectionRejected
收到拒绝跨房连线的回调
typedef OnCrossRoomConnectionRejected = void Function(TUIConnectionUser hostUser);
参数：
参数 | 类型 | 含义 |
hostUser | 连线用户 |
OnCrossRoomConnectionTimeout
收到跨房连线超时的回调
typedef OnCrossRoomConnectionTimeout = void Function(TUIConnectionUser inviter,TUIConnectionUser invitee);
参数：
参数 | 类型 | 含义 |
inviter | 连线请求发起方 | |
invitee | 连线请求受邀方 |
OnCrossRoomConnectionExited
收到断开跨房连线的回调
typedef OnCrossRoomConnectionExited = void Function(TUIConnectionUser hostUser);
参数：
参数 | 类型 | 含义 |
hostUser | 连线用户 |
OnBattleStarted
收到 PK 开始的回调
typedef OnBattleStarted = void Function(TUIBattleInfo battleInfo);
参数：
参数 | 类型 | 含义 |
battleInfo | PK 信息 |
OnBattleEnded
收到 PK 结束的回调
typedef OnBattleEnded = void Function(TUIBattleInfo battleInfo);
参数：
参数 | 类型 | 含义 |
battleInfo | PK 信息 |
OnUserJoinBattle
收到有人加入 PK 结束的回调
typedef OnUserJoinBattle = void Function(String battleId,TUIBattleUser battleUser);
参数：
参数 | 类型 | 含义 |
battleId | String | PK 唯一标识符 |
battleUser | PK 用户 |
OnUserExitBattle
收到有人离开 PK 结束的回调
typedef OnUserExitBattle = void Function(String battleId,TUIBattleUser battleUser);
参数：
参数 | 类型 | 含义 |
battleId | String | PK 唯一标识符 |
battleUser | PK 用户 |
OnBattleScoreChanged
收到 PK 比分发生变化的回调
typedef OnBattleScoreChanged = void Function(String battleId,List<TUIBattleUser> battleUserList);
参数：
参数 | 类型 | 含义 |
battleId | String | PK 唯一标识符 |
battleUserList | PK 用户列表 |
OnBattleRequestReceived
收到 PK 请求的回调
typedef OnBattleRequestReceived = void Function(String battleId,TUIBattleUser inviter,TUIBattleUser invitee);
参数：
参数 | 类型 | 含义 |
battleId | String | PK 唯一标识符 |
inviter | PK 邀请发起方 | |
invitee | PK 邀请受邀方 |
OnBattleRequestCancelled
收到取消 PK 请求的回调
typedef OnBattleRequestCancelled = void Function(String battleId,TUIBattleUser inviter,TUIBattleUser invitee);
参数：
参数 | 类型 | 含义 |
battleId | String | PK 唯一标识符 |
inviter | PK 邀请发起方 | |
invitee | PK 邀请受邀方 |
OnBattleRequestTimeout
收到 PK 请求超时的回调
typedef OnBattleRequestTimeout = void Function(String battleId,TUIBattleUser inviter,TUIBattleUser invitee);
参数：
参数 | 类型 | 含义 |
battleId | String | PK 唯一标识符 |
inviter | PK 邀请发起方 | |
invitee | PK 邀请受邀方 |
OnBattleRequestAccept
收到同意 PK 请求的回调
typedef OnBattleRequestAccept = void Function(String battleId,TUIBattleUser inviter,TUIBattleUser invitee);
参数：
参数 | 类型 | 含义 |
battleId | String | PK 唯一标识符 |
inviter | PK 邀请发起方 | |
invitee | PK 邀请受邀方 |
OnBattleRequestReject
收到拒绝 PK 请求的回调
typedef OnBattleRequestReject = void Function(String battleId,TUIBattleUser inviter,TUIBattleUser invitee);
参数：
参数 | 类型 | 含义 |
battleId | String | PK 唯一标识符 |
inviter | PK 邀请发起方 | |
invitee | PK 邀请受邀方 |
OnRoomDismissed
收到房间销毁的回调
typedef OnRoomDismissed = void Function(String roomId);
参数：
参数 | 类型 | 含义 |
roomId | String | 房间 Id |
ConnectionObserver 事件定义
事件列表 | 类型 | 含义 |
onConnectedUsersUpdated | 连麦的用户列表发生改变的回调 | |
onUserConnectionRequest | 收到连麦请求的回调 | |
onUserConnectionCancelled | 收到取消连麦请求的回调 | |
onUserConnectionAccepted | 连麦请求被同意的回调 | |
onUserConnectionRejected | 连麦请求被拒绝的回调 | |
onUserConnectionTimeout | 连麦请求超时的回调 | |
onUserConnectionTerminated | 主播断开和此观众连麦的回调 | |
onUserConnectionExited | 观众主动断开连线的回调 | |
onConnectedRoomsUpdated | 跨房连线的房间列表发生改变回调 | |
onCrossRoomConnectionRequest | 收到跨房连线请求的回调 | |
onCrossRoomConnectionCancelled | 收到取消跨房连线请求的回调 | |
onCrossRoomConnectionAccepted | 收到同意跨房连线的回调 | |
onCrossRoomConnectionRejected | 收到拒绝跨房连线的回调 | |
onCrossRoomConnectionTimeout | 收到跨房连线超时的回调 | |
onCrossRoomConnectionExited | 收到断开跨房连线的回调 | |
onRoomDismissed | 收到房间销毁的回调 |
BattleObserver 事件定义
事件列表 | 类型 | 含义 |
onBattleStarted | 收到 PK 开始的回调 | |
onBattleEnded | 收到 PK 结束的回调 | |
onUserJoinBattle | 收到有人加入 PK 结束的回调 | |
onUserExitBattle | 收到有人离开 PK 结束的回调 | |
onBattleScoreChanged | 收到 PK 比分发生变化的回调 | |
onBattleRequestReceived | 收到 PK 请求的回调 | |
onBattleRequestCancelled | 收到取消 PK 请求的回调 | |
onBattleRequestTimeout | 收到 PK 请求超时的回调 | |
onBattleRequestAccept | 收到同意 PK 请求的回调 | |
onBattleRequestReject | 收到拒绝 PK 请求的回调 |
