Anmelden

Bitfocus Companion

Steuern Sie Cliqer aus Bitfocus Companion mit dem integrierten Cliqer-Modul, das automatisch installiert wird und sofort einsatzbereit ist.

Cliqer lässt sich in Bitfocus Companion integrieren, die beliebte Open-Source-Software zur Tastensteuerung für Live-Produktionen. Das Cliqer-Modul wird automatisch installiert, sobald Cliqer Companion auf Ihrem System erkennt, eine manuelle Einrichtung entfällt also.

Automatische Installation: Das Cliqer-Modul ist in der App enthalten und wird beim Start im Modulordner von Companion abgelegt. Erscheint eine neuere Version, aktualisiert die App das Modul direkt an Ort und Stelle.
Verfügbarkeit: Das Modul (v1.2.2) wird mit der Cliqer-Desktop-App ausgeliefert.

So funktioniert es

Cliqer betreibt zwei Loopback-Server, mit denen sich das Modul verbindet: eine HTTP-Aktions-API auf 127.0.0.1:24601 für Tastenaktionen und einen WebSocket auf 127.0.0.1:9052, der Live-Timer-Updates und den App-Status für Feedbacks und Variablen streamt.

Derselbe Rechner: Beide Server sind ausschließlich über Loopback erreichbar, daher muss Companion auf demselben Computer wie Cliqer laufen, damit Aktionen ausgelöst und Feedbacks aktualisiert werden.

Einrichtung

Companion installieren

Installieren Sie Bitfocus Companion und starten Sie es mindestens einmal

Cliqer starten

Starten Sie Cliqer, es legt das Cliqer-Modul im Modulordner von Companion ab

Cliqer-Verbindung hinzufügen

Starten Sie Companion einmal neu, damit es das Modul erkennt, und fügen Sie dann eine Cliqer-Verbindung hinzu (sie verweist auf 127.0.0.1, Port der Aktions-API 24601)

Automatische Updates: Bei jedem Start prüft Cliqer, ob eine neuere Modulversion enthalten ist, und aktualisiert den Modulordner direkt an Ort und Stelle. Hält Companion das aktuelle Modul geöffnet, wird die Aktualisierung auf einen späteren Start verschoben, statt halb geschrieben zurückzubleiben.

Verfügbare Aktionen

Das Modul bietet 19 Aktionen, nach Kategorien gruppiert:

KategorieAktionen
ClickLeft Click, Right Click
TimerStart / Pause Timer, Reset Timer, +1 / +2 / +5 Minutes, −1 / −2 / −5 Minutes
PresetsTimer Preset 1 / 2 / 3 / 4 (5, 10, 15, 20 Minuten)
CallersCaller to Program (Anrufer 1-9 wählen), Clear Program (Schnitt auf Schwarz)
ControlStop Screen Share, Toggle Program NDI Output, Toggle Timer NDI Output
So werden Presets aufgelöst: Die vier Preset-Aktionen senden feste Dauern von 5, 10, 15 und 20 Minuten. Cliqer wählt das passende Preset in Ihrem Timer-Panel aus, wenn eines für diese Minutenzahl konfiguriert ist, andernfalls stellt es den Timer direkt auf diese Dauer ein.
Anrufer-, Freigabe- und NDI-Aktionen wirken auf den Präsentations-Host. Einen Anrufer auf das Programm schalten, das Programm leeren, eine Freigabe beenden und die NDI-Umschalter werden in der Cliqer-App auf diesem Rechner ausgeführt, und die Anrufer-Aktionen erfordern einen Plan mit Studio-Steuerung. Eine Aktion ohne Ziel meldet Erfolg und bewirkt nichts.

Feedbacks

Feedbacks ändern das Aussehen einer Taste anhand des Live-Status. Das Modul definiert 11 Feedbacks:

