AtomicX Core API/io.trtc.tuikit.atomicxcore.api.live/LiveListStore

LiveListStore

abstract class LiveListStore

Live list related interfaces, managing live room creation, joining, leaving and other operations.

Overview

LiveListStore Live room list management class for managing live room related business. LiveListStore provides a complete set of live room management APIs, including creating live, joining live, leaving live, ending live and other functions. Through this class, you can manage the lifecycle of live rooms.

Core Features

  • Live List: Get and manage live room list

  • Live Creation: Create new live rooms

  • 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

Important: Use LiveListStore.shared singleton object to get the LiveListStore instance. Live state updates are delivered through liveState publisher. Subscribe to it to receive real-time updates of live data.

Live Management Operations Overview

OperationMethodDescription
Get ListfetchLiveListGet live room list
Get InfofetchLiveInfoGet specified live room info
Create LivecreateLiveCreate new live room
Join LivejoinLiveJoin existing live room
Leave LiveleaveLiveLeave current live room
End LiveendLiveEnd current live
Update InfoupdateLiveInfoUpdate live room info

Topics

Getting Instance

Observing State and Events

Live List

Live Operations

Metadata Operations

See Also

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Singleton object

Properties

Link copied to clipboard
abstract val liveState: LiveListState

Live list state

Functions

Link copied to clipboard
abstract fun addLiveListListener(listener: LiveListListener)

Add live list event listener

Link copied to clipboard
abstract fun createLive(liveInfo: LiveInfo, completion: LiveInfoCompletionHandler?)

Create live

Link copied to clipboard
abstract fun endLive(completion: StopLiveCompletionHandler?)

End live

Link copied to clipboard
abstract fun fetchLiveInfo(liveID: String, completion: LiveInfoCompletionHandler?)

Get live info

Link copied to clipboard
abstract fun fetchLiveList(cursor: String?, count: Int, completion: CompletionHandler?)

Get live list

Link copied to clipboard
abstract fun joinLive(liveID: String?, completion: LiveInfoCompletionHandler?)

Join live

Link copied to clipboard
abstract fun leaveLive(completion: CompletionHandler?)

Leave live

Link copied to clipboard
abstract fun queryMetaData(keys: List<String>, completion: MetaDataCompletionHandler?)

Query metadata

Link copied to clipboard
abstract fun removeLiveListListener(listener: LiveListListener)

Remove live list event listener

Link copied to clipboard
abstract fun reset()

Reset to default state

Link copied to clipboard
abstract fun updateLiveInfo(liveInfo: LiveInfo, modifyFlagList: List<LiveInfo.ModifyFlag>, completion: CompletionHandler?)

Update live info

Link copied to clipboard
abstract fun updateLiveMetaData(metaData: HashMap<String, String>, completion: CompletionHandler?)

Update live metadata