Tencent Cloud

Recent Pages

Room List (TUILiveKit)

Last updated: 2024-12-19 16:23:52
Description of the Feature
TUILiveKit already supports the room list UI component. The room list component helps display all the online live streaming and voice chat rooms in your application. After integrating the room list UI component, you can simply click on a live streaming room in the list to watch the current broadcast in real-time. Once in the live streaming room, you can interact with the host in real-time through danmaku, gifts, mic connection, and other features.
Room list component
Watch live streaming
Mic connection with the host
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
Feature Integration
Android
iOS
Flutter
Note:
Please make sure to complete the log in to operation as per Quick Integration (TUILiveKit) . You can only successfully enter the live preview screen after TUILogin.login log in to is successful.
1. Add a FrameLayout layout to the XML where the Room List UI Components need to be displayed.
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
﻿
    <FrameLayout
        android:id="@+id/fl_live_list"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />
</RelativeLayout>
2. By loading the page of TUILiveKit's TUILiveListFragment onto the XML definition layout, you can display the Room List.
Java
public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.app_activity_main);
﻿
        FragmentManager fragmentManager = getSupportFragmentManager();
        FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
        TUILiveListFragment listFragment = new TUILiveListFragment();
        fragmentTransaction.add(R.id.fl_live_list, listFragment);
        fragmentTransaction.commit();
    }
}
Note:
Please make sure that you have completed the Quick Access log in to operation. You can only enter the live preview screen normally after the TUILogin.login log in to is successful.
Swift
Objective-C
//
//  MainViewController.swift
//
﻿
import UIKit
import TUILiveKit
﻿
@objc private func buttonTapped(_ sender: UIButton) {
    // Enter Room List
    let liveListViewController = TUILiveListViewController()
    self.navigationController?.pushViewController(viewController, animated: true)
}
//
//  MainViewController.m
//
﻿
#import <TUILiveKit/TUILiveKit-Swift.h>
﻿
- (void)buttonTapped:(UIButton *)sender {
    // Enter Room List
    TUILiveListViewController *liveListViewController = [[TUILiveListViewController alloc] init];
    [self.navigationController pushViewController:liveListViewController animated:true];
}
Note:
Please make sure you have completed the log in operation as described in Quick Integration (TUILiveKit) . Only after a successful log in can you normally enter the live preview screen.
In your widget, you can display the room list by loading the LiveListWidget component of TUILiveKit.
Dart
import 'package:tencent_live_uikit/tencent_live_uikit.dart';
......
﻿
﻿
return Scaffold(
  body: SizedBox(
    width: _screenWidth,
    height: double.infinity,
    child: LiveListWidget(),    // Adding the room list component LiveListWidget of TUILiveKit in your own widget tree
  ),
);
Feature Customization
If the current UI does not meet your needs, you can modify the source code to achieve the UI effect you are satisfied with. To facilitate your customization of the UI, here is an introduction to the files related to the room list.
Android
iOS
Flutter
// File Location: Android/tuilivekit/src/Main/java/com/trtc/uikit/livekit/common/uicomponent/
﻿
roomlist                                      // Directory for the implementation of the Live Room List Component
  ├── service                                 // Service layer directory for the Live Room List Component
  │   └── RoomListService.java                // Specific implementation of the service layer in the Live Room List Component, encapsulating APIs related to the live room list
  ├── store                                   // Data layer directory for the Live Room List Component
  │   └── RoomListState.java                  // Data encapsulation class for the Live Room List Component
  └── view                                    // View layer directory for the Live Room List Component 
      ├── adapter                             // Adapter directory for the view layer of the Live Room List Component 
      │   ├── LoadMoreAdapterWrapper.java     // Adapter for adding pull-to-load-more feature to the live room list adapter of the Live Room List Component
      │   └── RoomListAdapter.java            // Live room list adapter for the Live Room List Component
      ├── ListAudienceActivity.java           // Streaming page triggered by clicking on a specific live room in the Live Room List Component
      └── RoomListView.java                   // Implementation of live room list view in the Live Room List 
