製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
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.LiveListStore instance.Function | Description |
Singleton object. | |
Live list event callbacks. | |
Live list event callbacks. | |
Get live list. | |
Get live info. | |
Create live. | |
Join live. | |
Leave live. | |
End live. | |
Update live info. | |
Query metadata. | |
Update metadata. |
abstract fun addLiveListListener(listener: LiveListListener)
Parameter | Type | Required | Description |
listener | Required | Listener. |
abstract fun removeLiveListListener(listener: LiveListListener)
Parameter | Type | Required | Description |
listener | Required | Listener. |
abstract fun fetchLiveList(cursor: String?,count: Int,completion: CompletionHandler?)
Parameter | Type | Required | Description |
cursor | String? | Required | Cursor. |
count | Int | Required | Count. |
completion | Required | Completion callback. |
abstract fun fetchLiveInfo(liveID: String,completion: LiveInfoCompletionHandler?)
Parameter | Type | Required | Description |
liveID | String | Required | Live room ID. |
completion | Required | Completion callback. |
abstract fun createLive(liveInfo: LiveInfo,completion: LiveInfoCompletionHandler?)
Parameter | Type | Required | Description |
liveInfo | Required | Live info. | |
completion | Required | Completion callback. |
abstract fun joinLive(liveID: String?,completion: LiveInfoCompletionHandler?)
Parameter | Type | Required | Description |
liveID | String? | Required | Live ID. |
completion | Required | Completion callback. |
abstract fun leaveLive(completion: CompletionHandler?)
Parameter | Type | Required | Description |
completion | Required | Completion callback. |
abstract fun endLive(completion: StopLiveCompletionHandler?)
Parameter | Type | Required | Description |
completion | Required | Completion callback. |
abstract fun updateLiveInfo(liveInfo: LiveInfo,modifyFlagList: List<LiveInfo.ModifyFlag>,completion: CompletionHandler?)
Parameter | Type | Required | Description |
liveInfo | Required | Live info. | |
modifyFlag | List<LiveInfo.ModifyFlag> | Required | Modify flag. |
completion | Required | Completion callback. |
abstract fun queryMetaData(keys: List<String>,completion: MetaDataCompletionHandler?)
Parameter | Type | Required | Description |
keys | List<String> | Required | Key list. |
completion | Required | Completion callback. |
abstract fun updateLiveMetaData(metaData: HashMap<String, String>,completion: CompletionHandler?)
Parameter | Type | Required | Description |
metaData | HashMap<String, String> | Required | Metadata. |
completion | Required | Completion callback. |
Enum Value | Description |
FREE | Free to take seat. |
APPLY | Apply to take seat. |
Enum Value | Description |
VideoDynamicGrid9Seats | Portrait dynamic 9-grid layout for video live streaming. |
VideoDynamicFloat7Seats | Portrait dynamic 1v6 floating 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. |
Enum Value | Description |
ENDED_BY_HOST | Ended by host. |
ENDED_BY_SERVER | Ended by server. |
Enum Value | Description |
BY_ADMIN | Kicked out by admin. |
BY_LOGGED_ON_OTHER_DEVICE | Logged on other device. |
BY_SERVER | Kicked out by server. |
FOR_NETWORK_DISCONNECTED | Network disconnected. |
FOR_JOIN_ROOM_STATUS_INVALID_DURING_OFFLINE | Join room status invalid during offline. |
FOR_COUNT_OF_JOINED_ROOMS_EXCEED_LIMIT | Count of joined rooms exceed limit. |
Property | Type | Required | Description |
liveID | String | Required | Unique identifier for the live room, maximum 48 bytes. It is recommended to use prefixes to distinguish different room types. |
liveName | String | Optional | Live room name, maximum 100 bytes. If not set, defaults to the room ID. |
notice | String | Optional | Room announcement, maximum 100 bytes. |
seatTemplate | Required | Seat layout template for simplifying seat configuration. Portrait video streaming: Supports VideoDynamicGrid9Seats (dynamic grid layout), VideoDynamicFloat7Seats (floating window layout), VideoFixedGrid9Seats (fixed grid layout), VideoFixedFloat7Seats (fixed floating layout), etc.Landscape video streaming: Supports VideoLandscape4Seat (landscape layout).Voice chat room streaming: Supports AudioSalon (chat room layout), Karaoke (KTV layout), etc. | |
keepOwnerOnSeat | Boolean | Optional | Only applicable to voice chat room scenarios; default value is false, and the owner will not automatically take a seat. If set to true, the owner will automatically take a seat after entering the room. |
seatMode | Optional | Take seat mode, with the following options. Default is FreeToTake mode.FreeToTake: Free to take seat, no approval from owner or admin is required.ApplyToTake: Apply to take seat, approval from owner or admin is required. | |
maxSeatCount | Int | Optional | Only applicable to voice chat room scenarios, effective when SeatTemplate is set to AudioSalon or Karaoke, sets the number of seats in the room (value range is limited by the maximum count in the package). |
isSeatEnabled | Boolean | Optional | Deprecated. Use seatTemplate instead. This parameter will be parsed automatically. |
seatLayoutTemplateID | Int | Optional | Deprecated. Use seatTemplate instead. This parameter will be parsed automatically. |
isMessageDisable | Boolean | Optional | Default value is false, allowing viewers to send barrage messages. Admins and owners are exceptions.Only the owner and admins can modify this setting. |
isPublicVisible | Boolean | Optional | Whether the room is visible in the live room list, default value is true.Only the owner and admins can modify this setting. Set to false if you want to preview before officially going live or create a private live room.Set to true if you want the room to be visible in the live room list. |
isGiftEnabled | Boolean | Optional | Read-only, default value is true, allowing viewers to send gifts. |
coverURL | String | Optional | Room cover image, can be used for display in the live room list. Maximum 200 bytes. Only the owner and admins can modify this setting. |
backgroundURL | String | Optional | Background image of the live room, maximum 200 bytes. Only the owner and admins can modify this setting. |
categoryList | List<Int> | Optional | Room category tags, custom field, can be used as room type identifiers such as gaming, music, etc. Only the owner and admins can modify this setting. A single room supports up to 3 tags. |
activityStatus | Int | Optional | Activity status within the live room, custom field. For example: 0 - Game preparing; 1 - In game; 2 - Game ended. Only the owner and admins can modify this setting. Once set, all users entering the room will receive this value; when updated, users in the room will also receive the latest value. |
liveOwner | Optional | Read-only, the owner information of the current live room, defaults to the user who created the room. | |
createTime | Long | Optional | Read-only, room creation timestamp in milliseconds. |
totalViewerCount | Int | Optional | Read-only, total number of times users have entered the room. |
metaData | Map<String, String> | Optional | Custom metadata key-value pairs, both keys and values must be strings. Only the owner and admins can modify this setting. A single room supports up to 10 keys, each key can be up to 50 bytes, each value can be up to 2KB, and the total size of all values in a single room cannot exceed 16KB. |
open fun onLiveEnded(liveID: String, reason: LiveEndedReason, message: String) {}
Parameter | Type | Description |
liveID | String | Live ID. |
reason | Ended reason. | |
message | String | Message. |
open fun onKickedOutOfLive(liveID: String, reason: LiveKickedOutReason, message: String) {}
Parameter | Type | Description |
liveID | String | Live ID. |
reason | Kicked out reason. | |
message | String | Message. |
fun onSuccess(liveInfo: LiveInfo)
Parameter | Type | Description |
liveInfo | Live info. |
fun onFailure(code: Int, desc: String)
Parameter | Type | Description |
code | Int | Error code. |
desc | String | Error description. |
fun onSuccess(statisticsData: TUILiveListManager.LiveStatisticsData)
Parameter | Type | Description |
statisticsData | TUILiveListManager.LiveStatisticsData | Live statistics data. |
fun onFailure(code: Int, desc: String)
Parameter | Type | Description |
code | Int | Error code. |
desc | String | Error description. |
fun onSuccess(metaData: HashMap<String, String>)
Parameter | Type | Description |
metaData | HashMap<String, String> | Metadata. |
fun onFailure(code: Int, desc: String)
Parameter | Type | Description |
code | Int | Error code. |
desc | String | Error description. |
フィードバック