类型定义
类型 | 描述 |
麦位列表的布局模式,支持元素布局、宫格布局、纵向布局、自定义布局 | |
麦位布局的对齐方式 | |
请求类型(申请上麦和邀请上麦) | |
麦位布局配置信息 | |
麦位布局中每一行的布局配置信息 | |
麦位视图代理 |
SGLayoutMode
麦位列表的布局模式
类型 | 描述 |
focus | 元素布局 |
grid | 宫格布局 |
vertical | 纵向布局 |
free | 自定义布局 |
SGSeatViewLayoutRowAlignment
麦位布局的对齐方式
类型 | 说明 |
start | 麦位靠近起始位置 |
end | 麦位靠近结束位置 |
center | 麦位靠近中间位置 |
spaceBetween | 第一个麦位之前和最后一个麦位之后不留空间,其它麦位之间均匀分布剩余空间 |
spaceAround | 第一个麦位之前和最后一个麦位之后分布一半空间,其它麦位之间均匀分布剩余空间 |
spaceEvenly | 在所有麦位之间均匀分布剩余空间 |
SGRequestType
请求类型
类型 | 描述 |
applyToTakeSeat | 申请上麦 |
inviteToTakeSeat | 邀请上麦 |
SGSeatViewLayoutConfig
麦位布局配置信息
类型 | 描述 |
rowConfigs | |
rowSpacing | 麦位布局行间距 |
SGSeatViewLayoutRowConfig
麦位布局中每一行的布局配置信息
类型 | 描述 |
count | 此行显示的麦位数量 |
seatSpacing | 此行中每个麦位水平间距(仅当对齐方式为 START、END 和 CENTER 时生效) |
seatSize | 此行中麦位布局大小 |
alignment |
SGSeatViewDelegate
麦位视图适配器接口,您可以通过实现该接口来自定义每一个麦位的显示UI。
API | 说明 |
创建单个麦位布局时回调。 | |
更新麦位视图时回调。 | |
更新用户音量时回调。 |
回调事件详情
onAccepted
申请上麦/邀请上麦 请求被接受。
onAccepted: (_ userInfo: TUIUserInfo) -> Void
参数:
参数 | 类型 | 描述 |
userInfo | TUIUserInfo | 响应当前请求的用户信息 |
onRejected
申请上麦/邀请上麦 请求被拒绝。
onRejected: (_ userInfo: TUIUserInfo) -> Void
参数:
参数 | 类型 | 描述 |
userInfo | TUIUserInfo | 响应当前请求的用户信息 |
onCancelled
申请上麦/邀请上麦 请求被取消。
onCancelled: (_ userInfo: TUIUserInfo) -> Void
参数:
参数 | 类型 | 描述 |
userInfo | TUIUserInfo | 取消当前请求的用户信息 |
onTimeout
申请上麦/邀请上麦 请求超时。
onTimeout: (_ userInfo: TUIUserInfo) -> Void
参数:
参数 | 类型 | 描述 |
userInfo | UserInfo | 发起请求的用户信息 |
onError
申请上麦/邀请上麦 请求错误。
onError: (_ userInfo: TUIUserInfo, _ code: Int, _ message: String) -> Void
参数:
参数 | 类型 | 描述 |
userInfo | TUIUserInfo | 发起请求的用户信息 |
error | TUICommonDefine.Error | 错误码 |
message | String | 错误信息 |
seatGridView:createSeatView
创建单个麦位布局时回调,您需要将您自定义的view作为返回值,核心view会帮您创建好视图。
func seatGridView(_ view: SeatGridView, createSeatView seatInfo: TUISeatInfo) -> UIView?
参数:
参数 | 类型 | 描述 |
seatGridView | SeatGridView | 语聊房核心组件 |
seatInfo | SeatInfo | 麦位信息 |
返回值:UIView? (返回值为nil时使用默认麦位视图)
seatGridView:updateSeatView
更新麦位视图时回调,您可以根据回调回来的seatInfo信息来更新自己的麦位视图。
func seatGridView(_ view: SeatGridView, updateSeatView seatInfo: TUISeatInfo, seatView: UIView)
参数:
参数 | 类型 | 描述 |
seatGridView | SeatGridView | 语聊房核心组件 |
seatInfo | TUISeatInfo | 麦位信息 |
seatView | UIView | 当前更新的麦位视图 |
seatGridView:updateUserVolume
更新用户音量时回调,您可以根据回调回来的音量更新自己的麦位视图。
func seatGridView(_ view: SeatGridView, updateUserVolume volume: CGFloat, seatView: UIView)
参数:
参数 | 类型 | 描述 |
seatGridView | SeatGridView | 语聊房核心组件 |
volume | CGFloat | 麦位音量信息 |
seatView | UIView | 当前音量变化的麦位布局视图 |