Jeden przycisk, Twój własny przepływ

Zbuduj przepływ, który można wywołać

1. Nazwany wyzwalaczStream Deck / API
2. Warunki i akcjeTwój zapisany Event Flow
3. CelFlow Actions, OBS lub inna integracja

1. Otwórz Event Flow z SSN. Utwórz dedykowany przepływ lub wybierz szablon Przycisk Stream Deck / API .
2. Dodaj Uruchom ze Stream Deck / API w grupie wyzwalaczy Stream Deck i API .
3. Nadaj mu nazwę intermission. Nazwy muszą być identyczne i uwzględniają wielkość liter; użyj krótkiej opisowej nazwy.
4. Połącz jego wyjście z Pokaż tekst (Show Text). Ustaw tekst na Back in five minutes i wybierz żądany czas trwania oraz warstwę.
5. Zapisz przepływ, a następnie go włącz. Niezapisany przepływ istnieje tylko w edytorze; wyłączonego przepływu nie można wywołać. Szablon początkowy jest celowo wyłączony do ukończenia konfiguracji.
6. Otwórz swoją Nakładkę Flow Actions za pomocą linku wygenerowanego przez SSN. Dla odbiorców dodaj ten adres jako źródło przeglądarkowe OBS. Sam edytor nie jest nakładką.

Przepływów bez tego nazwanego wyzwalacza nie można wywołać przez API przepływów. Wywołanie przepływu nie wstrzykuje sztucznego czatu do doku. Istniejące zdarzenia OBS i zwykły czat nadal używają swoich obecnych wyzwalaczy.

Przepływ może łączyć nazwany wyzwalacz z filtrami przez węzły logiczne. Trzymaj niezwiązane automatyzacje w oddzielnych przepływach: wszystkie gałęzie wyzwalaczy i logiki w wybranym przepływie są oceniane dla zdarzenia API. Ponowne naciśnięcia rozpoczynają oddzielne wykonania; umieść Ogranicznik częstotliwości (Rate Limiter) węzeł stanu po wyzwalaczu, jeśli chcesz okresu oczekiwania.

Połącz klawisz Stream Deck

1. Skonfiguruj we wtyczce akcję Konfiguracja z sesją SSN i opcjonalnym hasłem. Użyj Testuj połączenie (Test Connection).
2. Przeciągnij Polecenie z presetu (Preset Command) na klawisz.
3. Wybierz Event Flow workflows → Run workflow.
4. Wybierz Odśwież przepływy (Refresh workflows), a następnie wybierz zapisany przepływ i wyzwalacz. Klawisz zapisuje zarówno identyfikator przepływu, jak i nazwę wyzwalacza.
5. Naciśnij raz i obserwuj nakładkę Flow Actions. Znacznik wyboru na klawiszu oznacza, że SSN przyjęło uruchomienie.

Selektor przepływów zachowuje brakujące wybory. Po zmianie nazwy, wyłączeniu, usunięciu lub zaimportowaniu przepływu odśwież listę i wybierz go ponownie. Przepływ zaimportowany jako nowy ma inny identyfikator. Zamiast tego użyj pola Value, aby wskazywać nazwę w kilku przepływach.

Własne polecenie (Custom Command): ustaw Action na triggerWorkflow, pozostaw Target puste, wpisz {"trigger":"intermission"} jako Value i włącz Czekaj na odpowiedź (Wait for response). Preset oferuje wybór z podpowiedziami i filtrowanie według możliwości.

Multi Actions: każde żądanie przepływu szybko potwierdza przyjęcie. Następny krok Stream Deck może się rozpocząć, zanim zakończą się opóźnione akcje przepływu. Gdy kolejność ma znaczenie, umieść sekwencjonowanie i opóźnienia wewnątrz Event Flow.

Przekaż własne wartości

W polu Value klawisza lub w żądaniu API:

{
  "trigger": "intermission",
  "flowId": "YOUR_SAVED_FLOW_ID",
  "data": { "name": "Back in five minutes", "minutes": 5 }
}

Ustaw Show Text na {meta.workflow.data.name}. Compare Property może odczytać meta.workflow.data.minutes. Data to opcjonalny obiekt JSON; pozostaje w meta.workflow.data i nie może zastąpić tożsamości zdarzenia ani nadać uprawnień czatu.

