TUILiveListManager

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

TUILiveListManager

TUILiveListManager

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

结构体类型

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

枚举类型

枚举类型
描述
直播间修改标记位

onLiveInfoChanged

onLiveInfoChanged
void onLiveInfoChanged
(LiveInfo liveInfo

List<LiveModifyFlag> modifyFlagList)

直播信息改变回调

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

addObserver

addObserver
void addObserver
(Observer observer)

设置事件回调

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

removeObserver

removeObserver
void removeObserver
(Observer observer)

移除事件回调

参数
描述
observer
监听的实例。

startLive

startLive
void startLive
(LiveInfo liveInfo

LiveInfoCallback callback)

主播开播

参数
描述
callback
调用接口的回调,用于通知接口调用的成功或者失败
liveInfo
直播信息

stopLive

stopLive
void stopLive
(StopLiveCallback callback)

主播关播

参数
描述
callback
调用接口的回调,用于通知接口调用的成功或者失败

joinLive

joinLive
void joinLive
(String roomId

LiveInfoCallback callback)

进入直播间

参数
描述
callback
调用接口的回调,用于通知接口调用的成功或者失败
roomId
房间 ID

leaveLive

leaveLive
void leaveLive
(TUIRoomDefine.ActionCallback callback)

离开直播间

参数
描述
callback
调用接口的回调,用于通知接口调用的成功或者失败

setLiveInfo

setLiveInfo
void setLiveInfo
(LiveInfo liveInfo

List<LiveModifyFlag> modifyFlagList

TUIRoomDefine.ActionCallback callback)

修改直播信息

参数
描述
callback
调用接口的回调,用于通知接口调用的成功或者失败
liveInfo
直播信息
modifyFlag
修改标记

getLiveInfo

getLiveInfo
void getLiveInfo
(String roomId

LiveInfoCallback callback)

获取直播信息

参数
描述
callback
调用接口的回调,用于通知接口调用的成功或者失败
roomId
房间ID

fetchLiveList

fetchLiveList
void fetchLiveList
(String cursor

int count

LiveInfoListCallback callback)

获取直播列表

参数
描述
callback
调用接口的回调,用于通知接口调用的成功或者失败
count
每次拉取个数
cursor
列表下标

startPreloadVideoStream

startPreloadVideoStream
void startPreloadVideoStream
(String roomId

boolean isMuteAudio

TUIVideoView view

TUIRoomDefine.PlayCallback callback)

开始房间视频流预加载

参数
描述
callback
调用接口的回调,用于通知播放时的状态回调。
isMuteAudio
是否静音播放。
roomId
房间ID。
view
视频渲染视图。

stopPreloadVideoStream

stopPreloadVideoStream
void stopPreloadVideoStream
(String roomId)

停止房间视频流预加载

参数
描述
roomId
房间ID。

TUILiveModifyFlag

TUILiveModifyFlag

直播间修改标记位

枚举
取值
描述
NAME
1 << 0
Name: 直播间名称
NOTICE
1 << 1
Notice: 直播间公告
DISABLE_MESSAGE
1 << 2
DisableMessage: 房间内全员禁止消息
PUBLISH
1 << 5
Publish: 直播间公开标记
TAKE_SEAT_MODE
1 << 6
TakeSeatMode: 直播间内上麦模式
COVER_URL
1 << 7
CoverUrl: 直播间封面
BACKGROUND_URL
1 << 8
BackgroundUrl: 直播间背景.
CATEGORY
1 << 9
Category: 直播间分类
ACTIVITY_STATUS
1 << 10
ActivityStatus: 直播间活跃状态,支持自定义设置

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
累计观看次数