Bitfocus Companion
Cliqer は、ライブ制作向けの人気オープンソースボタン制御ソフトウェア Bitfocus Companion と連携します。Cliqer がシステム上で Companion を検出すると Cliqer モジュールが自動でインストールされるため、手動での設定は不要です。
仕組み
Cliqer は、モジュールの接続先となるループバックサーバーを 2 つ実行します。ボタンアクション用の 127.0.0.1:24601 の HTTP アクション API と、フィードバックや変数のためにライブのタイマー更新とアプリの状態をストリーミングする 127.0.0.1:9052 の WebSocket です。
セットアップ
Companion をインストール
Bitfocus Companion をインストールし、少なくとも一度起動します
Cliqer を起動
Cliqer を起動すると、Cliqer モジュールが Companion のモジュールフォルダーに配置されます
Cliqer 接続を追加
Companion を一度再起動してモジュールを読み込ませてから、Cliqer 接続を追加します（接続先は 127.0.0.1、アクション API ポートは 24601）
利用できるアクション
このモジュールには、カテゴリー別に分類された 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 |
フィードバック
フィードバックは、ライブの状態に応じてボタンの外観を変化させます。このモジュールには 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) | 選択したコーラーがプログラムバスでオンエア中 |
| Caller Connected | 選択したコーラースロットに接続中のコーラーがいる |
| Screen Share Active | 画面共有がプログラムフィードに出ている |
| Program NDI Output Active | プログラムの NDI 出力がオン |
| Timer NDI Output Active | タイマーの NDI 出力がオン |
変数
このモジュールは、ボタンのテキストやトリガーで使える 14 個の変数を公開しています。変数は接続ラベルで参照します。たとえば、接続名が Cliqer の場合は $(Cliqer:timer_display) となります。
| 変数 | 説明 | 例 |
|---|---|---|
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 | 現在プログラムに出ているコーラーの名前 | Jane |
callers_count | 接続中のコーラー数 | 3 |
viewers_count | 聴衆・視聴者数 | 128 |
presenters_count | 接続中の発表者数 | 2 |
room_id | 現在のルーム 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 はモジュールフォルダーを起動時にしかスキャンしません。Cliqer の初回起動後に Companion を一度再起動すると、Cliqer 接続タイプが表示されます
- Companion の Refresh modules ボタンは、ローカルのモジュールフォルダーではなくオンラインストアを更新するものです。新しくインストールしたモジュールを表示するには、Companion を再起動してください
アクションが実行されない
- 接続先が、アクション API ポート
24601の127.0.0.1になっていることを確認してください - モジュールのデフォルトポートは変更しないでください。Cliqer はアクション API を
24601で提供しています - 1 台のマシンでローカルポートを使用できる Cliqer インスタンスは 1 つだけです。Stream Deck に関する注意事項を参照してください
タイマーのフィードバックや変数が更新されない
- ライブのタイマーとアプリ状態のフィードはポート
9052のループバック WebSocket を使用するため、Companion は Cliqer と同じコンピューターで実行する必要があります - フィードが接続されていなくても、スライドとタイマーのアクションは HTTP 経由で成功することがあります。ボタンは動作するのにフィードバックが変化しない場合は、Companion で接続ステータスを確認してください
関連項目：Stream Deck との連携 · Timer