Zaloguj się

Bitfocus Companion

Steruj Cliqerem z Bitfocus Companion za pomocą wbudowanego modułu Cliqer, który instaluje się automatycznie i jest od razu gotowy do użycia.

Cliqer integruje się z Bitfocus Companion, popularnym oprogramowaniem open source do sterowania przyciskami w produkcji na żywo. Moduł Cliqer jest instalowany automatycznie, gdy Cliqer wykryje Companion w Twoim systemie, więc nie musisz niczego konfigurować ręcznie.

Automatyczna instalacja: Moduł Cliqer jest dołączony do aplikacji i przy uruchomieniu trafia do folderu modułów Companion. Gdy pojawi się nowsza wersja, aplikacja aktualizuje go na miejscu.
Dostępność: Moduł (v1.2.2) jest dostarczany razem z aplikacją desktopową Cliqer.

Jak to działa

Cliqer uruchamia dwa serwery loopback, z którymi łączy się moduł: API akcji HTTP na 127.0.0.1:24601 do obsługi akcji przycisków oraz WebSocket na 127.0.0.1:9052, który na bieżąco przesyła aktualizacje timera i stan aplikacji na potrzeby feedbacków i zmiennych.

Ten sam komputer: Oba serwery działają wyłącznie w trybie loopback, więc Companion musi działać na tym samym komputerze co Cliqer, aby akcje były wykonywane, a feedbacki się aktualizowały.

Konfiguracja

Zainstaluj Companion

Zainstaluj Bitfocus Companion i uruchom go co najmniej raz

Uruchom Cliqer

Uruchom Cliqer: umieści on moduł Cliqer w folderze modułów Companion

Dodaj połączenie Cliqer

Uruchom ponownie Companion, aby wczytał moduł, a następnie dodaj połączenie Cliqer (wskazuje na 127.0.0.1, port API akcji 24601)

Automatyczne aktualizacje: Przy każdym uruchomieniu Cliqer sprawdza, czy dołączono do niego nowszą wersję modułu, i aktualizuje folder modułów na miejscu. Jeśli Companion trzyma bieżący moduł otwarty, odświeżenie zostaje przełożone na kolejne uruchomienie, zamiast zostać zapisane tylko w połowie.

Dostępne akcje

Moduł udostępnia 19 akcji pogrupowanych według kategorii:

KategoriaAkcje
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 minut)
CallersCaller to Program (wybór rozmówcy 1-9), Clear Program (przejście do czerni)
ControlStop Screen Share, Toggle Program NDI Output, Toggle Timer NDI Output
Jak działają presety: Cztery akcje presetów wysyłają stałe czasy trwania: 5, 10, 15 i 20 minut. Cliqer wybiera pasujący preset w panelu Timer, jeśli skonfigurowano go dla tej liczby minut, a w przeciwnym razie ustawia timer bezpośrednio na ten czas.
Akcje rozmówców, udostępniania i NDI działają na hoście prezentacji. Wprowadzenie rozmówcy na program, czyszczenie programu, zatrzymanie udostępniania i przełączniki NDI są wykonywane w aplikacji Cliqer na tym komputerze, a akcje rozmówców wymagają planu ze sterowaniem Studio. Akcja, która nie ma na czym zadziałać, zwraca sukces i nic nie robi.

Feedbacki

Feedbacki zmieniają wygląd przycisku na podstawie bieżącego stanu. Moduł definiuje 11 feedbacków:

FeedbackAktywny, gdy
Timer RunningTimer aktywnie odlicza czas
Timer StoppedTimer jest wstrzymany
Timer Green (Talk Phase)Timer działa i zostało jeszcze sporo czasu
Timer OvertimeTimer w trybie odliczania przekroczył 0:00
Timer Yellow (Warning Phase)Timer zbliża się do limitu lub jest wstrzymany
Timer Red Flash (At Zero / Overtime)Miga, gdy timer dochodzi do zera / przekracza czas
Caller On Air (Program)Wybrany rozmówca jest na żywo na szynie programu
Caller ConnectedW wybranym slocie rozmówcy jest połączony rozmówca
Screen Share ActiveUdostępniany ekran jest na sygnale programu
Program NDI Output ActiveWyjście NDI programu jest włączone
Timer NDI Output ActiveWyjście NDI timera jest włączone

Zmienne

Moduł udostępnia 14 zmiennych do użycia w tekście przycisków i wyzwalaczach. Odwołuj się do nich przez etykietę połączenia, na przykład $(Cliqer:timer_display), gdy połączenie nazywa się Cliqer:

ZmiennaOpisPrzykład
timer_displayBieżąca wartość timera (MM:SS)14:30
timer_minutesMinuty14
timer_secondsSekundy30
timer_stateStan timerarunning / stopped
preset1_label … preset4_labelCzasy trwania presetów (MM:SS)05:00
program_callerImię rozmówcy, który jest obecnie na programieJane
callers_countPołączeni rozmówcy3
viewers_countPubliczność / widzowie128
presenters_countPołączeni prezenterzy2
room_idID bieżącego pokojuABC123
room_urlLink do pokoju do udostępnieniahttps://cliqer.io/ABC123

Presety

Moduł zawiera gotowe presety przycisków, dzięki którym zbudujesz powierzchnię sterującą metodą przeciągnij i upuść. Są pogrupowane w tych samych kategoriach co akcje: Click, Timer, Presets, Callers i Control. Upuść je na stronę Companion, aby od razu sterować slajdami, timerem, rozmówcami i wyjściami.

Obsługiwane platformy

PlatformaLokalizacja automatycznej instalacji
macOS~/Library/Application Support/companion/modules/
Windows%APPDATA%\companion\modules\

Moduł jest umieszczany w folderze cliqer-cliqer-<version> w tym katalogu (na przykład cliqer-cliqer-1.2.2). Gdy Cliqer instaluje aktualizację, najpierw usuwa folder poprzedniej wersji, więc zostaje tylko bieżąca wersja.

Rozwiązywanie problemów

Moduł nie pojawia się w Companion

  • Upewnij się, że Companion jest zainstalowany i został uruchomiony co najmniej raz przed Cliqerem
  • Companion skanuje folder modułów tylko przy starcie, więc po pierwszym uruchomieniu Cliqera uruchom ponownie Companion, a pojawi się typ połączenia Cliqer
  • Przycisk Refresh modules w Companion odświeża jego sklep online, a nie lokalny folder modułów, więc aby zobaczyć świeżo zainstalowany moduł, uruchom ponownie Companion

Akcje nie są wykonywane

  • Sprawdź, czy połączenie wskazuje na 127.0.0.1 i port API akcji 24601
  • Zachowaj domyślny port modułu: Cliqer udostępnia API akcji na porcie 24601
  • Lokalne porty na danym komputerze może zajmować tylko jedna instancja Cliqera, zobacz uwagi dotyczące Stream Deck

Feedbacki timera lub zmienne się nie aktualizują

  • Strumień bieżącego timera i stanu aplikacji korzysta z WebSocketu loopback na porcie 9052, więc Companion musi działać na tym samym komputerze co Cliqer
  • Akcje slajdów i timera mogą nadal działać przez HTTP, nawet gdy strumień nie jest połączony, więc jeśli przyciski działają, a feedbacki się nie zmieniają, sprawdź stan połączenia w Companion

Zobacz też: Integracja ze Stream Deck · Timer