TUILiveListManager
Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveListManager @ TUIKitEngine.
Function: Live Room list APIS, the functions on this webpage only support to TUIRoomTypeLive room type.
TUILiveListManager
TUILiveListManagerObserver
FuncList | DESC |
Live Streaming Info Change Callback |
TUILiveListManager
FuncList | DESC |
Set Event Callback | |
Remove Event Callback | |
Host starts live | |
Host stop live | |
Join live room | |
Leave live room | |
Modify live information. | |
Get live information. | |
Get a list of live rooms, with a maximum of 50 returned per fetch. |
StructType
FuncList | DESC |
Live info | |
Live Streaming Statistics |
onLiveInfoChanged:modifyFlag:
onLiveInfoChanged:modifyFlag:
- (void)onLiveInfoChanged: | |
modifyFlag: | (TUILiveModifyFlag)modifyFlag |
Live Streaming Info Change Callback
Param | DESC |
liveInfo | Live room info |
modifyFlag | Modify flag |
addObserver:
addObserver:
- (void)addObserver: |
Set Event Callback
You can receive live room event notifications through TUILiveListManagerObserver.
Param | DESC |
observer | Observer |
removeObserver:
removeObserver:
- (void)removeObserver: |
Remove Event Callback
Param | DESC |
observer | Observer. |
startLive:onSuccess:onError:
startLive:onSuccess:onError:
- (void)startLive: | |
onSuccess: | (TUILiveInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Host starts live
Param | DESC |
liveInfo | Live info |
onError | Failure callback |
onSuccess | Success callback |
stopLive:onError:
stopLive:onError:
- (void)stopLive: | (TUIStopLiveBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Host stop live
Param | DESC |
onError | Failure callback |
onSuccess | Success callback |
joinLive:onSuccess:onError:
joinLive:onSuccess:onError:
- (void)joinLive: | (NSString *)roomId |
onSuccess: | (TUILiveInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Join live room
Param | DESC |
onError | Failure callback |
onSuccess | Success callback |
roomId | Room identifier |
leaveLive:onError:
leaveLive:onError:
- (void)leaveLive: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Leave live room
Param | DESC |
onError | Failure callback |
onSuccess | Success callback |
setLiveInfo:modifyFlag:onSuccess:onError:
setLiveInfo:modifyFlag:onSuccess:onError:
- (void)setLiveInfo: | |
modifyFlag: | (TUILiveModifyFlag)modifyFlag |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Modify live information.
Param | DESC |
liveInfo | Live information. |
modifyFlag | Modifiable parameter. More details, see TUILiveModifyFlag. |
getLiveInfo:onSuccess:onError:
getLiveInfo:onSuccess:onError:
- (void)getLiveInfo: | (NSString *)roomId |
onSuccess: | (TUILiveInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Get live information.
Param | DESC |
roomId | Room ID. |
fetchLiveList:count:onSuccess:onError:
fetchLiveList:count:onSuccess:onError:
- (void)fetchLiveList: | (NSString *)cursor |
count: | (NSInteger)count |
onSuccess: | (TUILiveInfoListBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
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. |
TUILiveInfo
TUILiveInfo
Live info
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: NO. |
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 Statistics
EnumType | DESC |
totalGiftCoins | Total gift coins |
totalGiftsSent | Total gifts sent |
totalLikesReceived | Total likes received |
totalUniqueGiftSenders | Total unique gift senders |
totalViewers | Total Views |
