tencent cloud

Tencent Real-Time Communication

Release Notes and Announcements
Release Notes
Recent Product Announcement
TRTC Live (TUILiveKit) Product Launch Announcement
TRTC Conference Official Editions Launched
The commercial version of Conference is coming soon
Terms and Conditions Applicable to $9.9 Starter Package
Rules for the "First Subscription $100 Discount" Promotion
Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
TRTC Call Official Editions Launched
License Required for Video Playback in New Version of LiteAV SDK
TRTC to Offer Monthly Packages
Product Introduction
Overview
Concepts
Features
Strengths
Use Cases
Performance Statistics
Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!
Purchase Guide
Billing Overview
Free Minutes
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
FAQs
Refund Instructions
User Tutorial
Free Demo
Call
Overview
Activate the Service
Run Demo
Integration
Offline Call Push
Conversational Chat
On-Cloud Recording
AI Noise Reduction
UI Customization
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
Release Notes
FAQs
Conference
Overview（TUIRoomKit）
Activate the Service (TUIRoomKit)
Run Demo（TUIRoomKit）
Integration（TUIRoomKit）
Screen Sharing (TUIRoomKit)
Schedule a meeting (TUIRoomKit)
In-meeting Call (TUIRoomKit)
UI Customization（TUIRoomKit）
Virtual Background (TUIRoomKit)
Conference Control (TUIRoomKit)
Cloud Recording (TUIRoomKit)
AI Noise Reduction (TUIRoomKit)
In-Conference Chat (TUIRoomKit)
Robot Streaming (TUIRoomKit)
Enhanced Features (TUIRoomKit)
Client APIs (TUIRoomKit)
Server APIs (TUIRoomKit)
FAQs (TUIRoomKit)
Error Code (TUIRoomKit)
SDK Update Log (TUIRoomKit)
Live
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Run Demo
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDK Download
API Examples
Usage Guidelines
API Reference Manual
Advanced Features
AI Integration
Overview
Configure MCP Server
Install Skills
Integration Guide
FAQ
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Companion Transcription APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
Console Guide
Application Management
Package Management
Usage Statistics
Monitoring Dashboard
Development Assistance
Solution
Real-Time Chorus
FAQs
Migration Guide
Billing
Features
UserSig
Firewall Restrictions
How to Downsize Installation Package
Android and iOS
Web
Flutter
Electron
TRTCCalling for Web
Audio and Video Quality
Others
Legacy Documentation
RTC RoomEngine SDK（Old）
Integrating TUIRoom (Web)
Integrating TUIRoom (Android)
Integrating TUIRoom (iOS)
Integrating TUIRoom (Flutter)
Integrating TUIRoom (Electron)
TUIRoom APIs
On-Cloud Recording and Playback (Old)
RTC Analytics Monthly Packages (Previous Version)
Protocols and Policies
Compliance
Security White Paper
Notes on Information Security
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC Policy
Privacy Policy
Data Processing And Security Agreement
Glossary
DocumentationTencent Real-Time CommunicationLegacy DocumentationRTC RoomEngine SDK（Old）RTC Room Engine SDKiOS TUILiveListManager

TUILiveListManager

PDF
Focus Mode
Font Size
Last updated: 2025-07-17 18:04:00
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:
(TUILiveInfo *)liveInfo
modifyFlag:
(TUILiveModifyFlag)modifyFlag

Live Streaming Info Change Callback

Param
DESC
liveInfo
Live room info
modifyFlag
Modify flag

addObserver:

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

Set Event Callback

You can receive live room event notifications through TUILiveListManagerObserver.
Param
DESC
observer
Observer

removeObserver:

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

Remove Event Callback

Param
DESC
observer
Observer.

startLive:onSuccess:onError:

startLive:onSuccess:onError:
- (void)startLive:
(TUILiveInfo *)liveInfo
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:
(TUILiveInfo *)liveInfo
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
Previous Topic: TUIRoomDeviceManagerNext Topic: TUILiveConnectionManager

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback