帮你快速理解、总结文档立即下载

观众观看(Web&H5 React)

最近更新时间:2026-11-19 11:33:07
我的收藏
TUILiveKit 的观众观看页为用户提供了丰富且便捷的直播观看与互动功能,能快速集成到您的应用中,满足观众多样化的需求。
集成提示:
本文档介绍基于 UI 组件 的观众观看方式(含完整交互 UI)。若您需通过 Core SDK 自行搭建观众端界面,请参考 观众观看 (Core SDK)。

功能概览

直播观看:清晰、流畅观看主播实时直播画面,可查看直播间标题、主播信息及在线观众。
直播互动:送礼物(有动画特效,主播接收提示)、点赞(有动画及实时统计)、发弹幕互动,并可申请与主播音视频连麦互动。
Web 观众观看
Web 观众和主播连麦






H5 观众观看
H5 观众和主播连麦







组件说明

LivePlayer 用于观看单个直播间,适用于直接进入某一个直播间的场景(如分享链接、开播推送通知),组件内已包含拉流、进房、连麦、弹幕、礼物、点赞等完整交互 UI。

快速接入

步骤 1:开通服务

参考 开通服务 文档开通体验版或大规模直播版套餐。

步骤 2:代码集成

参考 准备工作 接入 TUILiveKit,并完成 AtomicXCore 登录。
注意:
接入 LivePlayer 之前,请确保已完成登录,否则拉流与进房会失败。

步骤 3:使用 LivePlayer 观看单个直播间

在您的观众观看组件中引入并使用 LivePlayer 组件:
// 以 App.tsx 为例
import { useState, useEffect } from 'react';
import { UIKitProvider } from '@tencentcloud/uikit-base-component-react';
import { useLoginState, LoginStatus } from 'tuikit-atomicx-react';
import { LivePlayer } from '@tencentcloud/livekit-web-react';

const initialLiveId = new URLSearchParams(window.location.search).get('liveId') || '';

function App() {
const { login, loginStatus } = useLoginState();
const [liveId, setLiveId] = useState(initialLiveId);

function onLeave() {
// 可换成自己的返回逻辑(路由跳转 / 关闭页面)
setLiveId('');
}

useEffect(() => {
try {
login({
sdkAppId: 0, // SDKAppID - 开通服务时获取的 SDKAppID
userId: '', // UserID - 用户 ID
userSig: '', // userSig - 用户签名,详细获取方式请参照下文参数说明
});
} catch (error) {
console.error('登录失败:', error);
}
}, []);

return (
<UIKitProvider theme="dark">
{liveId && loginStatus === LoginStatus.LOGINED && <LivePlayer liveId={liveId} onLeave={onLeave} />}
</UIKitProvider>
);
}

export default App;

组件 API 说明

LivePlayer

观众播放页,从 @tencentcloud/livekit-web-react 导入。包在模块加载时按设备环境(isMobile)自动选用 LivePlayerPC / LivePlayerH5 实现。
Props
属性
类型
必填
默认值
说明
liveId
string
是
-
直播间 ID。
回调
回调
类型
参数
说明
onLeave
() => void
无
用户点击退出直播间按钮(组件内部会先调用 leaveLive() 方法)或被主播踢出直播间均会触发。组件内部已根据不同原因的直播间退出方式做了处理,leave 事件触发后只考虑路由跳转即可。

下一步

恭喜您,现在您已经成功集成了观众观看。接下来,您可以实现主播开播、直播列表等功能,可参考下表:
功能
描述
集成指引
主播开播
主播开播全流程功能,包括开播前的准备和开播后的各种互动
直播列表
展示直播间/语聊房列表,支持封面、人数、房间标题等信息展示