类型定义
类型 | 含义 |
自定义麦位 widget 构造器 | |
麦位点击事件 | |
收到房间销毁的事件 | |
收到被移出房间的事件 | |
收到申请上麦/邀请上麦的请求事件 | |
申请麦位/邀请上麦 请求被取消的事件 | |
收到用户被移下麦事件 | |
用户音频状态发生变化事件 | |
麦位列表的布局模式,支持聚焦布局、宫格布局、纵向布局、自定义布局 | |
麦位布局的对齐方式 | |
请求类型(申请上麦和邀请上麦) | |
请求结果类型 | |
请求结果回调 | |
麦位布局配置信息 | |
麦位布局中每一行的布局配置信息 |
SeatWidgetBuilder
自定义麦位
widget
构造器typedef SeatWidgetBuilder = Widget Function(BuildContext context,ValueNotifier<TUISeatInfo> seatInfoNotifier,ValueNotifier<int> volumeNotifier);
参数:
参数 | 类型 | 含义 |
context | BuildContext | 上下文 |
seatInfoNotifier | 麦位信息通知者 | |
volumeNotifier | ValueNotifier<int> | 音量信息通知者 |
OnSeatWidgetTap
麦位点击事件
typedef OnSeatWidgetTap = void Function(TUISeatInfo seatInfo);
参数:
参数 | 类型 | 含义 |
seatInfo | 麦位信息 |
OnRoomDismissed
收到房间销毁的事件
typedef OnRoomDismissed = void Function(String roomId);
参数:
参数 | 类型 | 含义 |
roomId | String | 房间 ID |
OnKickedOutOfRoom
收到被移出房间的事件
typedef OnKickedOutOfRoom = void Function(String roomId, TUIKickedOutOfRoomReason reason, String message);
参数:
参数 | 类型 | 含义 |
roomId | String | 房间 ID |
reason | TUIKickedOutOfRoomReason | 被踢原因 |
message | String | 被踢信息 |
OnSeatRequestReceived
收到申请上麦/邀请上麦的请求事件
typedef OnSeatRequestReceived = void Function(RequestType type, TUIUserInfo userInfo);
参数:
参数 | 类型 | 含义 |
type | 请求类型 | |
userInfo | 请求者信息 |
OnSeatRequestCancelled
申请麦位/邀请上麦 请求被取消的事件
typedef OnSeatRequestCancelled = void Function(RequestType type, TUIUserInfo userInfo);
参数:
参数 | 类型 | 含义 |
type | 请求类型 | |
userInfo | 操作者信息 |
OnKickedOffSeat
收到用户被移下麦事件
typedef OnKickedOffSeat = void Function(TUIUserInfo userInfo);
参数:
参数 | 类型 | 含义 |
userInfo | 操作者信息 |
OnUserAudioStateChanged
用户音频状态发生变化事件
typedef OnUserAudioStateChanged = void Function(TUIUserInfo userInfo, bool hasAudio, TUIChangeReason reason);
参数:
参数 | 类型 | 含义 |
userInfo | 操作者信息 | |
hasAudio | bool | 是否有音频流 |
reason | 音频流更改原因 |
LayoutMode
麦位列表的布局模式
枚举值 | 含义 |
focus | 聚焦布局 |
grid | 宫格布局 |
vertical | 纵向布局 |
free | 自定义布局 |
SeatWidgetLayoutRowAlignment
麦位布局的对齐方式
枚举值 | 含义 |
start | 麦位靠近起始位置 |
end | 麦位靠近结束位置 |
center | 麦位靠近中间位置 |
spaceBetween | 第一个麦位之前和最后一个麦位之后不留空间,其它麦位之间均匀分布剩余空间 |
spaceAround | 第一个麦位之前和最后一个麦位之后分布一半空间,其它麦位之间均匀分布剩余空间 |
spaceEvenly | 在所有麦位之间均匀分布剩余空间 |
RequestType
请求类型
枚举值 | 含义 |
applyToTakeSeat | 申请上麦 |
inviteToTakeSeat | 邀请上麦 |
RequestResultType
申请上麦/邀请上麦回调
枚举值 | 含义 |
onAccepted | 请求被接受 |
onRejected | 请求被拒绝 |
onCancelled | 请求被取消 |
onTimeout | 请求超时 |
onError | 请求异常 |
RequestCallback
请求结果回调
属性 | 类型 | 含义 |
code | 错误码枚举 | |
message | String | 错误码信息 |
type | 请求结果类型 | |
userInfo | 请求处理者 |
SeatWidgetLayoutRowConfig
麦位布局中每一行的布局配置信息
属性 | 类型 | 含义 |
count | int | 此行显示的麦位数量 |
seatSpacing | double | 此行中每个麦位水平间距(仅当对齐方式为 START、END 和 CENTER 时生效) |
seatSize | Size | 此行中麦位布局大小 |
alignment | 此行中布局的对齐方式 |
SeatWidgetLayoutConfig
麦位布局配置信息
属性 | 类型 | 描述 |
rowConfigs | 麦位布局中所有行配置信息列表 | |
rowSpacing | double | 麦位布局行间距 |