このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

TUILiveListManager

Copyright (c) 2024 Tencent. All rights reserved.
Module:   TUILiveListManager @ TUIKitEngine.
Function: Live Room list APIS, the functions on this webpage only support to ﻿LIVE﻿ room type.
﻿
﻿
TUILiveListManager
TUILiveListManager
FuncList
DESC
onLiveInfoChanged
Live Streaming Info Change Callback
addObserver
Set Event Callback
removeObserver
Remove Event Callback
startLive
Host starts live
stopLive
Host stop live
joinLive
Join live room
leaveLive
Live live room
setLiveInfo
Modify live information.
getLiveInfo
Get live information.
fetchLiveList
Get a list of live rooms, with a maximum of 50 returned per fetch.
StructType
FuncList
DESC
LiveInfo
Live info
LiveStatisticsData
Live Streaming Statistics
EnumType
EnumType
DESC
LiveModifyFlag
The TUILiveInfo modifiable parameter key.
onLiveInfoChanged
onLiveInfoChanged
void onLiveInfoChanged
(﻿LiveInfo﻿ liveInfo
﻿
List<﻿LiveModifyFlag﻿> modifyFlagList)
Live Streaming Info Change CallbackParam
DESC
liveInfo
Live room info
modifyFlag
Modify flag
addObserver
addObserver
void addObserver
(Observer observer)
Set Event CallbackYou can receive live room event notifications through TUILiveListManagerObserver.
Param
DESC
observer
Observer
removeObserver
removeObserver
void removeObserver
(Observer observer)
Remove Event CallbackParam
DESC
observer
Observer.
startLive
startLive
void startLive
(﻿LiveInfo﻿ liveInfo
﻿
LiveInfoCallback callback)
Host starts liveParam
DESC
callback
Callback
liveInfo
Live info
stopLive
stopLive
void stopLive
(StopLiveCallback callback)
Host stop liveParam
DESC
callback
Callback
joinLive
joinLive
void joinLive
(String roomId
﻿
LiveInfoCallback callback)
Join live roomParam
DESC
callback
Callback
roomId
Room identifier
leaveLive
leaveLive
void leaveLive
(TUIRoomDefine.ActionCallback callback)
Live live roomParam
DESC
callback
Callback
setLiveInfo
setLiveInfo
void setLiveInfo
(﻿LiveInfo﻿ liveInfo
﻿
List<﻿LiveModifyFlag﻿> modifyFlagList
﻿
TUIRoomDefine.ActionCallback callback)
Modify live information.Param
DESC
liveInfo
Live information.
modifyFlag
Modifiable parameter. More details, see ﻿TUILiveModifyFlag﻿.
getLiveInfo
getLiveInfo
void getLiveInfo
(String roomId
﻿
LiveInfoCallback callback)
Get live information.Param
DESC
roomId
Room ID.
fetchLiveList
fetchLiveList
void fetchLiveList
(String cursor
﻿
int count
﻿
LiveInfoListCallback callback)
Get a list of live rooms, with a maximum of 50 returned per fetch.Param
DESC
count
Set the number of live lists to be obtained in each request.
cursor
Set the index of live lists in each request.
TUILiveModifyFlag
TUILiveModifyFlag
The TUILiveInfo modifiable parameter key.Enum
Value
DESC
NAME
1 << 0
Name: Room name
NOTICE
1 << 1
Notice: Room notification
DISABLE_MESSAGE
1 << 2
DisableMessage: Disable sending message
PUBLISH
1 << 5
Publish: Live room public flag.
TAKE_SEAT_MODE
1 << 6
TakeSeatMode: Take seat mode
COVER_URL
1 << 7
CoverUrl: Live room cover url
BACKGROUND_URL
1 << 8
BackgroundUrl: Live room cover image url.
CATEGORY
1 << 9
Category: Live room category list
ACTIVITY_STATUS
1 << 10
ActivityStatus: Live room active status, support for custom settings.
TUILiveInfo
TUILiveInfo
Live infoEnumType
DESC
activityStatus
The public parameter can control whether the live room can be seen by others.
backgroundUrl
CoverUrl: Live room background, maximum support is 200 bytes.
categoryList
Live room category tags, a single room supports up to 3 tags.
coverUrl
CoverUrl: Live room cover, maximum support is 200 bytes.
createTime
The room creation time (read-only).
isMessageDisableForAllUser
The status of disabling for all user to send message in room (optional parameter for creating a room), default value: ﻿false﻿.
isPublicVisible
The public parameter can control whether the live room can be seen by others.
isSeatEnabled
The status of enabling seat.
keepOwnerOnSeat
The ost automatically joins the mic after starting the live stream
maxSeatCount
Maximum number of seat.
name
Room name (Optional parameter, default is room ID, maximum support is 100 bytes).
notice
Room notification (Optional parameter, default is room ID, maximum support is 100 bytes).
ownerAvatarUrl
Room owner avatar URL: Default is the room creator's avatar URL (read-only).
ownerId
Owner ID: Default is the room creator (read-only).
ownerName
Room owner name: Default is the room creator's name (read-only).
roomId
Room ID (String type, required parameter for creating room, maximum support is 48 bytes).
roomInfo
Basic room info (deprecated)
seatMode
Seat mode (only available after isSeatEnabled is true).
viewCount
Total views (the count of user entering live room).
TUILiveStatisticsData
TUILiveStatisticsData
Live Streaming StatisticsEnumType
DESC
totalGiftCoins
Total gift coins
totalGiftsSent
Total gifts sent
totalLikesReceived
Total likes received
totalUniqueGiftSenders
Total unique gift senders
totalViewers
Total Views

