TUILiveListManager

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveListManager @ TUIKitEngine
Function: 直播房间列表相关接口,此页面中的函数仅支持直播房间类型(TUIRoomTypeLive)。

TUILiveListManager

TUILiveListManagerObserver

函数列表
描述
直播信息改变回调

TUILiveListManager

函数列表
描述
设置事件回调
移除事件回调
主播开播
主播关播
进入直播间
离开直播间
修改直播信息
获取直播信息
获取直播列表
开始房间视频流预加载
停止房间视频流预加载

结构体类型

函数列表
描述
直播信息
直播统计信息

onLiveInfoChanged:modifyFlag:

onLiveInfoChanged:modifyFlag:
- (void)onLiveInfoChanged:
(TUILiveInfo *)liveInfo
modifyFlag:
(TUILiveModifyFlag)modifyFlag

直播信息改变回调

参数
描述
liveInfo
直播间信息
modifyFlag
改变类型

addObserver:

addObserver:
- (void)addObserver:
(id<TUILiveListManagerObserver>)observer

设置事件回调

您可以通过 TUILiveListManagerObserver 获得直播间事件通知
参数
描述
observer
监听的实例

removeObserver:

removeObserver:
- (void)removeObserver:
(id<TUILiveListManagerObserver>)observer

移除事件回调

参数
描述
observer
监听的实例。

startLive:onSuccess:onError:

startLive:onSuccess:onError:
- (void)startLive:
(TUILiveInfo *)liveInfo
onSuccess:
(TUILiveInfoBlock)onSuccess
onError:
(TUIErrorBlock)onError

主播开播

参数
描述
liveInfo
直播信息
onError
失败回调
onSuccess
成功回调

stopLive:onError:

stopLive:onError:
- (void)stopLive:
(TUIStopLiveBlock)onSuccess
onError:
(TUIErrorBlock)onError

主播关播

参数
描述
onError
失败回调
onSuccess
成功回调

joinLive:onSuccess:onError:

joinLive:onSuccess:onError:
- (void)joinLive:
(NSString *)roomId
onSuccess:
(TUILiveInfoBlock)onSuccess
onError:
(TUIErrorBlock)onError

进入直播间

参数
描述
onError
失败回调
onSuccess
成功回调
roomId
房间 ID

leaveLive:onError:

leaveLive:onError:
- (void)leaveLive:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError

离开直播间

参数
描述
onError
失败回调
onSuccess
成功回调

setLiveInfo:modifyFlag:onSuccess:onError:

setLiveInfo:modifyFlag:onSuccess:onError:
- (void)setLiveInfo:
(TUILiveInfo *)liveInfo
modifyFlag:
(TUILiveModifyFlag)modifyFlag
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError

修改直播信息

参数
描述
liveInfo
直播信息
modifyFlag
修改标记
onError
失败回调
onSuccess
成功回调

getLiveInfo:onSuccess:onError:

getLiveInfo:onSuccess:onError:
- (void)getLiveInfo:
(NSString *)roomId
onSuccess:
(TUILiveInfoBlock)onSuccess
onError:
(TUIErrorBlock)onError

获取直播信息

参数
描述
onError
失败回调
onSuccess
成功回调
roomId
房间ID

fetchLiveList:count:onSuccess:onError:

fetchLiveList:count:onSuccess:onError:
- (void)fetchLiveList:
(NSString *)cursor
count:
(NSInteger)count
onSuccess:
(TUILiveInfoListBlock)onSuccess
onError:
(TUIErrorBlock)onError

获取直播列表

参数
描述
count
每次拉取个数
cursor
列表下标
onError
失败回调
onSuccess
成功回调
注意
获取直播间列表,单次拉取最大支持返回 50 个。

startPreloadVideoStream:isMuteAudio:view:onPlaying:onLoading:onError:

startPreloadVideoStream:isMuteAudio:view:onPlaying:onLoading:onError:
- (void)startPreloadVideoStream:
(NSString*)roomId
isMuteAudio:
(BOOL)isMuteAudio
view:
(TUIVideoView *__nullable)view
onPlaying:
(TUIPlayOnPlayingBlock)onPlaying
onLoading:
(TUIPlayOnLoadingBlock)onLoading
onError:
(TUIPlayOnErrorBlock)onError

开始房间视频流预加载

参数
描述
isMuteAudio
是否静音播放。
onError
错误回调。
onLoading
加载回调。
onPlaying
播放回调。
roomId
房间ID。
view
视频渲染视图。

stopPreloadVideoStream:

stopPreloadVideoStream:
- (void)stopPreloadVideoStream:
(NSString*)roomId

停止房间视频流预加载

参数
描述
roomId
房间ID。

TUILiveInfo

TUILiveInfo

直播信息

枚举类型
描述
activityStatus
直播间活跃状态: 用户自定义标记
backgroundUrl
直播间背景,最大支持 200 个字节
categoryList
直播间分类标签,单个房间最大支持3个标记
coverUrl
直播间封面,最大支持 200 个字节
createTime
房间创建时间(只读)。
isMessageDisableForAllUser
是否禁止发送消息(创建房间可选参数),默认值:NO
isPublicVisible
直播间是否公开
isSeatEnabled
是否开启麦位控制。
keepOwnerOnSeat
房主开播后自动上麦
maxSeatCount
最大麦位数。
name
房间名称(创建房间可选参数,默认房间ID,最大支持100个字节)。
notice
房间公告(创建房间可选参数,最大支持100个字节)。
ownerAvatarUrl
房主头像URL: 默认为房间创建者头像URL(只读)。
ownerId
房主ID: 默认为房间创建者ID(只读)。
ownerName
房主昵称: 默认为房间创建者昵称(只读)。
roomId
房间ID (创建房间必填参数,最大支持48个字节)。
roomInfo
房间信息(废弃)
seatMode
上麦模式(只有开启麦位控制后生效)。
viewCount
累计观看次数

TUILiveStatisticsData

TUILiveStatisticsData

直播统计信息

枚举类型
描述
totalGiftCoins
送礼总金额
totalGiftsSent
送礼总个数
totalLikesReceived
点赞总数
totalUniqueGiftSenders
送礼人数
totalViewers
累计观看次数