Bitfocus Companion

שליטה ב-Cliqer מתוך Bitfocus Companion באמצעות מודול Cliqer המובנה, שמותקן אוטומטית ומוכן לשימוש.

שליטה ב-Cliqer ממשטחי הבקרה של Bitfocus Companion

Cliqer משתלב עם Bitfocus Companion, תוכנת הקוד הפתוח הפופולרית לשליטה באמצעות כפתורים בהפקות חיות. מודול Cliqer מותקן אוטומטית כש-Cliqer מזהה את Companion במערכת, כך שאין צורך בשום הגדרה ידנית.

התקנה אוטומטית: מודול Cliqer מגיע כחלק מהאפליקציה ומועתק לתיקיית המודולים של Companion בעת ההפעלה. כשיוצאת גרסה חדשה יותר, האפליקציה מעדכנת אותו במקום.

זמינות: המודול (v1.2.2) מגיע עם אפליקציית Cliqer למחשב.

איך זה עובד

Cliqer מפעיל שני שרתי loopback שהמודול מתחבר אליהם: API פעולות HTTP בכתובת 127.0.0.1:24601 עבור פעולות הכפתורים, ו-WebSocket בכתובת 127.0.0.1:9052 שמשדר עדכוני טיימר חיים ואת מצב האפליקציה עבור משובים ומשתנים.

אותו מחשב: שני השרתים פועלים ב-loopback בלבד, ולכן Companion חייב לרוץ על אותו מחשב שבו פועל Cliqer כדי שפעולות יופעלו ומשובים יתעדכנו.

הגדרה

התקנת Companion

יש להתקין את Bitfocus Companion ולהפעיל אותו לפחות פעם אחת

הפעלת Cliqer

יש להפעיל את Cliqer, והוא מעתיק את מודול Cliqer לתיקיית המודולים של Companion

הוספת חיבור Cliqer

יש להפעיל מחדש את Companion פעם אחת כדי שיזהה את המודול, ולאחר מכן להוסיף חיבור Cliqer (הוא מצביע על 127.0.0.1, פורט API הפעולות 24601)

עדכונים אוטומטיים: בכל הפעלה, Cliqer בודק אם מצורפת אליו גרסת מודול חדשה יותר ומעדכן את תיקיית המודולים במקום. אם Companion מחזיק את המודול הנוכחי פתוח, הרענון נדחה להפעלה מאוחרת יותר ואינו נשאר כתוב למחצה.

פעולות זמינות

המודול מספק 19 פעולות, מקובצות לפי קטגוריה:

קטגוריה	פעולות
Click	Left Click, Right Click
Timer	Start / Pause Timer, Reset Timer, +1 / +2 / +5 Minutes, −1 / −2 / −5 Minutes
Presets	Timer Preset 1 / 2 / 3 / 4 (5, 10, 15, 20 דקות)
Callers	Caller to Program (בחירת מתקשר 1-9), Clear Program (מעבר למסך שחור)
Control	Stop Screen Share, Toggle Program NDI Output, Toggle Timer NDI Output

איך פריסטים נקבעים: ארבע פעולות הפריסט שולחות משכי זמן קבועים של 5, 10, 15 ו-20 דקות. Cliqer בוחר את הפריסט התואם בחלונית Timer כשמוגדר בה פריסט לאותו מספר דקות, ואחרת הוא מגדיר את הטיימר ישירות למשך הזמן הזה.

פעולות המתקשרים, השיתוף וה-NDI פועלות על מארח המצגת. העברת מתקשר ל-Program, ניקוי ה-Program, עצירת שיתוף ומתגי ה-NDI פועלים מול אפליקציית Cliqer במחשב הזה, ופעולות המתקשרים דורשות מסלול הכולל שליטת Studio. פעולה שאין לה על מה לפעול מחזירה הצלחה ואינה עושה דבר.

משובים

משובים משנים את מראה הכפתור בהתאם למצב החי. המודול מגדיר 11 משובים:

