Loading...
This module allows you to control the AIMP music player remotely over WebSocket from Bitfocus Companion.
This module expands the player's capabilities for live events. You can assign buttons to play a specific track or playlist, navigate between tracks and playlists, and display track and playlist information on your Companion surface.
Command-based navigation mirrors the player's graphical interface — just as navigation actions on a PC are reflected in feedback showing the selected track and playlist.
There is also a toggle for Auto Jump (automatic playback of the next track), which lets you pause automatic progression — useful when transitioning from background music to a specific cued track for the main event.
Working with this module allows you to partially replicate QLab-style cueing functionality for amateur use, even on Windows.
To use the module, you need to install the AIMP HTTP Remote Control plugin in your AIMP player and switch it to WebSocket mode. The plugin works with player version 5.40.2716 and later.
In AIMP open Settings → Plugins → AIMP HTTP Remote Control and set Server mode to WebSocket. The HTTP REST mode is not supported by this module — the two modes are mutually exclusive, so the plugin can serve either HTTP or WebSocket on the chosen port, not both.
Download the plugin from the AIMP add-ons catalog or directly from the GitHub repository.
| Setting | Default | Description |
|---|---|---|
| Host | 127.0.0.1 | IP address of the machine running AIMP |
| WebSocket port | 19122 | Port the plugin listens on (must match plugin settings) |
The port and network interface can also be changed inside AIMP: Settings → Plugins → AIMP HTTP Remote Control
Player state is pushed by AIMP over the WebSocket connection (track changes, play/pause, volume, position), so there is no polling interval to configure.
| Variable | Description |
|---|---|
$(aimp-remote:player_state) | playing, paused, or stopped |
$(aimp-remote:volume_pct) | Volume 0–100 |
$(aimp-remote:muted) | true / false |
$(aimp-remote:shuffle) | true / false |
$(aimp-remote:repeat) | true / false |
$(aimp-remote:auto_jump) | true / false |
$(aimp-remote:position_fmt) | Current position as mm:ss |
$(aimp-remote:duration_fmt) | Track duration as mm:ss |
$(aimp-remote:remaining_fmt) | Remaining time as mm:ss |
$(aimp-remote:progress_pct) | Playback progress 0–100% |
$(aimp-remote:playing_track_title) | Title of the currently playing track |
$(aimp-remote:playing_track_artist) | Artist of the currently playing track |
$(aimp-remote:playing_playlist_name) | Name of the currently playing playlist |
$(aimp-remote:next_track_title) | Title of the next track |
$(aimp-remote:focus_track_title) | Title of the focused track |
$(aimp-remote:focus_playlist_name) | Name of the focused playlist |
aimp-remoteis the module shortname. If you rename the connection in Companion, use your connection label instead.
Модуль для удалённого управления плеером AIMP по WebSocket из Bitfocus Companion.
Модуль расширяет возможности плеера для работы на мероприятиях. Можно назначить кнопки для воспроизведения конкретного трека или плейлиста, навигации между треками и плейлистами, а также отображения информации о треке и плейлисте на поверхности Companion.
Навигация командами дублирует графический интерфейс плеера — так же, как навигационные действия на ПК дублируются в фидбэке с информацией о выбранном треке и плейлисте.
Есть переключатель Auto Jump (автоматическое воспроизведение следующего трека), позволяющий отключить автоматический переход — удобно при смене фоновой музыки на основное мероприятие с воспроизведением конкретных треков.
Работа с модулем позволяет частично воспроизвести функциональность QLab для любительского использования, в том числе на Windows.
Для работы модуля необходимо установить плагин AIMP HTTP Remote Control в сам плеер и переключить его в режим WebSocket. Плагин работает с версией плеера 5.40.2716 и выше.
В AIMP откройте Настройки → Плагины → AIMP HTTP Remote Control и переключите Server mode на WebSocket. Режим HTTP REST этим модулем не поддерживается — режимы взаимоисключающие: на выбранном порту плагин поднимает либо HTTP, либо WebSocket.
Скачать плагин можно из каталога дополнений AIMP или напрямую из репозитория на GitHub.
| Параметр | По умолчанию | Описание |
|---|---|---|
| Host | 127.0.0.1 | IP-адрес устройства, на котором запущен AIMP |
| WebSocket-порт | 19122 | Порт, который слушает плагин (должен совпадать с настройками) |
Порт и сетевой интерфейс можно изменить в самом AIMP: Настройки → Плагины → AIMP HTTP Remote Control
Состояние плеера приходит push-событиями от AIMP по WebSocket-соединению (смена трека, play/pause, громкость, позиция), поэтому интервал опроса настраивать не нужно.
| Переменная | Описание |
|---|---|
$(aimp-remote:player_state) | playing, paused или stopped |
$(aimp-remote:volume_pct) | Громкость 0–100 |
$(aimp-remote:muted) | true / false |
$(aimp-remote:shuffle) | true / false |
$(aimp-remote:repeat) | true / false |
$(aimp-remote:auto_jump) | true / false |
$(aimp-remote:position_fmt) | Текущая позиция в формате мм:сс |
$(aimp-remote:duration_fmt) | Длительность трека в формате мм:сс |
$(aimp-remote:remaining_fmt) | Оставшееся время в формате мм:сс |
$(aimp-remote:progress_pct) | Прогресс воспроизведения 0–100% |
$(aimp-remote:playing_track_title) | Название текущего трека |
$(aimp-remote:playing_track_artist) | Исполнитель текущего трека |
$(aimp-remote:playing_playlist_name) | Название текущего плейлиста |
$(aimp-remote:next_track_title) | Название следующего трека |
$(aimp-remote:focus_track_title) | Название трека в фокусе |
$(aimp-remote:focus_playlist_name) | Название плейлиста в фокусе |
aimp-remote— короткое имя (shortname) модуля. Если вы переименовали подключение в Companion, используйте его метку.