FeedbackAktiv, wenn
Timer RunningDer Timer aktiv zählt
Timer StoppedDer Timer pausiert ist
Timer Green (Talk Phase)Der Timer läuft und noch reichlich Zeit bleibt
Timer OvertimeDer Timer im Countdown-Modus 0:00 überschritten hat
Timer Yellow (Warning Phase)Der Timer sich seinem Limit nähert oder pausiert ist
Timer Red Flash (At Zero / Overtime)Blinkt, wenn der Timer null erreicht bzw. in die Überziehung läuft
Caller On Air (Program)Der ausgewählte Anrufer live auf dem Program-Bus ist
Caller ConnectedAuf dem ausgewählten Anrufer-Slot ein Anrufer verbunden ist
Screen Share ActiveEine Bildschirmfreigabe auf dem Program-Feed liegt
Program NDI Output ActiveDer Program-NDI-Ausgang eingeschaltet ist
Timer NDI Output ActiveDer Timer-NDI-Ausgang eingeschaltet ist

Variablen

Das Modul stellt 14 Variablen für Tastentexte und Trigger bereit. Sprechen Sie sie über die Verbindungsbezeichnung an, zum Beispiel $(Cliqer:timer_display), wenn die Verbindung Cliqer heißt:

VariableBeschreibungBeispiel
timer_displayAktueller Timerwert (MM:SS)14:30
timer_minutesMinutenanteil14
timer_secondsSekundenanteil30
timer_stateTimerstatusrunning / stopped
preset1_label … preset4_labelPreset-Dauern (MM:SS)05:00
program_callerName des Anrufers, der aktuell auf dem Programm istJane
callers_countVerbundene Anrufer3
viewers_countPublikum / Zuschauer128
presenters_countVerbundene Vortragende2
room_idAktuelle Raum-IDABC123
room_urlTeilbarer Raumlinkhttps://cliqer.io/ABC123

Presets

Das Modul enthält fertige Tasten-Presets, mit denen Sie per Drag-and-drop eine Bedienoberfläche aufbauen, gruppiert in dieselben Kategorien wie die Aktionen: Click, Timer, Presets, Callers und Control. Ziehen Sie sie auf eine Companion-Seite, um Folien, Timer, Anrufer und Ausgänge sofort zu steuern.

Plattformunterstützung

PlattformSpeicherort der automatischen Installation
macOS~/Library/Application Support/companion/modules/
Windows%APPDATA%\companion\modules\

Das Modul wird in einem Ordner cliqer-cliqer-<version> in diesem Verzeichnis abgelegt (zum Beispiel cliqer-cliqer-1.2.2). Wenn Cliqer ein Update installiert, entfernt es zuerst den Ordner der vorherigen Version, sodass nur die aktuelle Version übrig bleibt.

Fehlerbehebung

Modul erscheint nicht in Companion

  • Stellen Sie sicher, dass Companion installiert ist und vor Cliqer mindestens einmal gestartet wurde
  • Companion durchsucht seinen Modulordner nur beim Start, starten Sie Companion daher nach dem ersten Start von Cliqer einmal neu, dann erscheint der Verbindungstyp Cliqer
  • Die Schaltfläche Refresh modules in Companion aktualisiert den Online-Store, nicht den lokalen Modulordner, starten Sie Companion daher neu, damit ein frisch installiertes Modul angezeigt wird

Aktionen werden nicht ausgelöst

  • Prüfen Sie, ob die Verbindung auf 127.0.0.1 mit dem Aktions-API-Port 24601 zeigt
  • Behalten Sie den Standardport des Moduls bei: Cliqer stellt die Aktions-API auf 24601 bereit
  • Nur eine Cliqer-Instanz kann die lokalen Ports auf einem Rechner belegen, siehe die Hinweise zu Stream Deck

Timer-Feedbacks oder Variablen werden nicht aktualisiert

  • Der Live-Feed für Timer und App-Status nutzt den Loopback-WebSocket auf Port 9052, daher muss Companion auf demselben Computer wie Cliqer laufen
  • Folien- und Timer-Aktionen können über HTTP weiterhin erfolgreich sein, auch wenn der Feed nicht verbunden ist. Wenn Tasten also auslösen, Feedbacks aber statisch bleiben, prüfen Sie den Verbindungsstatus in Companion

Siehe auch: Stream-Deck-Integration · Timer