// File Location: iOS/TUILiveKit/Sources/Component/LiveList/
﻿
├── LiveList                                // Directory for implementation of the Live Room List Component
│ ├── Service                               // Service Layer Directory for the Live Room List Component
│ │ └── LiveListService.swift               // Concrete implementation of the Service Layer for the Live Room List Component, encapsulating APIs related to the live room list
│ ├── Store                                 // Data Layer Directory for the Live Room List Component
│ │ ├── LiveListActions.swift               // Event Definition Class for the Live Room List Component, defining all events related to the live list
│ │ ├── LiveListReducer.swift               // Event Response Class for the Live Room List Component, triggered when events occur, used to listen to and modify data related to the live list
│ │ ├── LiveListSelectors.swift             // Data Selector Class for the Live Room List Component, retrieving values from the data source
│ │ ├── LiveListState.swift                 // Data Definition Class for the Live Room List Component, defining all data models related to the live list
│ │ └── LiveListStore.swift                 // Data Driver and Event Dispatch Protocol Class for the Live Room List Component
│ └── View                                  // View Layer Directory for the Live Room List Component 
│     ├── LiveListCell.swift                // Custom Cell for the Live Room List Component
│     └── LiveListRootView.swift            // Root View for the Live Room List Component 
// File location: Flutter/lib/common/ui_component/
﻿
room_list                                       // Directory for the implementation of the Live Room List Component
  ├── service                                   // Service layer directory for the Live Room List Component
  │   └── room_list_service.java                // Specific implementation of the service layer for the Live Room List Component, encapsulating APIs related to the live room list
  ├── store                                     // Data layer directory for the Live Room List Component
  │   └── room_list_state.java                  // Specific encapsulation class for the data of the Live Room List Component
  └── view                                      // View Layer Directory for the Live Room List Component 
      └── room_list_view.java                   // Implementation of the Live Room List View for the Live Room List Component
Key code
Get Live Room List Plugin
Android
iOS
Flutter
Java
// File Location: Android/tuilivekit/src/Main/java/com/trtc/uikit/livekit/common/uicomponent/roomlist/service/RoomListService.java
﻿
private final TUILiveListManager mTUILiveListManager;   
mTUILiveListManager = (TUILiveListManager) TUIRoomEngine.sharedInstance().getExtension(LIVE_LIST_MANAGER);
Swift
// File Location: iOS/TUILiveKit/Source/Component/LiveList/Service/LiveListService.swift
﻿
let listManager = roomEngine.getExtension(extensionType: .liveListManager) as? TUILiveListManager
Dart
// File Location: TUILiveKit/Flutter/lib/common/ui_component/room_list/service/room_list_service.dart
﻿
late final TUILiveListManager _liveListManager = TUIRoomEngine.sharedInstance().getExtension(TUIExtensionType.liveListManger);
Get Live Room List
Android
iOS
Flutter
Java
// File Location: Android/tuilivekit/src/Main/java/com/trtc/uikit/livekit/common/uicomponent/roomlist/service/RoomListService.java
﻿
private static final int FETCH_LIST_COUNT = 20;
public String cursor = "";
mTUILiveListManager.fetchLiveList(cursor, FETCH_LIST_COUNT, new LiveInfoListCallback() {
    @Override
    public void onSuccess(LiveInfoListResult result) {
    }
﻿
    @Override
    public void onError(TUICommonDefine.Error error, String s) {
    }
});
Swift
// File Location: iOS/TUILiveKit/Source/Component/LiveList/Service/LiveListService.swift
﻿
func getLiveList(cursor: String, count: Int = 20) -> AnyPublisher<(String, [TUILiveInfo]), InternalError> {
    return Future<(String,[TUILiveInfo]), InternalError> { [weak self] promise in
      guard let self = self else { return }
      guard let listManager = roomEngine.getExtension(extensionType: .liveListManager) as? TUILiveListManager else {
        promise(.failure(InternalError(error:TUIError.failed, message: "getRoomListFailed")))
        return 
      }
      listManager.fetchLiveList(cursor: cursor, count: count) { cursor, liveInfoList in
        promise(.success((cursor, liveInfoList)))
      } onError: { error, message in
        promise(.failure(InternalError(error: error, message: message)))
      }
    }.eraseToAnyPublisher()
}
Dart
// File Location: TUILiveKit/Flutter/lib/common/ui_component/room_list/service/room_list_service.dart
﻿
Future<void> _fetchLiveList() async {
  final String cursor = roomListState.cursor;
  TUIValueCallBack<TUILiveListResult> result = await _liveListManager.fetchLiveList(cursor, fetchListCount);
  if (result.code != TUIError.success) {
    ErrorHandler.onError(result.code);
    roomListState.loadStatus.value = false;
    roomListState.refreshStatus.value = false;
    roomListState.isHaveMoreData.value = false;
  } else {
    final liveListResult = result.data as TUILiveListResult;
    roomListState.liveInfoList.value = liveListResult.liveInfoList;
    roomListState.cursor = liveListResult.cursor;
    roomListState.loadStatus.value = false;
    roomListState.refreshStatus.value = false;
    roomListState.isHaveMoreData.value = liveListResult.cursor.isNotEmpty;
  }