LiveListStore class abstract

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

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.

Key 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 the LiveListStore.shared singleton object to get the LiveListStore instance.

Note: Live state updates are delivered through the liveState publisher. Subscribe to it to receive real-time updates of live data.

Live Management Operations Overview

Operation Method Description
Get List fetchLiveList Get live room list
Get Info fetchLiveInfo Get specified live room info
Create Live createLive Create new live room
Join Live joinLive Join existing live room
Leave Live leaveLive Leave current live room
End Live endLive End current live
Update Info updateLiveInfo Update live room info

Topics

Getting Instance

Observing State and Events

Live List

Live Operations

Metadata Operations

See Also

Constructors

LiveListStore()

Properties

hashCode → int
The hash code for this object.
no setterinherited
liveState → LiveListState
Live list state
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addLiveListListener(LiveListListener listener) → void
Add live list event listener
createLive(LiveInfo liveInfo) → Future<LiveInfoCompletionHandler>
Create live
endLive() → Future<StopLiveCompletionHandler>
End live
fetchLiveInfo(String liveID) → Future<LiveInfoCompletionHandler>
Get live info
fetchLiveList({required String cursor, required int count}) → Future<CompletionHandler>
Get live list
joinLive(String liveID) → Future<LiveInfoCompletionHandler>
Join live
leaveLive() → Future<CompletionHandler>
Leave live
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
queryMetaData(List<String> keys) → Future<MetaDataCompletionHandler>
Query metadata
removeLiveListListener(LiveListListener listener) → void
Remove live list event listener
reset() → void
Reset to default state
toString() → String
A string representation of this object.
inherited
updateLiveInfo({required LiveInfo liveInfo, required List<ModifyFlag> modifyFlagList}) → Future<CompletionHandler>
Update live info
updateLiveMetaData(Map<String, String> metaData) → Future<CompletionHandler>
Update live metadata

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

shared → LiveListStore
Singleton object
no setter