命令 · Vfinity

可通过快捷键、动作步骤、搜索和本地 API 运行的全部应用命令

这里列出 Vfinity 可按名称运行的所有命令及所需参数。同一个名称适用于全局快捷键、应用命令步骤、快捷面板按键、搜索全部和本地 API。

命令的运行位置

位置	用法
全局快捷键	设置自动化与规则全局快捷键：为组合键选择命令
事件与快捷面板	使用应用命令步骤，并填入命令所需的值
搜索全部	按 `Ctrl`+`K`/`Cmd`+`K` 输入命令名称；只列出不需要参数的命令
本地 API	向 `POST /api/command` 发送 `{"name":"timer.add","args":30}`，或通过 `/api/ws` 发送相同消息
触发 API	发送 `{"type":"command","name":"timer.add","args":30,"requestId":"1"}`

选择器按下列顺序对命令分组。命令所属部分运行后才会显示；本地 API 的 GET /api/state 列出当前可用的命令。

试一试

Esc

↑↓ 移动↵ 打开CtrlK

在“搜索全部”中输入几个字母，即可立即运行命令。

运行控制

命令	选择器中的名称	值
`control.pause`	暂停触发	无
`control.resume`	恢复触发	无
`control.togglePause`	暂停或恢复触发	无
`control.panic`	紧急停止：停止并清空一切	无

暂停会阻止新的触发器、自动投掷、TTS 消息与提醒，但统计和排行榜仍继续计数。紧急停止也会暂停，并清除队列、正在朗读和画面上的内容。

快捷面板

命令	选择器中的名称	值
`deck.press`	快捷面板：按下按键	按键名称或 ID
`deck.stopAll`	快捷面板：停止所有按键	无

在步骤或快捷键中，选择快捷面板按键会列出各按键的图片和名称。

事件

命令	选择器中的名称	值
`mapping.trigger`	运行一个事件映射	事件 ID，或 API 触发器名称

步骤中的要运行的映射会列出你的事件。右键点击事件并选择复制事件 ID，可获取本地 API 所需的 ID。

动作队列

命令	选择器中的名称	值
`queue.cancelActive`	取消正在运行的动作	无
`queue.clearPending`	清除等待中的动作	无
`queue.clearAll`	清空动作队列	无

文本转语音

命令	选择器中的名称	值
`tts.skip`	跳过当前 TTS 消息	无
`tts.clear`	清空 TTS 队列	无
`tts.toggle`	开启或关闭 TTS	无

提醒

命令	选择器中的名称	值
`alerts.skip`	提醒：跳过当前显示的提醒	无
`alerts.pause`	提醒：暂停	无
`alerts.resume`	提醒：继续	无
`alerts.replay`	提醒：重播	提醒 ID；留空则重播上一次
`alerts.clear`	提醒：清除	无

所有已打开的 OBS 提醒来源都会响应这些命令。

投掷

命令	选择器中的名称	值
`throw.items`	投掷物品	JSON，字段与投掷物品步骤相同
`throw.clear`	清除物品	无

throw.clear 会移除 OBS 和预览中的所有投掷物，并停止仍在进行的连击投掷。

VTube Studio

命令	选择器中的名称	值
`vts.reconnect`	重新连接 VTube Studio	无

计时器

命令	选择器中的名称	值
`timer.start`	计时器：开始	无
`timer.pause`	计时器：暂停	无
`timer.reset`	计时器：重置	无
`timer.add`	计时器：增加秒数	秒数
`timer.set`	计时器：设置秒数	大于或等于 0 的秒数
`timer.toggleMode`	计时器：切换计时方向	无

timer.add 和 timer.set 也接受 {"seconds":30}，且拒绝超过一年的时间。

游戏

命令	选择器中的名称	值
`wheel.spin`	旋转转盘	无
`giftJar.clear`	清空礼物罐	无
`poll.start`	开始新投票	无
`poll.close`	结束投票	无
`viewerQueue.next`	下一位观众	无
`viewerQueue.clear`	清空队列	无
`viewerQueue.toggle`	打开 / 关闭队列	无
`giveaway.open`	开放参与	无
`giveaway.close`	截止参与	无
`giveaway.draw`	抽出中奖者	无
`giveaway.reset`	重置抽奖	无
`giveaway.clearWinners`	清除以往中奖者	无
`tugOfWar.start`	开始回合	无
`tugOfWar.stop`	立即结束回合	无
`tugOfWar.reset`	重置回合	无
`hypeMeter.boost`	提升热度	增加量；留空为 50
`hypeMeter.reset`	重置热度	无

Vfinity 暂停时，抽出中奖者、开始回合和提升热度会返回拒绝原因，转盘也不会旋转。

叠加层

命令	选择器中的名称	值
`sceneCard.showStarting`	场景卡：显示“即将开始”	无
`sceneCard.showBrb`	场景卡：显示“马上回来”	无
`sceneCard.showEnding`	场景卡：显示“直播结束”	无
`sceneCard.hide`	场景卡：隐藏	无
`sceneCard.countdownStart`	场景卡：开始倒计时	无
`sceneCard.countdownStop`	场景卡：停止倒计时	无
`checklist.checkNext`	清单：勾选下一项	无
`checklist.uncheckAll`	清单：全部取消勾选	无
`buddies.clear`	清空观众小伙伴	无

显示某个场景时会开启场景卡，每张卡片从自己的分钟数开始倒计时。通过快捷键、步骤或 API 运行时，这些命令作用于该组件及其所有副本：你关闭的副本保持关闭，但仍会跟随场景切换；清单命令只勾选显示同一份清单的副本。在叠加层标签中从卡片的右键菜单运行时，它们只作用于那一张卡片。

统计

命令	选择器中的名称	值
`stats.resetSession`	重置本次会话	无

重置本次会话会让本场直播的统计和排行榜从头开始，历史总数和积分余额不受影响。

目标

命令	选择器中的名称	值
`goal.reset`	重置目标	目标组件 ID，如 `goal1`
`goal.add`	给目标添加进度	JSON：`{"id":"goal1","amount":5}`

其他

命令	选择器中的名称	值
`triggers.reset`	重置里程碑和首次发言记录	无
`tiktok.connect`	`tiktok.connect`	可选 JSON：`{"username":"…","autoRejoin":true,"waitForLive":true}`
`tiktok.disconnect`	`tiktok.disconnect`	无
`tiktok.cancelRejoin`	`tiktok.cancelRejoin`	无

tiktok.connect 会在请求获接纳时答复，不等待真正进入直播间。tiktok.cancelRejoin 取消等待或重新加入，但不会断开已加入的直播间。

你的脚本

POST /api/trigger
Host: 127.0.0.1:21424
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "name": "hype",
  "data": {
    "name": "mochi"
  }
}

发送中…

{"ok":true}

事件

API 触发器

hype

VTS 快捷键 · 星星眼

POST /api/trigger 会触发所有 API 触发器名称与之相符的映射。

发送到本地 API 的命令与通过快捷键运行时效果相同。

退出应用等 Vfinity 窗口命令无法从应用外部执行。

命令