コマンド
ホットキー、アクションステップ、検索、ローカル 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 では現在利用可能なコマンドを確認できます。
- イベント
- オーバーレイウィジェット
- 設定
実行制御
| コマンド | 選択画面の名前 | 値 |
|---|---|---|
control.pause | トリガーを一時停止 | なし |
control.resume | トリガーを再開 | なし |
control.togglePause | トリガーの一時停止／再開 | なし |
control.panic | 緊急停止：すべて停止して消去 | なし |
一時停止中も統計とランキングは集計されますが、トリガー、自動投擲、TTS、次のアラートは止まります。緊急停止は一時停止に加え、待機中、読み上げ中、画面上のものを消去します。
クイックデッキ
| コマンド | 選択画面の名前 | 値 |
|---|---|---|
deck.press | クイックデッキ：パッドを押す | パッド名または ID |
deck.stopAll | クイックデッキ：すべてのパッドを停止 | なし |
ステップやホットキーでは クイックデッキのパッドを選ぶ に、すべてのパッドが画像と名前付きで表示されます。
イベント
| コマンド | 選択画面の名前 | 値 |
|---|---|---|
mapping.trigger | イベントマッピングを実行 | イベント ID または API トリガー名 |
ステップの 実行するマッピング からイベントを選べます。ローカル API で使う ID はイベントを右クリックして イベント ID をコピー を選んで取得します。
アクションキュー
| コマンド | 選択画面の名前 | 値 |
|---|---|---|
queue.cancelActive | 実行中のアクションを中止 | なし |
queue.clearPending | 待機中のアクションを消去 | なし |
queue.clearAll | アクションキューを消去 | なし |
テキスト読み上げ
| コマンド | 選択画面の名前 | 値 |
|---|---|---|
tts.skip | 読み上げ中のメッセージをスキップ | なし |
tts.clear | 読み上げキューを消去 | なし |
tts.toggle | 読み上げのオン／オフ | なし |
アラート
| コマンド | 選択画面の名前 | 値 |
|---|---|---|
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} も受け付け、1 年を超える値は拒否します。
ゲーム
| コマンド | 選択画面の名前 | 値 |
|---|---|---|
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 | ゴールをリセット | goal1 などウィジェット ID |
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 は LIVE への参加完了前、要求の受け付け時に応答します。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
POST /api/trigger は、その名前を持つAPIトリガーが設定されたすべてのマッピングを発動します。
アプリ終了など Vfinity 自身のウィンドウコマンドは、アプリ外から実行できません。