tencent cloud

Tencent Real-Time Communication

DocumentationTencent Real-Time CommunicationLiveClient APIsiOSLiveListStore

LiveListStore

PDF
Focus Mode
Font Size
Last updated: 2026-04-16 10:08:17

Introduction

LiveListStore provides a complete set of live room management APIs, including starting live, joining live, leaving live, ending live and other functions. Through this class, you can manage the lifecycle of live rooms. The host calls startLive/endLive to start and dismiss a live room, while the audience calls joinLive/leaveLive to join and leave a live room.
Important:
Use the shared singleton object to get the LiveListStore instance.
Note:
Live state updates are delivered through the state publisher. Subscribe to it to receive real-time updates of live data.

Features

Live List: Get and manage live room list.
Start Live: Host starts broadcasting. If the live room ID is new, a new live room will be created; if the live room ID already exists on the server, the host will join and start broadcasting.
Live Joining: Join existing live rooms.
Live Management: Update live info, end live and other operations.
Event Listening: Listen for live ended, kicked out and other events.

Subscribable Data

LiveListState fields are described below:
Property
Type
Description
liveList
Live list.
liveListCursor
String
Live list cursor.
currentLive
Current live info.

API List

Function
Description
Singleton object.
Live list event publisher.
Get live list.
Get live info.
Start live (Host only).
Join live (Audience only).
Leave live (Audience only).
End live (Host only).
Update live info.
Query metadata.
Update metadata.

Getting Instance

shared

Singleton object.

Observing State and Events

liveListEventPublisher

Live list event publisher.

Live List

fetchLiveList

Get live list.
public func fetchLiveList(cursor: String,
                          count: Int,
                          completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
cursor
String
Required
Cursor.
count
Int
Required
Count.
completion
CompletionClosure?
Required
Completion callback.

fetchLiveInfo

Get live info.
public func fetchLiveInfo(liveID: String,
                        completion: LiveInfoCompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
liveID
String
Required
Live room ID.
completion
LiveInfoCompletionClosure?
Required
Completion callback.

Live Operations

startLive

Start live (Host only).
public func startLive(_ liveInfo: LiveInfo,
                       completion: LiveInfoCompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Host starts broadcasting. If the live room ID is new, a new live room will be created; if the live room ID already exists on the server, the host will join and start broadcasting.
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
liveInfo
Required
Live info.
completion
LiveInfoCompletionClosure?
Required
Completion callback.

joinLive

Join live (Audience only).
public func joinLive(liveID: String,
                     completion: LiveInfoCompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Called by the audience to join an existing live room.
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
liveID
String
Required
Live ID.
completion
LiveInfoCompletionClosure?
Required
Completion callback.

leaveLive

Leave live (Audience only).
public func leaveLive(completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Called by the audience to leave the current live room. If the host only needs to leave the room without dismissing it, this API can also be called.
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
completion
CompletionClosure?
Required
Completion callback.

endLive

End live (Host only).
public func endLive(completion: StopLiveCompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Called by the host to end the current live and dismiss the room.
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
completion
StopLiveCompletionClosure?
Required
Completion callback.

updateLiveInfo

Update live info.
public func updateLiveInfo(_ liveInfo: LiveInfo,
                           modifyFlag: LiveInfo.ModifyFlag,
                           completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
liveInfo
Required
Live info.
modifyFlag
LiveInfo.ModifyFlag
Required
Modify flag.
completion
CompletionClosure?
Required
Completion callback.

Metadata Operations

queryMetaData

Query metadata.
public func queryMetaData(keys: [String], completion: MetaDataCompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
keys
[String]
Required
Key list.
completion
MetaDataCompletionClosure?
Required
Completion callback.

updateLiveMetaData

Update live metadata.
public func updateLiveMetaData(_ metaData: [String: String],
                               completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
metaData
[String: String]
Required
Metadata.
completion
CompletionClosure?
Required
Completion callback.

Data Structures

TakeSeatMode

Take seat mode.
Enum Value
Description
free
Free to take seat.
apply
Apply to take seat.

SeatLayoutTemplate

Seat layout template for simplifying seat configuration when creating a live room.
Enum Value
Description
videoDynamicGrid9Seats
Portrait dynamic 9-grid layout for video live streaming.
videoDynamicFloat7Seats
Portrait dynamic 1v6 floating layout for video live streaming.
videoLeftFocus9Seats
Portrait left focus 9-grid layout for video live streaming.
videoUniformGrid9Seats
Portrait uniform 9-grid layout for video live streaming.
videoFixedGrid9Seats
Portrait static 9-grid layout for video live streaming.
videoFixedFloat7Seats
Portrait static 1v6 floating layout for video live streaming.
videoLandscape4Seats
Landscape 4-seat layout for video live streaming.
karaoke
Audio KTV layout for karaoke scenes with configurable seat count.
audioSalon
Audio salon layout for voice chat scenes with configurable seat count.

LiveEndedReason

Live ended reason.
Enum Value
Description
endedByHost
Ended by host.
endedByServer
Ended by server.

LiveKickedOutReason

Kicked out of live room reason.
Enum Value
Description
byAdmin
Kicked out by admin.
byLoggedOnOtherDevice
Logged on other device.
byServer
Kicked out by server.
forNetworkDisconnected
Network disconnected.
forJoinRoomStatusInvalidDuringOffline
Join room status invalid during offline.
forCountOfJoinedRoomsExceedLimit
Count of joined rooms exceed limit.

LiveInfo

Live information.
Property
Type
Description
liveID
String
Live ID.
liveName
String
Live name.
notice
String
Live notice.
isMessageDisable
Bool
Whether message is disabled.
isPublicVisible
Bool
Whether publicly visible.
isSeatEnabled
Bool
Whether seat is enabled.
keepOwnerOnSeat
Bool
Whether to keep owner on seat.
maxSeatCount
Int
Maximum seat count.
seatMode
Take seat mode.
seatTemplate
Seat layout template for simplifying seat configuration.
seatLayoutTemplateID
UInt
Seat layout template ID.
coverURL
String
Cover URL.
backgroundURL
String
Background URL.
categoryList
[NSNumber]
Category list.
activityStatus
Int
Activity status.
liveOwner
LiveUserInfo
Live owner info.
createTime
Int
Create time.
totalViewerCount
Int
Total viewer count.
isGiftEnabled
Bool
Whether gift is enabled.
metaData
[String: String]
Metadata.

LiveListState

Live list state.
Property
Type
Description
liveList
Live list.
liveListCursor
String
Live list cursor.
currentLive
Current live info.

LiveListListener

Live list events.
Methods
onLiveEnded: Live ended event.
case onLiveEnded(liveID: String, reason: LiveEndedReason, message: String)
Parameter
Type
Description
liveID
String
Live ID.
reason
Ended reason.
message
String
Message.
onKickedOutOfLive: Kicked out of live room event.
case onKickedOutOfLive(liveID: String, reason: LiveKickedOutReason, message: String)
Parameter
Type
Description
liveID
String
Live ID.
reason
Kicked out reason.
message
String
Message.
Previous Topic: LiveCoreViewNext Topic: LiveSeatStore

Help and Support

Was this page helpful?

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

Feedback