Skip to content
开发文档示例与排障

H5:可运行示例 ​

一个用来验证凭证、接收第一条事件的本地页面。使用浏览器原生 WebSocket,无需安装 npm 依赖。

下载并运行 ​

先确认接入前提。准备 Node.js 22+,在尚不存在 live-studio-starter 子目录的位置,用 PowerShell 执行:

powershell
New-Item -ItemType Directory live-studio-starter
Set-Location live-studio-starter
$starterBase = 'https://tiktok-live-studio-local-data-access.pages.dev/samples'
'local-overlay.html', 'local-client.mjs', 'preview.mjs' | ForEach-Object {
  Invoke-WebRequest "$starterBase/$_" -OutFile $_
}
node preview.mjs

在 LIVE Studio 所在机器的浏览器中打开 http://127.0.0.1:4178,运行时输入 app_id、key_id、secret,点击 Connect。如果浏览器提示本地网络权限,仅为这个受信任的本地预览允许访问,不要关闭浏览器安全机制。

预期状态为 SCANNING → AUTHENTICATING → AUTHENTICATED。产生一条已开放类型的新互动后,日志显示 EVENT live.like、EVENT live.gift 或 EVENT live.chat。示例不会自动生成假事件。

点击 Disconnect / cancel 停止连接;在 PowerShell 中按 Ctrl+C 关闭预览服务。4178 仅用于访问开发页面,不是 Gateway 端口。

三个文件分别做什么 ​

文件职责
local-overlay.html运行时凭证输入、单连接管理、事件日志、示例礼物规则。
local-client.mjs有界端口发现、hello 校验、等待鉴权结果、取消、有限缓存去重。
preview.mjs只在 loopback 提供示例静态文件,不接收凭证。

也可以手动下载这三个文件,放进同一目录。填写凭证前先检查源码。公开页面用于下载,请在本地运行,不要在公开文档域名中运行带凭证的客户端。

修改礼物效果 ​

页面把 5655、6064、7569 映射到三个示例动作名称。等 repeat_end=true 后打印一次动作,不会按每次累计计数重复放大效果。可以从礼物目录选择 ID,再替换成自己的游戏处理函数。

日志只显示事件类型和示例动作名称,不输出观众消息或凭证。若要展示评论,请按纯文本渲染。

正式使用前 ​

这是首条事件验证工具,不是生产 SDK。示例刻意采用手动重连,每次重新点击都会发现服务并鉴权,重复点击不会建立多条连接。正式客户端还需要可取消的退避重连、严格的 payload 校验,以及业务连击策略。去重缓存最多保留 500 个键、窗口为 60 秒,不保证“恰好一次”投递。

收到撤销接入通知(DISCONNECT.reason_code=510)时,先联系支持确认资格,再重连。详见错误码与断开和连接生命周期。

凭证只在内存中使用,不会在 hello 校验前发送,不写入浏览器存储,也不提交给预览服务。不要把密钥放进公开静态资源,也不要通过远程代理暴露本地连接。