Comandos
Cada comando de la app que puedes ejecutar desde un atajo de teclado, un paso de acción, la búsqueda o la API local
Cada comando que Vfinity puede ejecutar por su nombre, junto con el valor que admite. Los mismos nombres funcionan en un atajo global, en un paso de Comando de la app, en un botón del Panel rápido, en Buscar todo y en la API local.
Dónde se ejecutan los comandos
| Ubicación | Cómo |
|---|---|
| Atajos globales | AjustesAutomatización y reglasAtajos globales: asigna un comando a una combinación de teclas |
| Eventos y Panel rápido | Un paso de Comando de la app, que solicita el valor del comando |
| Buscar todo | Pulsa Ctrl+K/Cmd+K y escribe el nombre del comando; solo se listan los comandos que no requieren valor |
| API local | POST /api/command con {"name":"timer.add","args":30}, o el mismo mensaje en /api/ws |
| API de disparadores | {"type":"command","name":"timer.add","args":30,"requestId":"1"} |
Los selectores organizan los comandos bajo los encabezados mostrados a continuación, en este orden. Un
comando aparece tan pronto como la sección de la app que lo gestiona esté en funcionamiento, y GET /api/state
en la API local lista todos los comandos disponibles en cada instante.
- Eventos
- Widgets de overlay
- Ajustes
Control de ejecución
| Comando | Nombre en selectores | Valor |
|---|---|---|
control.pause | Pausar disparadores | Ninguno |
control.resume | Reanudar disparadores | Ninguno |
control.togglePause | Pausar o reanudar disparadores | Ninguno |
control.panic | Pánico: detener y limpiar todo | Ninguno |
Pausar retiene todos los disparadores, autolanzamientos, mensajes de TTS y alertas nuevas, mientras que las estadísticas y clasificaciones siguen contando. Pánico también pausa y limpia lo que esté en cola, reproduciéndose o en pantalla.
Panel rápido
| Comando | Nombre en selectores | Valor |
|---|---|---|
deck.press | Panel rápido: pulsar un botón | El nombre o ID del botón |
deck.stopAll | Panel rápido: detener todos los botones | Ninguno |
En un paso o en un atajo, Elegir un botón del Panel rápido lista cada botón con su imagen y nombre.
Eventos
| Comando | Nombre en selectores | Valor |
|---|---|---|
mapping.trigger | Ejecutar un mapeo de Eventos | El ID de un evento o el nombre de un disparador de API |
En un paso, Mapeo a ejecutar lista tus eventos. Haz clic derecho en un evento y selecciona Copiar ID de evento para obtener su identificador para la API local.
Cola de acciones
| Comando | Nombre en selectores | Valor |
|---|---|---|
queue.cancelActive | Cancelar la acción en curso | Ninguno |
queue.clearPending | Limpiar acciones en espera | Ninguno |
queue.clearAll | Limpiar la cola de acciones | Ninguno |
Texto a voz
| Comando | Nombre en selectores | Valor |
|---|---|---|
tts.skip | Omitir el mensaje de TTS | Ninguno |
tts.clear | Limpiar la cola de TTS | Ninguno |
tts.toggle | Activar o desactivar TTS | Ninguno |
Alertas
| Comando | Nombre en selectores | Valor |
|---|---|---|
alerts.skip | Alertas: omitir la alerta en pantalla | Ninguno |
alerts.pause | Alertas: pausar | Ninguno |
alerts.resume | Alertas: reanudar | Ninguno |
alerts.replay | Alertas: repetir | El ID de una alerta; vacío repite la última mostrada |
alerts.clear | Alertas: limpiar | Ninguno |
Todas las fuentes de alertas abiertas en OBS obedecen a estos comandos.
Lanzamientos
| Comando | Nombre en selectores | Valor |
|---|---|---|
throw.items | Lanzar objetos | JSON, con los mismos campos que un paso de Lanzar objetos |
throw.clear | Limpiar objetos | Ninguno |
throw.clear elimina todos los objetos lanzados de OBS y de la vista previa, y detiene los combos
que se estén lanzando en ese momento.
VTube Studio
| Comando | Nombre en selectores | Valor |
|---|---|---|
vts.reconnect | Reconectar VTube Studio | Ninguno |
Temporizador
| Comando | Nombre en selectores | Valor |
|---|---|---|
timer.start | Temporizador: iniciar | Ninguno |
timer.pause | Temporizador: pausar | Ninguno |
timer.reset | Temporizador: restablecer | Ninguno |
timer.add | Temporizador: añadir segundos | Segundos |
timer.set | Temporizador: fijar segundos | Segundos, 0 o más |
timer.toggleMode | Temporizador: cuenta ascendente o descendente | Ninguno |
timer.add y timer.set también aceptan {"seconds":30}, y rechazan cualquier valor superior a un año.
Juegos
| Comando | Nombre en selectores | Valor |
|---|---|---|
wheel.spin | Girar la ruleta | Ninguno |
giftJar.clear | Vaciar frasco de regalos | Ninguno |
poll.start | Iniciar nueva encuesta | Ninguno |
poll.close | Cerrar encuesta | Ninguno |
viewerQueue.next | Siguiente espectador | Ninguno |
viewerQueue.clear | Limpiar cola | Ninguno |
viewerQueue.toggle | Abrir / cerrar cola | Ninguno |
giveaway.open | Abrir inscripciones | Ninguno |
giveaway.close | Cerrar inscripciones | Ninguno |
giveaway.draw | Sortear ganador | Ninguno |
giveaway.reset | Restablecer sorteo | Ninguno |
giveaway.clearWinners | Olvidar ganadores anteriores | Ninguno |
tugOfWar.start | Iniciar ronda | Ninguno |
tugOfWar.stop | Terminar ronda ahora | Ninguno |
tugOfWar.reset | Restablecer ronda | Ninguno |
hypeMeter.boost | Impulsar hype | Una cantidad; 50 cuando está vacío |
hypeMeter.reset | Restablecer hype | Ninguno |
Mientras Vfinity esté pausado, Sortear ganador, Iniciar ronda e Impulsar hype se rechazan indicando el motivo, y la ruleta no gira.
Overlays
| Comando | Nombre en selectores | Valor |
|---|---|---|
sceneCard.showStarting | Tarjeta de escena: mostrar Empezamos pronto | Ninguno |
sceneCard.showBrb | Tarjeta de escena: mostrar Ahora vuelvo | Ninguno |
sceneCard.showEnding | Tarjeta de escena: mostrar Fin del directo | Ninguno |
sceneCard.hide | Tarjeta de escena: ocultar | Ninguno |
sceneCard.countdownStart | Tarjeta de escena: iniciar la cuenta atrás | Ninguno |
sceneCard.countdownStop | Tarjeta de escena: detener la cuenta atrás | Ninguno |
checklist.checkNext | Lista de tareas: marcar el siguiente | Ninguno |
checklist.uncheckAll | Lista de tareas: desmarcar todos | Ninguno |
buddies.clear | Quitar los compañeros de chat | Ninguno |
Mostrar una escena activa la Tarjeta de escena, y cada tarjeta cuenta atrás desde sus propios Minutos. Desde un atajo, un paso o la API, estos comandos actúan sobre el widget y sus copias: una copia que hayas desactivado se queda desactivada, aunque sigue la escena, y los comandos de la lista de tareas solo marcan las copias que muestran la misma lista. Si los ejecutas desde el menú de clic derecho de una tarjeta en la pestaña Overlay, solo actúan sobre esa tarjeta.
Estadísticas
| Comando | Nombre en selectores | Valor |
|---|---|---|
stats.resetSession | Restablecer sesión | Ninguno |
Restablecer sesión reinicia los totales y las tablas de clasificación de la transmisión actual. Los totales históricos y los saldos de puntos se conservan.
Metas
| Comando | Nombre en selectores | Valor |
|---|---|---|
goal.reset | Restablecer una meta | El ID del widget de meta, como goal1 |
goal.add | Sumar a una meta | JSON: {"id":"goal1","amount":5} |
Otros
| Comando | Nombre en selectores | Valor |
|---|---|---|
triggers.reset | Restablecer hitos de disparadores e historial de primer chat | Ninguno |
tiktok.connect | tiktok.connect | JSON opcional: {"username":"…","autoRejoin":true,"waitForLive":true} |
tiktok.disconnect | tiktok.disconnect | Ninguno |
tiktok.cancelRejoin | tiktok.cancelRejoin | Ninguno |
tiktok.connect responde en cuanto se acepta la solicitud, antes de haberse unido al LIVE.
tiktok.cancelRejoin detiene la espera o la reconexión y deja conectada una sala a la que ya se haya unido.
Tu script
POST /api/trigger
Host: 127.0.0.1:21424
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
{
"name": "hype",
"data": {
"name": "mochi"
}
}{"ok":true}Eventos
Disparador de API
hype
POST /api/trigger ejecuta cada asignación cuyo disparador de API tenga ese nombre.
Los comandos de ventana propios de Vfinity, como salir de la aplicación, no pueden ejecutarse desde el exterior del programa.