类型定义
类型 | 描述 |
为核心控件设置连线的回调事件。 | |
连线时的布局模式,支持宫格布局、浮窗布局、自定义布局。 | |
连线视图适配器接口,您可以通过实现该接口来向您的每个音视频流视图上添加挂件。 |
ConnectionObserver
类型 | 说明 |
连麦的用户列表发生改变的回调。 | |
收到连麦请求的回调。 | |
收到取消连麦请求的回调。 | |
连麦请求被同意的回调。 | |
连麦请求被拒绝的回调。 | |
连麦请求超时的回调。 | |
主播断开和此观众连麦的回调。 | |
观众主动断开连线的回调。 | |
跨房连线的房间列表发生改变回调。 | |
收到跨房连线请求的回调。 | |
收到取消跨房连线请求的回调。 | |
收到同意跨房连线的回调 | |
收到拒绝跨房连线的回调 | |
收到跨房连线超时的回调。 | |
收到断开跨房连线的回调。 | |
收到房间销毁的回调。 |
LayoutMode
连线时的布局模式
类型 | 描述 |
gridLayout | 宫格布局。 |
floatLayout | 浮窗布局。 |
freeLayout | 自定义布局。 |
VideoViewDelegate
连线视图适配器接口,您可以通过实现该接口来向您的每个音视频流视图上添加挂件。
API | 说明 |
创建连麦观众视图时回调,您通过该 API 创建的 View 会被显示到连麦观众的视图上。 | |
更新连麦观众视图时回调。 | |
创建连线主播视图时回调,您通过该 API 创建的 View 会被显示到连线主播的视图上。 | |
更新连线主播视图时回调。 |
回调事件详情
onConnectedUsersUpdated
连麦的用户列表发生改变的回调。
func onConnectedUsersUpdated(userList: [TUIUserInfo], joinList: [TUIUserInfo], leaveList: [TUIUserInfo])
参数:
参数 | 类型 | 描述 |
userList | 连麦的用户列表 | |
joinList | 新加入的连麦用户 | |
leaveList | 离开的连麦用户 |
onUserConnectionRequest
收到连麦请求的回调。
func onUserConnectionRequest(inviterUser: TUIUserInfo)
参数:
参数 | 类型 | 描述 |
inviterUser | 申请连麦的用户信息 |
onUserConnectionCancelled
收到取消连麦请求的回调。
func onUserConnectionCancelled(inviterUser: TUIUserInfo)
参数:
参数 | 类型 | 描述 |
inviterUser | 取消连麦的用户信息 |
onUserConnectionAccepted
连麦请求被同意的回调。
func onUserConnectionAccepted(userInfo: TUIUserInfo)
参数:
参数 | 类型 | 描述 |
userInfo | 同意连麦的用户信息 |
onUserConnectionRejected
连麦请求被拒绝的回调。
func onUserConnectionRejected(userInfo: TUIUserInfo)
参数:
参数 | 类型 | 描述 |
userInfo | 拒绝连麦的用户信息 |
onUserConnectionTimeout
连麦请超时的回调。
func onUserConnectionTimeout(userInfo: TUIUserInfo)
参数:
参数 | 类型 | 描述 |
userInfo | 连麦请求超时的用户信息 |
onUserConnectionTerminated
主播断开和此观众连麦的回调。
func onUserConnectionTerminated()
onUserConnectionExited
连麦的用户断开连麦的回调。
func onUserConnectionExited(userInfo: TUIUserInfo)
参数:
参数 | 类型 | 描述 |
userInfo | 断开连麦的用户信息 |
onConnectedRoomsUpdated
连线的房间列表发生改变的回调。
func onConnectedRoomsUpdated(hostUserList: [TUIConnectionUser])
参数:
参数 | 类型 | 描述 |
hostUserList | 连线房间的房主列表 |
onCrossRoomConnectionRequest
收到跨房连线的请求的回调。
func onCrossRoomConnectionRequest(hostUser: TUIConnectionUser)
参数:
参数 | 类型 | 描述 |
hostUser | 申请连线的直播间房主信息 |
onCrossRoomConnectionCancelled
收到取消跨房连线请求的回调。
func onCrossRoomConnectionCancelled(hostUser: TUIConnectionUser)
参数:
参数 | 类型 | 描述 |
hostUser | 取消申请连线的直播间房主信息 |
onCrossRoomConnectionAccepted
收到同意跨房连线请求的回调。
func onCrossRoomConnectionAccepted(hostUser: TUIConnectionUser)
参数:
参数 | 类型 | 描述 |
hostUser | 同意连线的直播间房主信息 |
onCrossRoomConnectionRejected
收到拒绝跨房连线请求的回调。
func onCrossRoomConnectionRejected(hostUser: TUIConnectionUser)
参数:
参数 | 类型 | 描述 |
hostUser | 拒绝连线的直播间房主信息 |
onCrossRoomConnectionTimeout
收到房连线请求超时的回调。
func onCrossRoomConnectionTimeout(inviter: TUIConnectionUser, invitee: TUIConnectionUser)
参数:
参数 | 类型 | 描述 |
inviter | 申请连线的直播间房主信息 | |
invitee | 被邀请连线的直播间房主信息 |
onCrossRoomConnectionExited
连麦的用户列表发生改变的回调。
func onCrossRoomConnectionExited(hostUser: TUIConnectionUser)
参数:
参数 | 类型 | 描述 |
hostUser | 退出连线的直播间信息 |
onRoomDismissed
直播间被销毁的回调。
func onRoomDismissed(roomId: String)
参数:
参数 | 类型 | 描述 |
roomId | String | 房间 ID |
createCoGuestView
创建观众连麦的挂件视图,该视图会被添加到 该用户的视频流画面上面。
func createCoGuestView(userInfo: TUIUserInfo) -> UIView?
参数:
参数 | 类型 | 描述 |
userInfo | 连麦用户的用户信息 |
返回值:UIView?
updateCoGuestView
更新挂件视图的回调,一般情况下,您不需要关系此回调,您可以根据您自己的挂件数据状态来更新您设置的挂件视图,除非您的挂件依赖于userInfo的改变。
func updateCoGuestView(userInfo: TUIUserInfo, coGuestView: UIView)
参数:
参数 | 类型 | 描述 |
userInfo | 连麦用户的用户信息 | |
coGuestView | UIView |
createCoHostView
创建主播连线的挂件视图,该视图会被添加到 该连线主播的视频流画面上面。
func createCoHostView(connectionUser: TUIConnectionUser) -> UIView?
参数:
参数 | 类型 | 描述 |
connectionUser | 连线主播的用户信息 |
返回值:UIView?
updateCoHostView
更新挂件视图的回调,一般情况下,您不需要关系此回调,您可以根据您自己的挂件数据状态来更新您设置的挂件视图,除非您的挂件依赖于connectionUser的改变。
func updateCoHostView(connectionUser: TUIConnectionUser, coHostView: UIView)
参数:
参数 | 类型 | 描述 |
connectionUser | 连线主播的信息 | |
coHostView | UIView |