Bitfocus Companion
Cliqer s'intègre à Bitfocus Companion, le logiciel open source de contrôle par boutons très prisé en production live. Le module Cliqer est installé automatiquement dès que Cliqer détecte Companion sur votre système : aucune configuration manuelle n'est nécessaire.
Fonctionnement
Cliqer exécute deux serveurs en boucle locale auxquels le module se connecte : une API d'actions HTTP sur 127.0.0.1:24601 pour les actions des boutons, et un WebSocket sur 127.0.0.1:9052 qui diffuse en temps réel les mises à jour du minuteur et l'état de l'application pour les retours d'état et les variables.
Configuration
Installer Companion
Installez Bitfocus Companion et lancez-le au moins une fois
Lancer Cliqer
Lancez Cliqer : il dépose le module Cliqer dans le dossier des modules de Companion
Ajouter une connexion Cliqer
Redémarrez Companion une fois pour qu'il prenne en compte le module, puis ajoutez une connexion Cliqer (elle pointe vers 127.0.0.1, port de l'API d'actions 24601)
Actions disponibles
Le module propose 19 actions, regroupées par catégorie :
| Catégorie | Actions |
|---|---|
| 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 minutes) |
| Callers | Caller to Program (choix de l'intervenant 1-9), Clear Program (passage au noir) |
| Control | Stop Screen Share, Toggle Program NDI Output, Toggle Timer NDI Output |
Retours d'état
Les retours d'état modifient l'apparence d'un bouton en fonction de l'état en direct. Le module définit 11 retours d'état :
| Retour d'état | Vrai lorsque |
|---|---|
| Timer Running | Le minuteur est en train de décompter |
| Timer Stopped | Le minuteur est en pause |
| Timer Green (Talk Phase) | Le minuteur tourne avec du temps en réserve |
| Timer Overtime | Le minuteur a dépassé 0:00 en mode compte à rebours |
| Timer Yellow (Warning Phase) | Le minuteur approche de sa limite, ou est en pause |
| Timer Red Flash (At Zero / Overtime) | Clignote lorsque le minuteur atteint zéro / passe en dépassement |
| Caller On Air (Program) | L'intervenant sélectionné est à l'antenne sur le bus programme |
| Caller Connected | L'emplacement d'intervenant sélectionné a un intervenant connecté |
| Screen Share Active | Un partage d'écran est diffusé sur le flux programme |
| Program NDI Output Active | La sortie NDI programme est active |
| Timer NDI Output Active | La sortie NDI du minuteur est active |
Variables
Le module expose 14 variables utilisables dans le texte des boutons et les déclencheurs. Référencez-les par le libellé de la connexion, par exemple $(Cliqer:timer_display) lorsque la connexion s'appelle Cliqer :
| Variable | Description | Exemple |
|---|---|---|
timer_display | Valeur actuelle du minuteur (MM:SS) | 14:30 |
timer_minutes | Composante minutes | 14 |
timer_seconds | Composante secondes | 30 |
timer_state | État du minuteur | running / stopped |
preset1_label … preset4_label | Durées des préréglages (MM:SS) | 05:00 |
program_caller | Nom de l'intervenant actuellement au programme | Jane |
callers_count | Intervenants connectés | 3 |
viewers_count | Public / spectateurs | 128 |
presenters_count | Présentateurs connectés | 2 |
room_id | ID de la salle actuelle | ABC123 |
room_url | Lien de la salle à partager | https://cliqer.io/ABC123 |
Préréglages
Le module fournit des préréglages de boutons prêts à l'emploi pour composer une surface de contrôle par simple glisser-déposer, regroupés dans les mêmes catégories que les actions : Click, Timer, Presets, Callers et Control. Déposez-les sur une page Companion pour contrôler instantanément diapositives, minuteur, intervenants et sorties.
Plateformes prises en charge
| Plateforme | Emplacement d'installation automatique |
|---|---|
| macOS | ~/Library/Application Support/companion/modules/ |
| Windows | %APPDATA%\companion\modules\ |
Le module est placé dans un dossier cliqer-cliqer-<version> à l'intérieur de ce répertoire (par exemple cliqer-cliqer-1.2.2). Lorsque Cliqer installe une mise à jour, il supprime d'abord le dossier de la version précédente, afin que seule la version actuelle subsiste.
Dépannage
Le module n'apparaît pas dans Companion
- Vérifiez que Companion est installé et qu'il a été lancé au moins une fois avant Cliqer
- Companion n'analyse son dossier des modules qu'au démarrage : redémarrez donc Companion une fois après le premier lancement de Cliqer, et le type de connexion Cliqer apparaîtra
- Le bouton Refresh modules de Companion actualise sa boutique en ligne, pas le dossier local des modules : redémarrez Companion pour faire apparaître un module fraîchement installé
Les actions ne se déclenchent pas
- Vérifiez que la connexion cible
127.0.0.1sur le port de l'API d'actions24601 - Conservez le port par défaut du module : Cliqer expose l'API d'actions sur
24601 - Une seule instance de Cliqer peut occuper les ports locaux d'une machine, voir les notes sur Stream Deck
Les retours d'état ou les variables du minuteur ne se mettent pas à jour
- Le flux en direct du minuteur et de l'état de l'application utilise le WebSocket en boucle locale sur le port
9052: Companion doit donc tourner sur le même ordinateur que Cliqer - Les actions de diapositive et de minuteur peuvent toujours réussir via HTTP même lorsque le flux n'est pas connecté : si les boutons se déclenchent mais que les retours d'état restent figés, vérifiez l'état de la connexion dans Companion
Voir aussi : Intégration Stream Deck · Timer