משוב	מתקיים כאשר
Timer Running	הטיימר סופר באופן פעיל
Timer Stopped	הטיימר מושהה
Timer Green (Talk Phase)	הטיימר פועל ונותר זמן בשפע
Timer Overtime	הטיימר עבר את 0:00 במצב ספירה לאחור
Timer Yellow (Warning Phase)	הטיימר מתקרב למגבלה שלו, או שהוא מושהה
Timer Red Flash (At Zero / Overtime)	מהבהב כשהטיימר מגיע לאפס / נכנס לחריגת זמן
Caller On Air (Program)	המתקשר שנבחר משודר חי בערוץ ה-Program
Caller Connected	למשבצת המתקשר שנבחרה מחובר מתקשר
Screen Share Active	שיתוף מסך מוצג בשידור ה-Program
Program NDI Output Active	פלט ה-NDI של ה-Program פעיל
Timer NDI Output Active	פלט ה-NDI של הטיימר פעיל

משתנים

המודול חושף 14 משתנים לשימוש בטקסט של כפתורים ובטריגרים. יש להפנות אליהם לפי תווית החיבור, לדוגמה $(Cliqer:timer_display) כשהחיבור נקרא Cliqer:

משתנה	תיאור	דוגמה
`timer_display`	ערך הטיימר הנוכחי (MM:SS)	`14:30`
`timer_minutes`	רכיב הדקות	`14`
`timer_seconds`	רכיב השניות	`30`
`timer_state`	מצב הטיימר	`running` / `stopped`
`preset1_label` … `preset4_label`	משכי הפריסטים (MM:SS)	`05:00`
`program_caller`	שם המתקשר שנמצא כעת ב-Program	`Jane`
`callers_count`	מתקשרים מחוברים	`3`
`viewers_count`	קהל / צופים	`128`
`presenters_count`	מציגים מחוברים	`2`
`room_id`	מזהה החדר הנוכחי	`ABC123`
`room_url`	קישור לחדר שאפשר לשתף	`https://cliqer.io/ABC123`

פריסטים

המודול כולל פריסטים מוכנים של כפתורים, כך שאפשר לבנות משטח בקרה בגרירה בלבד, והם מקובצים לפי אותן קטגוריות כמו הפעולות: Click, Timer, Presets, Callers ו-Control. אפשר לשחרר אותם על עמוד ב-Companion ולקבל מיד שליטה בשקופיות, בטיימר, במתקשרים ובפלטים.

תמיכה בפלטפורמות

פלטפורמה	מיקום ההתקנה האוטומטית
macOS	`~/Library/Application Support/companion/modules/`
Windows	`%APPDATA%\companion\modules\`

המודול ממוקם בתיקייה cliqer-cliqer-<version> בתוך התיקייה הזו (לדוגמה cliqer-cliqer-1.2.2). כש-Cliqer מתקין עדכון, הוא מסיר קודם את תיקיית הגרסה הקודמת, כך שנשארת רק הגרסה הנוכחית.

פתרון בעיות

המודול לא מופיע ב-Companion

יש לוודא ש-Companion מותקן והופעל לפחות פעם אחת לפני Cliqer
Companion סורק את תיקיית המודולים שלו רק בעת ההפעלה, ולכן יש להפעיל מחדש את Companion פעם אחת אחרי ההפעלה הראשונה של Cliqer, וסוג החיבור Cliqer יופיע
הכפתור Refresh modules ב-Companion מרענן את החנות המקוונת שלו, לא את תיקיית המודולים המקומית, ולכן יש להפעיל מחדש את Companion כדי שמודול שהותקן זה עתה יופיע

הפעולות לא מופעלות

יש לוודא שהחיבור מכוון ל-127.0.0.1 בפורט API הפעולות 24601
יש להשאיר את פורט ברירת המחדל של המודול: Cliqer מספק את API הפעולות בפורט 24601
רק מופע אחד של Cliqer יכול להחזיק את הפורטים המקומיים במחשב, ראו ההערות על Stream Deck

משובי הטיימר או המשתנים לא מתעדכנים

עדכוני הטיימר החי ומצב האפליקציה עוברים דרך ה-WebSocket ב-loopback בפורט 9052, ולכן Companion חייב לרוץ על אותו מחשב שבו פועל Cliqer
פעולות שקופיות וטיימר עדיין יכולות להצליח דרך HTTP גם כשערוץ העדכונים לא מחובר, ולכן אם הכפתורים מופעלים אבל המשובים נשארים סטטיים, יש לבדוק את מצב החיבור ב-Companion

ראו גם: שילוב עם Stream Deck · Timer

Elgato Stream Deck

שליטה ב-Cliqer באמצעות Elgato Stream Deck דרך תוסף Elgato Stream Deck המצורף.

סקירת API

תיעוד API מלא לשילוב עם Cliqer