Web
This article provides a detailed guide on how to quickly run the TUILiveKit Demo. Following the instructions, you can run the demo in less than 10 minutes and experience a live online demo with a complete UI interface. You can also customize the page style, layout, and functionality according to your needs by following the free customization instructions on each page.
Step 1: Environment Preparation
Before running the demo, you need to refer to the preparation guide to complete the required environment configuration and activate the corresponding services.
Step 2: Download the Demo
1. Download the TUILiveKit Demo from GitHub, or run the following command directly from the command line:
git clone https://github.com/Tencent-RTC/TUILiveKit.git
2. Install dependencies
cd TUILiveKit/Web/web-vite-vue3npm install
Step 3: Configure Demo
You need to refer to the preparation in step 1, open the
TUILiveKit/Web/web-vite-vue3/src/config/basic-info-config.js file in the Demo, and enter the SDKAppID and SDKSecretKey obtained when activating the service in the preparation:
Step 4: Run the Demo
npm run dev
Step 5: Start the Live Stream
Anchor streaming
If you need to stream as a live streamer, you'll need to switch from the demo to the live streaming page. Simply change the URL in the navigation bar to http://localhost:5173/#/live-pusher to access the live streaming page. The live streaming page supports both landscape and portrait streaming. Additionally, you can add media sources to the page in the Add Sources area on the left. You can also click the Connect Viewer button below to accept or reject a viewer's request to connect.
Viewers Watching
After running the project for the first time, you'll need to enter your user ID to record your identity. Subsequent runs of the project will directly display the live stream list page, as shown in the image.
You can enter the live broadcast room by clicking on the corresponding live broadcast cover. In the live broadcast room, you can watch videos, follow the current anchor, send comments, view the audience list, and other operations.
Customization Guidelines
You can directly modify the UI source code we provide to adjust the user interface of TUILiveKit Demo according to your needs. Execute the following command under
TUILiveKit/Web/web-vite-vue3.mkdir -p ./src/TUILiveKit && rsync -av --exclude={'node_modules','package.json','excluded-list.txt'} ./node_modules/@tencentcloud/livekit-web-vue3/src/* ./src/TUILiveKit
xcopy .\node_modules\@tencentcloud\livekit-web-vue3\src\* .\src\TUILiveKit /i /e /exclude:.\node_modules\@tencentcloud\livekit-web-vue3\excluded-list.txt
Note：
After exporting the source code using the above script, the livekit-web-vue3 source code will be added to the specified src directory. At this point, you need to manually change the references of all livekit-web-vue3 components in the Web/web-vite-vue3 project from the npm package address to the relative path address of the livekit-web-vue3 source code. In addition, if you need to refer to the tuikit-atomicx-vue3 source code, please go to: GitHub.
If you need to selectively integrate a page into an existing project, or need to customize the UI of a page, you can refer to the following links to the respective page documentation and follow the guidelines to customize the UI.
Page | Document Link |
Host Streaming | |
Audience Viewing | |
Live Streaming List |
