登录

Bitfocus Companion

借助内置的 Cliqer 模块,在 Bitfocus Companion 中控制 Cliqer,自动安装,开箱即用。

Cliqer 与 Bitfocus Companion 集成。Bitfocus Companion 是一款广受欢迎的开源按键控制软件,专为现场制作而设计。当 Cliqer 检测到您的系统上已安装 Companion 时,会自动安装 Cliqer 模块,无需任何手动设置。

自动安装:Cliqer 模块随应用一同提供,并在启动时放入 Companion 的模块文件夹。新版本发布后,应用会就地更新该模块。
可用性:该模块(v1.2.2)随 Cliqer 桌面应用一同提供。

工作原理

Cliqer 运行两个供模块连接的本地回环服务器:一个是 127.0.0.1:24601 上的 HTTP 操作 API,用于按键操作;另一个是 127.0.0.1:9052 上的 WebSocket,实时推送计时器更新和应用状态,供反馈和变量使用。

同一台计算机:两个服务器都仅限本地回环访问,因此 Companion 必须与 Cliqer 运行在同一台计算机上,操作才能触发,反馈才能更新。

设置

安装 Companion

安装 Bitfocus Companion 并至少启动一次

启动 Cliqer

启动 Cliqer,它会将 Cliqer 模块放入 Companion 的模块文件夹

添加 Cliqer 连接

重启一次 Companion 以加载该模块,然后添加一个 Cliqer 连接(指向 127.0.0.1,操作 API 端口为 24601)

自动更新:Cliqer 每次启动时都会检查是否内置了更新版本的模块,并就地更新模块文件夹。如果 Companion 正在占用当前模块,刷新会推迟到之后的某次启动再进行,而不会留下只写入一半的文件。

可用操作

该模块提供 19 个操作,按类别分组:

类别操作
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 分钟)
CallersCaller to Program(选择连线嘉宾 1-9)、Clear Program(切黑)
ControlStop Screen Share、Toggle Program NDI Output、Toggle Timer NDI Output
预设的解析方式:四个预设操作分别发送 5、10、15 和 20 分钟的固定时长。如果您的 Timer 面板中配置了对应分钟数的预设,Cliqer 会选中该预设;否则会直接将计时器设为该时长。
连线嘉宾、共享和 NDI 操作作用于演示主机。 将连线嘉宾切到节目输出、清空节目输出、停止共享以及切换 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)所选连线嘉宾正在节目总线上直播
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当前房间 IDABC123
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 以显示新安装的模块

操作无法触发

  • 请确认连接指向 127.0.0.1,操作 API 端口为 24601
  • 请保留模块的默认端口:Cliqer 在 24601 上提供操作 API
  • 一台计算机上只能有一个 Cliqer 实例占用本地端口,请参阅Stream Deck 说明

计时器反馈或变量未更新

  • 实时计时器和应用状态推送使用端口 9052 上的本地回环 WebSocket,因此 Companion 必须与 Cliqer 运行在同一台计算机上
  • 即使推送未连接,幻灯片和计时器操作仍可通过 HTTP 成功执行;因此,如果按键能触发但反馈保持不变,请检查 Companion 中的连接状态

另请参阅:Stream Deck 集成 · Timer