คำสั่ง

คำสั่งแอปทั้งหมดที่คุณสามารถรันได้จากปุ่มลัด ขั้นตอนแอคชัน การค้นหา หรือ Local API

คำสั่งทั้งหมดที่ Vfinity สามารถสั่งการได้ตามชื่อ พร้อมค่าที่แต่ละคำสั่งต้องการ ชื่อคำสั่งเดียวกันนี้ใช้ได้ทั้งในปุ่มลัดส่วนกลาง ขั้นตอน คำสั่งแอป, ปุ่มควิกเด็ค, ค้นหาทุกอย่าง และ Local API

จุดที่สามารถรันคำสั่งได้

ช่องทาง	วิธีการใช้งาน
ปุ่มลัดส่วนกลาง	การตั้งค่าระบบอัตโนมัติและกฎปุ่มลัดส่วนกลาง: เลือกคำสั่งสำหรับคีย์ลัดแป้นพิมพ์
อีเวนต์และควิกเด็ค	ขั้นตอน คำสั่งแอป ซึ่งจะถามหาค่าพารามิเตอร์ของคำสั่งนั้น
ค้นหาทุกอย่าง	กด `Ctrl`+`K`/`Cmd`+`K` แล้วพิมพ์ชื่อคำสั่ง โดยจะแสดงเฉพาะคำสั่งที่ไม่ต้องระบุค่าพารามิเตอร์
Local API	ส่งคำขอ `POST /api/command` พร้อมเนื้อหา `{"name":"timer.add","args":30}` หรือส่งผ่าน `/api/ws`
Trigger API	ส่งข้อความ `{"type":"command","name":"timer.add","args":30,"requestId":"1"}`

เมนูเลือกคำสั่งจะจัดกลุ่มคำสั่งตามหัวข้อด้านล่างเรียงตามลำดับ คำสั่งจะปรากฏขึ้นเมื่อส่วนของแอปที่เป็นเจ้าของคำสั่งนั้นกำลังทำงานอยู่ และคำสั่ง GET /api/state ของ Local API จะแสดงรายชื่อคำสั่งทั้งหมดที่พร้อมใช้งานในขณะนั้น

ลองเลย

การเชื่อมต่อ

TikTok LIVE

Twitch

Kick

YouTube

VTSVTube Studio

ตามแพลตฟอร์ม

ควิกเด็ค

💖ขอบคุณ!

🎉ไปกันเลย!

👏ปรบมือ

😂หัวเราะ

⏭️ข้ามการแจ้งเตือน

🔇ข้ามเสียงพูด

บันทึกอีเวนต์

mochiส่งกุหลาบ ×5

kaitoกดติดตาม

ren_!dance

yuzuสมัครสมาชิก · 3 เดือน

Esc

↑↓ เลื่อน↵ เปิดCtrlK

พิมพ์ตัวอักษรไม่กี่ตัวในช่องค้นหาทุกอย่างเพื่อสั่งรันคำสั่งได้ทันที

การควบคุมการทำงาน

คำสั่ง	ชื่อในเมนูเลือก	ค่าที่ต้องการ
`control.pause`	หยุดพักทริกเกอร์	ไม่มี
`control.resume`	ทำงานต่อ	ไม่มี
`control.togglePause`	หยุดพักหรือทำงานต่อ	ไม่มี
`control.panic`	ฉุกเฉิน (Panic): หยุดและล้างทุกอย่าง	ไม่มี

การหยุดพักจะระงับทุกทริกเกอร์ การขว้างอัตโนมัติ ข้อความเสียงพูด และการแจ้งเตือนใหม่ โดยสถิติและลีดเดอร์บอร์ดยังคงนับต่อ ส่วนปุ่มฉุกเฉิน Panic จะหยุดพักเช่นกัน พร้อมล้างสิ่งที่อยู่ในคิว กำลังอ่านออกเสียง หรือกำลังแสดงผลบนหน้าจอ

ควิกเด็ค

คำสั่ง	ชื่อในเมนูเลือก	ค่าที่ต้องการ
`deck.press`	ควิกเด็ค: กดปุ่ม	ชื่อหรือ ID ของปุ่ม
`deck.stopAll`	ควิกเด็ค: หยุดทุกปุ่ม	ไม่มี

ในขั้นตอนแอคชันหรือปุ่มลัด ตัวเลือก เลือกปุ่มควิกเด็ค จะแสดงรายชื่อปุ่มทั้งหมดพร้อมรูปภาพและชื่อ

อีเวนต์

คำสั่ง	ชื่อในเมนูเลือก	ค่าที่ต้องการ
`mapping.trigger`	สั่งรันการจับคู่อีเวนต์	ID ของอีเวนต์ หรือชื่อของทริกเกอร์ API

ในขั้นตอนแอคชัน ตัวเลือก การจับคู่ที่จะรัน จะแสดงรายชื่ออีเวนต์ของคุณ คลิกขวาที่อีเวนต์แล้วเลือก คัดลอก ID อีเวนต์ เพื่อนำ ID ไปใช้กับ Local API

คิวแอคชัน

คำสั่ง	ชื่อในเมนูเลือก	ค่าที่ต้องการ
`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 ชื่อตรงกัน

คำสั่งที่ส่งไปยัง Local API จะทำงานเหมือนกับการสั่งผ่านปุ่มลัดทุกประการ

คำสั่งจัดการหน้าต่างของตัวแอป Vfinity เช่น การปิดโปรแกรม จะไม่สามารถสั่งรันจากภายนอกแอปได้