参考手册
叠加层 URL
浏览器源 URL 的结构、全部路由和组件 ID,以及副本与局域网密钥
每个叠加层都是 Vfinity 自有服务器上的网页,由 OBS 或 TikTok LIVE Studio 作为浏览器源打开。本页拆解其 URL。
试一试
复制 OBS 浏览器源 URL
选择一个组件,查看点击其“复制链接”按钮获得的地址。
组件
http://127.0.0.1:21424/#overlay-goal?id=goal1&lang=zh
http://127.0.0.1:21424/#overlay-goal?id=goal1&lang=zh
- 本机上的叠加层服务器http://127.0.0.1:21424
- 哪个组件#overlay-goal
- 同类中的哪个组件?id=goal1
- 语言,与应用保持一致&lang=zh
URL 的组成
http://127.0.0.1:21424/#overlay-goal?id=goal1©=copy_lx4k2a9fz&lang=en| 部分 | 示例 | 含义 |
|---|---|---|
| 地址 | 127.0.0.1 | 本机;开启局域网访问后为本机网络地址 |
| 端口 | 21424 | 叠加层服务器端口;若被占用,Vfinity 会另选端口 |
| 访问密钥 | 位于 # 前的 ?token=… | 仅在开启局域网访问后出现 |
| 路由 | #overlay-goal | 网页绘制的组件类型 |
id | goal1 | 同类中具体的组件,适用于包含多个组件的路由 |
copy | copy_lx4k2a9fz | 组件副本 ID;原始组件不包含此项 |
lang | en | 页面显示语言:en、th、zh、ja、hi 或 es |
组件上的复制链接或右键菜单中的复制 OBS 链接会使用实际端口和应用语言自动生成 URL。请直接复制,不必手工输入。
仅含一个组件的路由
| 路由 | 组件 |
|---|---|
#overlay-chat | 聊天框 |
#overlay-alerts | 实时提醒 |
#overlay-events | 事件展示板 |
#overlay-timer | 倒计时 |
#overlay-buddies | 观众小伙伴 |
#overlay-actions | 动作媒体,展示显示图片或视频步骤的媒体 |
#overlay-custom | 自定义组件 |
#overlay-clock | 时钟与倒计时 |
#overlay-scene | 场景卡 |
#overlay-checklist | 清单 |
Alpha 0.4.0 新增的组件也遵循同样的格式,例如时钟与倒计时的地址形如 http://127.0.0.1:21424/#overlay-clock?lang=en,场景卡某个副本的地址形如 http://127.0.0.1:21424/#overlay-scene?copy=copy_lx4k2a9fz&lang=en。
需要 ID 的路由
| 路由 | id 的值 |
|---|---|
#overlay-stat | viewerCount、followerCount、streamClock、giftCounter1 至 giftCounter3、statLabel1 至 statLabel3 |
#overlay-leaderboard | topGifter、topLiker、topStreaker、topChatter、pointsRanking、credits |
#overlay-goal | goal1 至 goal4 |
#overlay-feed | giftFeed、diamondTicker、lastGifter、lastFollower、lastLiker、lastSharer、lastChatter、lastSubscriber、lastJoiner |
#overlay-gauge | coinJar、streamBoss |
#overlay-particles | giftCannon、likeFountain、giftFirework、fallingSnow、emojify、emoteWall、confetti |
#overlay-media | staticText、staticImage、videoPlayer、socialRotator、sponsorBanner |
#overlay-frame | webcamFrame、overlayFrame、talkingBanner |
#overlay-games | giftJar、wheel、poll、viewerQueue、giveaway、tugOfWar、hypeMeter |
叠加层组件列出了各组件及设置。
不属于组件的来源
| 路由 | 用途 |
|---|---|
#throwing | 礼物砸向模型的投掷场景;在投掷标签复制 |
#overlay-audio | 隐形音频源,播放设置为在 OBS 中输出的文本转语音 |
重复添加 #overlay-audio 不会重复播放。要在多个场景中使用,请用添加现有来源将同一个来源加入各场景。
副本
添加副本会创建设置和 URL 都独立的第二个组件版本,其 URL 包含 copy= 与副本 ID。
| 限制 | 数值 |
|---|---|
| 所有组件合计副本 | 16 个 |
| 副本名称 | 最多 60 个字符 |
| 不可复制的组件 | 实时提醒 |
副本保留原组件的 id,以便页面识别类型。删除副本后,其 OBS 来源会变为空白,不会改为重复显示原组件。
从另一台电脑运行 OBS
在 设置连接本地服务器 开启允许另一台电脑上的 OBS 使用这些叠加层并重启 Vfinity。此时复制链接会提供本机局域网地址和访问密钥:
http://192.168.1.5:21424/?token=YOUR_KEY#overlay-chat?lang=en密钥位于 # 前,服务器才能在首次请求时收到它。没有密钥的局域网请求和局域网外的请求都会被拒绝。点击重新生成密钥会使旧 URL 失效,之后须在 OBS 中重新粘贴每个地址。