Steuer-API und Stream Deck
ab ProÜber die Steuer-API lösen das Stream Deck und eigene Skripte Aktionen im Studio aus, zum Beispiel einen Zähler erhöhen, einen Countdown starten oder ein Overlay ausblenden.
Stream Deck einrichten
- Öffne im Stream Deck bei einer Riwius-Taste Verbindung und wähle Mit Code koppeln. Das Plugin zeigt einen Code.
- Klicke hier unter Alle Zugänge auf + Neuer Zugang. Gib bei Code vom Stream Deck den Code ein, vergib einen Name, wähle die Bereiche und klicke Anlegen. Im Browser öffnen im Plugin trägt den Code schon ein und wählt alle Bereiche vor.
- Nach wenigen Sekunden ist das Stream Deck verbunden. Ziehe Aktionen auf die Tasten.
Tasten belegen
Ziehe in der Stream-Deck-App eine Aktion aus der Kategorie Riwius auf eine freie Taste und stelle sie darunter ein. Mit Server-Befehl wählst du einen Server-Befehl aus der Liste und trägst bei Argumente den Rest ein, zum Beispiel bei !timer den Namen eines Countdowns. Das geht für Goal, Scoreboard, Win-Challenge, Bingo, Giveaway, Clip-Battle, Rangliste, Tickets, WASD, Countdown und Glücksrad. Für Zähler, Overlays, Actionboard, Leuchten, Stream-Marker, OBS-Szenen, Quellen, Filter und Spotify gibt es eigene Aktionen. Jetzt auslösen probiert eine Taste aus.
Für eigene Skripte legst du einen Zugang ohne Code an, wählst bei Gültig die Laufzeit und kopierst den Token. Er ist nur einmal sichtbar.
Funktions-Aktion
Mit der Taste Funktions-Aktion löst das Stream Deck jede Aktion aus, die auf der Seite einer Funktion unter Auslöser in der Kachel Fernsteuern steht. Wähle in den Einstellungen der Taste die Funktion und ihre Aktion. Darunter stehen die Felder der Aktion, zum Beispiel welcher Countdown startet. Leere Felder nehmen ihren Standard. Fragt die Aktion nach Leuchten, hakst du die gewünschten an. Ohne Haken gilt sie für alle Leuchten.
Der Zugang braucht dafür den Bereich Funktions-Aktionen. Geheime Werte wie ein Discord-Webhook gehen über die Steuer-API nicht. Lege für solche Aktionen eine Regel an.
Fernsteuern einer Funktion
Auf der Seite jeder Funktion mit Aktionen steht im Reiter Auslöser die Kachel Fernsteuern. Klicke bei einer Aktion auf Anleitung. Dort stehen ihre Felder, die Schritte für die Stream-Deck-Taste und die fertige Anfrage an die Steuer-API. Die Anfrage übernimmt die Werte aus den Feldern. Kopieren legt sie in die Zwischenablage. Ersetze darin rwc_… durch den Token deines Zugangs.
Fernsteuern eines Overlays
Leinwände und eigene Overlays mit Aktionen haben dieselbe Kachel Fernsteuern im Reiter Auslöser. Je Aktion, zum Beispiel Einblenden, steht dort ▶ Ausprobieren und die Anleitung. Im Stream Deck nimmst du dafür die Taste Overlay, wählst das Overlay, bei Wirkung „Aktion auslösen“ und die Aktion. Der Zugang braucht den Bereich Overlay-Einstellungen.
Sicherheit
Jeder Zugang steuert nur die freigegebenen Bereiche. Ein Bereich mit „(ab Unlimited)“ lässt sich schon freigeben, wirkt aber erst mit diesem Tarif. Gespeichert wird nur ein Fingerabdruck des Tokens. Unter Alle Zugänge siehst du, wann ein Zugang zuletzt benutzt wurde. Bearbeiten ändert Name und Bereiche, der Token bleibt gleich. Einen verlorenen Zugang widerrufst du im Menü ⋯ am Zugang mit Widerrufen.
Was du siehst„Den Code gibt es nicht oder er ist abgelaufen.“
- Woran es liegt
Der Code ist älter als 10 Minuten oder schon benutzt.
- Was hilft
Im Plugin neu koppeln.
Was du siehst„Stream Deck gibt es schon.“
- Woran es liegt
Ein Zugang hat schon diesen Namen.
- Was hilft
Einen anderen Namen wählen.
Was du siehst„Höchstens 20 Zugänge.“
- Woran es liegt
Die Grenze ist erreicht. Abgelaufene Zugänge zählen mit.
- Was hilft
Alte Zugänge widerrufen.
Was du siehstDas Plugin zeigt „abgewiesen“
- Woran es liegt
Der Zugang wurde widerrufen oder ist abgelaufen.
- Was hilft
Im Plugin neu koppeln.
Was du siehst„Dieser Zugang hat den Bereich X nicht.“
- Woran es liegt
Der Bereich wurde beim Anlegen nicht gewählt.
- Was hilft
Den Zugang mit Bearbeiten ergänzen. Der Token bleibt gleich.
Was du siehst„Befehl gibt es über die API nicht.“
- Woran es liegt
Eigene Chat-Befehle,
!join, Tribunal und Spotify-Befehle gehen nicht als Server-Befehl.- Was hilft
Für Tribunal und Spotify die eigenen Aktionen nehmen, für den Rest eine Funktions-Aktion oder Regel.
Was du siehst„Kein Govee-Schlüssel hinterlegt.“
- Woran es liegt
Kein Schlüssel unter Verbindungen, oder dein Tarif ist kleiner als Unlimited.
- Was hilft
Schlüssel unter Verbindungen prüfen und den Tarif ansehen.
Wie es arbeitet
- Koppeln: Das Plugin holt einen Code, der 10 Minuten gilt. Legst du damit einen Zugang an, bekommt das Plugin den Token genau einmal. Im Studio erscheint er nie.
- Token: ein langer Zufallsschlüssel. Der Server speichert nur einen Fingerabdruck davon und den Anfang zum Wiedererkennen.
- Jeder Aufruf prüft den Zugang und den Bereich. Widerrufen wirkt sofort.
- Jede Änderung über die Steuer-API steht in der Team-Aktivität mit „API:“ und dem Namen des Zugangs.
- Stream Deck: Das Plugin fragt alle paar Sekunden den Stand ab, zum Beispiel für leuchtende Tasten. Ist der Server nicht erreichbar, wartet es kurz und versucht es erneut.
- Funktions-Aktion:
%user%ist der Name des Zugangs. Leere Felder nehmen ihren Standard.
Grenzen und Zahlen
| Was | Wert |
|---|---|
| Zugänge | höchstens 20, auch abgelaufene zählen |
| Name | 60 Zeichen, je Kanal einmalig |
| Gültig | unbegrenzt, 30 Tage, 90 Tage oder 1 Jahr |
| Kopplungscode | 10 Minuten |
| Aufrufe | 120 je Minute und Zugang |
| Fehlversuche | nach 10 falschen Tokens 15 Minuten Sperre |
| Argumente / Marker-Text | 500 / 140 Zeichen |
| Plugin | Windows 10 oder neuer, Stream Deck ab 6.5 |
Die Steuer-API gibt es ab Pro, Spotify ebenfalls, Leuchten ab Unlimited. Zugänge anlegen darf nur der Kanalinhaber.
Zusammenspiel
- Fernsteuern: Die Funktions-Aktion nutzt dieselben Aktionen wie die Kachel Fernsteuern einer Funktion und die Regeln. Mehr unter Regeln & Variablen.
- OBS: Szenen, Quellen und Filter laufen über das OBS-Plugin. Mehr unter OBS-Plugin.
- Server-Befehle: dieselben wie im Chat. Mehr unter Chat-Befehle.