Pomiń flowId , aby wywołać każdy włączony przepływ z dokładnie tą nazwą wyzwalacza. Kilka pasujących węzłów wyzwalacza w jednym przepływie nadal powoduje ocenę tego przepływu tylko raz. Aby uruchomić tylko jeden przepływ, zachowaj jego identyfikator z selektora lub odpowiedzi wykrywania.

Zdarzenie używane wewnątrz wybranego przepływu ma type: "api", event: "workflow_trigger", chatname: "Stream Deck / API", puste chatmessage oraz powyższe dane. Zwykły czat, który skopiuje te pola, nie może aktywować nazwanego wyzwalacza API.

Przykłady API

Pozostaw SSN włączone i uruchomione. To wywołania zdalnego sterowania Social Stream; nie używają oddzielnego lokalnego API AI/MCP aplikacji SSApp. Zachowaj prywatność prawdziwego identyfikatora sesji.

Odkryj dostępne wyzwalacze

{"action":"getWorkflowTriggers","get":"list-1","apiid":"YOUR_SESSION"}

Odpowiedź zwrotna zawiera result.payload.triggers:

{"triggers":[{"flowId":"flow-123","flowName":"Intermission","trigger":"intermission"}]}

Uruchom nazwany przepływ

{
  "action": "triggerWorkflow",
  "value": {"trigger":"intermission","flowId":"flow-123","data":{"name":"Back shortly"}},
  "get": "run-1",
  "apiid": "YOUR_SESSION"
}

Używaj unikalnego get ciągu znaków dla każdego żądania. Udana odpowiedź zwrotna ma result.ok: true, result.status: "accepted" i result.payload.matchedFlows. Przyjęcie oznacza, że włączony przepływ został znaleziony i zaplanowany. Nie oznacza, że zakończyły się wszystkie opóźnione akcje, webhooki, wywołania OBS lub odtwarzanie multimediów.

WebSocket

Włącz zdalne sterowanie rozszerzeniem przez API w SSN. Połącz z wss://io.socialstream.ninja. Dołącz za pomocą {"join":"YOUR_SESSION","out":1,"in":2}, a następnie wyślij powyższe żądanie. Kanał 1 przenosi sterowanie; kanał 2 przenosi odpowiedzi zwrotne. Nie musisz włączać kanału czatu dla przepływów.

HTTP

Włącz to samo ustawienie zdalnego sterowania przez API. Przed użyciem zastąp wartość zastępczą sesji:

POST https://io.socialstream.ninja/YOUR_SESSION
Content-Type: application/json

{"action":"triggerWorkflow","value":{"trigger":"intermission","data":{"name":"Back shortly"}}}

W przypadku prostego nazwanego wyzwalacza możesz też użyć GET https://io.socialstream.ninja/YOUR_SESSION/triggerWorkflow/null/intermission. Czwarty segment ścieżki może zawierać JSON zakodowany dla URL do przekazywania wartości strukturalnych. Zakoduj całą wartość JSON za pomocą encodeURIComponent(JSON.stringify(value)). Niestandardowe kanały wysyłania używają ?channel=N.

P2P

Domyślny tryb P2P wtyczki wysyła te same dane przez istniejący transport kanału danych VDO.Ninja w SSN. Przełącznik hostowanego API WebSocket nie jest wymagany dla P2P. Istniejące klienty P2P powinny wysyłać to żądanie przez swoje nawiązane połączenie sterujące SSN; otwieranie lokalnego API AI nie jest wymagane.

Błędy i zgodność

• WORKFLOW_NOT_FOUND: żaden zapisany i włączony przepływ nie pasuje do wyzwalacza/identyfikatora przepływu.
• INVALID_VALUE: brakujący/nieprawidłowy wyzwalacz, błędny JSON, nieprawidłowy identyfikator przepływu lub dane niebędące obiektem.
• CONTROL_UNAVAILABLE: SSN lub zdalne sterowanie prowadzącego jest wyłączone.
• TARGET_UNAVAILABLE: Event Flow nadal się ładuje.
• Starsze zasoby Social Stream mogą nie ogłaszać tych akcji. Sprawdź getCapabilities → ssn.actions.triggerWorkflow i getWorkflowTriggers. Muszą być zainstalowane zarówno nowy wyzwalacz, jak i zaktualizowana wtyczka; sam numer wersji SSApp nie określa zdalnie ładowanych zasobów Social Stream.