FuncList	DESC
onLiveInfoChanged	Live Streaming Info Change Callback
addObserver	Set Event Callback
removeObserver	Remove Event Callback
startLive	Host starts live
stopLive	Host stop live
joinLive	Join live room
leaveLive	Live live room
setLiveInfo	Modify live information.
getLiveInfo	Get live information.
fetchLiveList	Get a list of live rooms, with a maximum of 50 returned per fetch.

FuncList	DESC
LiveInfo	Live info
LiveStatisticsData	Live Streaming Statistics

EnumType	DESC
LiveModifyFlag	The TUILiveInfo modifiable parameter key.

void onLiveInfoChanged	(LiveInfo liveInfo
	List<LiveModifyFlag> modifyFlagList)

void setLiveInfo	(LiveInfo liveInfo
	List<LiveModifyFlag> modifyFlagList
	TUIRoomDefine.ActionCallback callback)

Param	DESC
liveInfo	Live information.
modifyFlag	Modifiable parameter. More details, see TUILiveModifyFlag.

void fetchLiveList	(String cursor
	int count
	LiveInfoListCallback callback)

Param	DESC
count	Set the number of live lists to be obtained in each request.
cursor	Set the index of live lists in each request.

Enum	Value	DESC
NAME	1 << 0	Name: Room name
NOTICE	1 << 1	Notice: Room notification
DISABLE_MESSAGE	1 << 2	DisableMessage: Disable sending message
PUBLISH	1 << 5	Publish: Live room public flag.
TAKE_SEAT_MODE	1 << 6	TakeSeatMode: Take seat mode
COVER_URL	1 << 7	CoverUrl: Live room cover url
BACKGROUND_URL	1 << 8	BackgroundUrl: Live room cover image url.
CATEGORY	1 << 9	Category: Live room category list
ACTIVITY_STATUS	1 << 10	ActivityStatus: Live room active status, support for custom settings.

EnumType	DESC
activityStatus	The public parameter can control whether the live room can be seen by others.
backgroundUrl	CoverUrl: Live room background, maximum support is 200 bytes.
categoryList	Live room category tags, a single room supports up to 3 tags.
coverUrl	CoverUrl: Live room cover, maximum support is 200 bytes.
createTime	The room creation time (read-only).
isMessageDisableForAllUser	The status of disabling for all user to send message in room (optional parameter for creating a room), default value: false.
isPublicVisible	The public parameter can control whether the live room can be seen by others.
isSeatEnabled	The status of enabling seat.
keepOwnerOnSeat	The ost automatically joins the mic after starting the live stream
maxSeatCount	Maximum number of seat.
name	Room name (Optional parameter, default is room ID, maximum support is 100 bytes).
notice	Room notification (Optional parameter, default is room ID, maximum support is 100 bytes).
ownerAvatarUrl	Room owner avatar URL: Default is the room creator's avatar URL (read-only).
ownerId	Owner ID: Default is the room creator (read-only).
ownerName	Room owner name: Default is the room creator's name (read-only).
roomId	Room ID (String type, required parameter for creating room, maximum support is 48 bytes).
roomInfo	Basic room info (deprecated)
seatMode	Seat mode (only available after isSeatEnabled is true).
viewCount	Total views (the count of user entering live room).

EnumType	DESC
totalGiftCoins	Total gift coins
totalGiftsSent	Total gifts sent
totalLikesReceived	Total likes received
totalUniqueGiftSenders	Total unique gift senders
totalViewers	Total Views