TUILiveListManager
Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveListManager @ TUIKitEngine
Functions: Relevant APIs for live room list. The functions on this page only support live room type (TUIRoomTypeLive).
TUILiveListManager
TUILiveListManager
Function List | Description |
Live information change callback | |
Add event callback | |
Remove event callback | |
Modify live information | |
Retrieve live information | |
Search live stream list |
Structure Type
Function List | Description |
Live information | |
Live stream list pull results |
Enumeration Types
Enumeration Types | Description |
Modify the flag bit in the live streaming room |
onLiveInfoChanged
Live information change callback
OnLiveInfoChanged onLiveInfoChanged = (TUILiveInfo liveInfo, List<TUILiveModifyFlag> modifyFlagList) {};
Parameter | Description |
liveInfo | Live room information |
modifyFlagList | Change value flag bit list |
addObserver
Add event callback
void addObserver(TUILiveListObserver observer);
Parameter | Description |
observer | Listening instances |
removeObserver
Remove event callback
void removeObserver(TUILiveListObserver observer);
Parameter | Description |
observer | Listening instances |
setLiveInfo
Modify live information
Future<TUIActionCallback> setLiveInfo(String roomId,{String? coverUrl,String? backgroundUrl,List<int>? categoryList,bool? isPublicVisible,int? activityStatus});
Parameter | Description |
roomId | room ID |
coverUrl | Profile photo URL |
categoryList | Live room category tag |
isPublicVisible | Is public |
activityStatus | Live streaming room active status: user-customized tag |
getLiveInfo
Retrieve live information
Future<TUIValueCallBack<TUILiveInfo>> getLiveInfo(String roomId);
Parameter | Description |
roomId | room ID |
fetchLiveList
Search live stream list
Future<TUIValueCallBack<TUILiveListResult>> fetchLiveList(String cursor, int count);
Parameter | Description |
cursor | list index |
count | The number of pulls each time |
TUILiveInfo
Live information
Enumeration Types | Description |
roomInfo | Read-only Room Information |
coverUrl | Live room cover |
backgroundUrl | Live room background |
categoryList | Live room category tag |
isPublicVisible | Whether the live room is public |
activityStatus | Live streaming room active status: user-customized tag |
viewCount | Cumulative Viewing Count |
TUILiveListResult
Enumeration Types | Description |
cursor | list index |
liveInfoList | Live room information list |
TUILiveModifyFlag
Modify the flag bit in the live streaming room
Error Example | Value | Description |
activityStatus | 0x0100 | ActivityStatus: Live streaming room active status, support customizing |
coverUrl | 0x0200 | CoverUrl: Live room cover |
category | 0x0400 | Category: Live room category |
publish | 0x2000 | Publish: Live room public marking |
backgroundUrl | 0x40000 | BackgroundUrl: Live room background |