Nie ponawiaj automatycznie wywołania zmieniającego stan po utracie potwierdzenia: przepływ mógł już ruszyć. Najpierw sprawdź jego wynik. To API nie zapewnia kolejki statusu wykonania.

Czego potrzebuje każda integracja

Pełny poradnik Event Flow · Przepisy · Dokumentacja API

Gesty timera i czatu

Zegar: domyślnie obróć o jeden skok, aby zmienić czas o ±10 sekund; przytrzymaj pokrętło wciśnięte podczas obracania , aby zmienić czas o ±1 minutę (6× skonfigurowany krok). Naciśnij i puść bez obracania, aby uruchomić/wstrzymać. Dotknij wyświetlacza timera, aby odświeżyć; przytrzymaj wyświetlacz , aby zresetować. Samo przytrzymanie fizycznego pokrętła nie resetuje.

Przegląd czatu (Chat Review): obróć w lewo, aby przeglądać starszy czat, w prawo, aby nowszy; naciśnij pokrętło, aby przypiąć przeglądaną wiadomość. Dotknij wyświetlacza, aby wyróżnić następną przypiętą wiadomość; przytrzymaj wyświetlacz, aby odpiąć przeglądaną wiadomość. Pozostaw domyślny dok otwarty. W trybie WebSocket włącz przekazywanie czatu na kanale 4.

Otwórz Help and diagnostics → Controls, icons and workflow guide we wtyczce, aby uzyskać pełny poradnik offline, wszystkie pięć typów akcji, każdy preset i ikonę, działanie resetowania, ustawienia domyślne oraz rozwiązywanie problemów.

Dokumentacja palety Event Flow

Paleta zawiera 45 wyzwalaczy, 67 akcji, pięć węzłów logicznych i cztery węzły stanu. Każdy wpis ma etykietę tekstową obok symbolu. Wybierz węzeł, aby zobaczyć jego ustawienia i wymagania integracji; ikona w palecie nie oznacza, że cel jest połączony.

Wyzwalacze określają, kiedy rozpoczyna się przepływ. W razie potrzeby łącz warunki za pomocą AND/OR. Akcje wykonują się w kolejności połączeń. Węzły stanu pamiętają wartości między zdarzeniami. Aby ustawić przerwę dla przycisku, wybierz Ogranicznik częstotliwości (Rate Limiter) (THROTTLE), a nie akcji Delay: Delay opóźnia każde uruchomienie i nie tłumi ponownych naciśnięć.

Filtry wiadomości, punkty widzów i akcje zapamiętanych użytkowników potrzebują rzeczywistych danych wiadomości/użytkownika. Przycisk prowadzącego nie dostarcza ani prawdziwego widza, ani celu odpowiedzi do źródła. Wybierz sterowanie prowadzącego lub jawnie skonfigurowany cel; nie używaj nazwanego przepływu do podszywania się pod widza.

Szczegóły łączenia: zobacz Poradnik Event Flow, poradnik węzłów stanu, poradnik pamięci użytkowników i poradnik OBS.

Rozwiąż problem krok po kroku

1. Najpierw użyj prostego przepływu Show Text i sprawdź jego wynik.
2. Zapisz i włącz; odśwież listę przepływów Stream Deck. Potwierdź nazwę wyzwalacza oraz identyfikator przepływu.
3. Sprawdź, czy SSN jest włączone, połączenie ma status Online, a docelowa nakładka jest połączona z tą samą sesją.
4. Sprawdź odpowiedź zwrotną API lub diagnostykę wtyczki pod kątem błędów wyszukiwania/walidacji. W przypadku błędów po przyjęciu sprawdź miejsce docelowe i dzienniki działania Event Flow.
5. Dodawaj kolejne integracje pojedynczo. Przed użyciem na żywo przetestuj ponowne naciśnięcia, wyłączony przepływ i ponowne połączenie.

Zwykły panel testowania czatu w edytorze wysyła zdarzenie czatu. Nie udaje nazwanego wyzwalacza API. Przetestuj ten wyzwalacz przez Stream Deck lub API, aby sprawdzić całą ścieżkę.