Configuration
This chapter provides a walk-through of all configuration settings of mAirList.
Accessing the Configuration
The configuration can be accessed in two ways:
Standalone Configuration App
The standalone mAirList Configuration app is found in the Windows Start Menu
(setup installations), or invoked through the mAirListConfig.bat batch file
included in the zip distribution (which calls mAirList.exe -mode config to start it).
The standalone configuration gives you access to all configuration options.
It must, however, not be used while any other mAirList process/app is running.
Live Configuration (mAirList Control Panel)
The live configuration, also known as mAirList Control Panel, can be found in
the About menu of the main playout app.
It provides access to many configuration settings that can be changed while the
playout is running. Some settings (e.g. the basic setup of playlists and players)
are not available at all, and some will only take effect after you restart
the playout.
Configuration Pages
The configuration is organized on several pages which you access through the
menu tree on the left hand side of the configuration dialog.
Note that some pages may not be available based on your license/edition.
1 - Playlists
This configuration section contains all settings related to the playlist(s) in
the playout app.
This section is only available in the standalone configuration app. not the
live configuration.
On the Playlists page, specify the desired number of playlists you want in the
playout app. mAirList supports any number of playlists (also zero for cartwall-only
setups), but most users will have one playlist.
For each playlist, a Playlist (number) item will appear in the menu on the left.
Playlist
This page contains the following tabs:
General
- Player count:
Specify the number of players to be used with this playlist (at least 1, typically
2 or 3 for most setups).
For each player, a menu item Player (number) will appear (see below).
- Number of played/skipped items to keep in history:
Specify the number of played or skipped items that should remain (grayed out)
in the playlist before they are moved to Recycle Bin (if the corresponding
option Move played/skipped items to Recycle bin is enabled on the Options page).
- Number of prebuffered items:
Specify the number of upcoming items that mAirList should open (and thereby check
for errors) in advance. Successfully rebuffered items are identified by a small
green checkmark next to the item icon.
Options
This tab contains options related to the behavior and operation of the playlist:
- Allow automation mode:
Uncheck to force the playlist being in ASSIST mode all the time.
- Use only a single player in automation mode:
If enabled, mAirList will play all audio files through a single player (and thus,
soundcard) in automation mode.
The benefit is that you don’t have to remember to open all faders when switching
from ASSIST to AUTO. The player used for automation will be the one that was
active when the switch to AUTO was made, or the first player, in case no player was
active at that time.
In any case, it must/will be a player for which Use in automation is enabled in
its options.
- Move played/skipped items to Recycle Bin:
If enabled, all played and skipped items are automatically deleted from the playlist
and moved to the Recycle Bin browser.
- Only move items at the top of the playlist to Recycle Bin:
By default, only items from the top of the list will be moved to the Recycle Bin,
not those played out-of-order in ASSIST mode. By enabling this option, the
latter will be moved to the Recycle Bin as well.
- Automatically mark non-playable items as played in assist mode:
If enabled, any non-playable item (e.g. Dummy) will be marked as played as soon
as any playable item below it is started in ASSIST mode.
(In AUTO mode, this will always be the case.)
- Keep non-playable items in automation mode if playlist would run empty otherwise:
This option refers to the situation when the playlist is in AUTO mode, and only
non-playable items remain in the rundown. If enabled, these items will not be
marked as played (and possibly move to Recycle Bin) before at least one playable
item is added to the playlist again.
- Include non-playable items in logging:
If enabled, non-playable items (e.g. Dummy items) that are automatically marked as
played (in AUTO mode, or in ASSIST mode if the corresponding option is enabled,
see above) will be injected into to the Logging subsystem, e.g. for stream title
update and database reporting.
- Move deleted items into Recycle Bin:
If enabled, items that are manually deleted by the user will be moved into the
Recycle Bin.
- Automatically unpack embedded playlists:
If enabled, Embedded Playlist items will automatically unpacked (content items copied
into playlist) when added to the playlist.
- Keep Embedded Playlist as Dummy after unpacking:
If enabled, the Embedded Playlist item will be converted into a Dummy and remains
in the playlist after unpacking; otherwise it will be deleted.
- Automatically jump to fixed time items in automation mode:
This option controls the processing of (hard or soft) fixed times in playlist items.
Uncheck to disable fixed times altogether – items with timing set to Hard or Soft
will be treated as Normal.
- Wait for hard fixed time items:
This option controls the behavior of the playlist if an item with Hard timing is
reached too early in AUTO mode. If disabled, the item will be played immediately, even
if the set time has not been reached. If enabled (the default), the automation will wait
for that time to be reached, playing silence (an Infinite Silence) item until then.
Additionally, the When playlist runs empty in automation mode action is triggered
in order to execute any “emergency” actions.
- Wait for soft fixed time items:
The same as above, but for Soft timing items. Disabled by default.
- Update backtiming with current time when idle:
This option is related to the Time column in the playlist, in a situation where
all players are idle. If disabled, the start time relative to the beginning of the
playlist (00:00:00) will be displayed for all items. If enabled, the start time
relative to the current date/time will be displayed, updated every second,
assuming that the first item is started in this very moment.
- Auto float:
If enabled, the Auto Float feature will automatically move Normal timing items
around fixed time items so that no underruns or overflows occur in the playlist.
- Repeat mode:
If enabled, all played items are automatically recycled and moved to the end of
the playlist again. This is meant for demo setups.
GUI Options
This tab contains options related to the user interface of the playlist:
- Show save confirmation:
If enabled, a confirmation dialog is displayed if there are unsaved changes when you
close a playlist.
- Show ramp countdown overlay:
If enabled, a large countdown is displayed as an overlay in the playlist while the
ramp/intro of an item is playing.
- Show only nearest ramp:
For items with more than one ramp set, this option controls whether only one ramp
(the nearest from the current playback position) or all of them (separated by a
/ sign) will be displayed in the Ramp column and the ramp overlay. - Show EOF warning countdown overlay:
If enabled, a countdown overlay will be displayed during the last few seconds.
- Click on playlist icon toggles Extra PFL:
If enabled, clicking the icon on an item in the playlist will open its Properties
dialog, switch to the PFL tab and start PFL playback.
- Always show duration:
If enabled,
0:00 will be displayed for items with unknown duration. - Always show ramp:
If enabled,
0 will be displayed for items that don’t have any ramp set. - Auto-truncate time:
If enabled, leading zeroes will be removed from all duration and ramp strings.
- Automatically scroll to playing item:
If enabled, and an item is started, the playlist will automatically scroll so that
that item becomes visible (if it hasn’t been before).
- Spacebar triggers AUTOMATION NEXT:
As the spacebar cannot be used in Hotkey remote control due to limitations imposed
by Windows, this option allows you to hardwire it with the
AUTOMATION NEXT command. - Escape triggers AUTOMATION BREAK:
If enabled, the Escape key will trigger the
AUTOMATION BREAK command. - Escape triggers AUTOMATION STOP:
If enabled, the Escape key will trigger the
AUTOMATION STOP command. - Show color ribbon:
If enabled, a colored ribbon is displayed in the playlist, representing the color
or other properties of the item (based on the skin).
- Use item colors for color ribbon:
Check this option to use the item color (if set)
for the color ribbon, rather than the color defined in the skin.
- Use item colors for row color:
Check this option to use the item color (if set)
for the entire row background, rather than the color defined in the skin.
- Item-specific colors have priority over skin.ini:
If enabled, item colors will always have priority over those defined in the skin.
- Show break duration:
If enabled, Automation Break playlist items will display the duration of the
preceding block instead of their own duration.
- Show album art:
If enabled, mAirList will try to extract album art from the file tag, and display
it instead of the default item icon. Album art is kept in a cache file to speed up
loading when the item is used again.
- Show player state:
Enable this option to display the player state (ON AIR, NEXT, etc.) next to the
player name in the playlist.
- Show player progress as row background:
If enabled, the row background of playing items will be used as some kind of progress
bar, displaying elapsed/remaining time in different colors.
- Auto recycle items on move/drop:
When enabled, every played/skipped item that is moved with the mouse will automatically
be recycled (marked as unplayed).
Control Bar
The options on this tab refer to the control bar (toolbar) displayed above or below
the playlist.
- Show control bar:
Uncheck to hide the control bar altogether.
- Position at bottom (default is at top):
Check this option to move the control bar below the playlist, rather than above the
playlist (the default).
- Separate ASSIST/AUTO buttons:
By default, there will be two separate buttons to switch between ASSIST and AUTO mode.
Check this option to merge them into a common button that toggles between ASSIST
and AUTO.
- Show NEXT button in assist mode:
If enabled, a NEXT button will be displayed also in ASSIST mode, that simulates
commands to fade out the current player and start the next loaded player.
- Always use automation for NEXT button:
If enabled, the aforementioned NEXT button will briefly enable AUTO mode to carry
out the NEXT command.
- AUTO button flashes while playing:
If enabled, the AUTO button will flash when automation is engaged and playback is
started.
- Show next event time box:
Check this option to enable a button that displays the time of the next planned
event, and opens the Event Scheduler when you click it.
- Show item count and duration boxes:
This option toggles this display of a button that displays the number and
total or remaining duration of the items in the playlist.
- Show Edit button:
If enabled, an “Edit” button is displayed that expands the inline editor which
allows you to quickly edit some common properties of the selected playlist items,
including cue markers.
- Always show move up/down buttons:
If enabled, a separate pair of “move up/down” buttons will be displayed in the
main control bar, rather than only in the inline editor.
Progress Bar
This tab provides options related to the “inline” progress bar displayed in the playlist
rows for playing items.
See the Common Settings section for a description of the
available options.
Display
Here you can adjust the time format strings
used for duration, ramp, ramp overlay and EOF warning overlay.
Any text entered here will be concatenated with the item comment and displayed when
the item is expanded by clicking the corresponding button in the item row.
It is possible to use Logging Variables here that access properties of the item, e.g.
attributes. For example, %u{Album} will insert the value of the Album attribute
(album name extracted from file tag).
Player
For each player of each playlist, a menu item is created in the menu tree on the left
hand side of the configuration dialogs, which provides access to the settings
for that particular player.
General
On the first tab, the following general settings are available:
- Caption:
Choose a caption (typically a single character) that is used to identify the
player in the GUI. It is displayed in the player, as well as in the playlist
next to the item that is loaded into that player.
- Color:
Each player is associated with a color that helps the DJ to identify the player
in the GUI. It is used as the background for the player indication in the playlist,
and also for the background of the player object while it is active
(unless overridden by skin).
- Default time display mode:
Select the default mode for the time display: remaining time, elapsed time
or backtiming (the time at which the item will finish playing). You can toggle
between remaining and elapsed by clicking the time label in the player object,
or double-click it to switch to backtiming mode. If a Command when clicked
is specified (see below), the Shift key must be hold down while clicking the
time label.
- EOF warning:
Specify the number of seconds before EOF when the player should stat flashing
and trigger the
OnPlayerEOFWarning procedure in background scripts. - Command when clicked:
Choose an optional command that is executed when the user clicks anywhere in the
player object with the mouse. This is useful for touchscreen operation.
- Fade duration:
Enter the duration, in seconds, that the audio should fade out when a
FADEOUT
command is issued, or the Fade Out button is clicked.
The value 0 means that the default fade duration from the Misc. Settings page
will be used. - Time formats:
Specify the time format strings for the remaining and
elapsed time and the ramp display.
Options
This tab contains options related to the behavior and operation of the playlist:
- Auto load in assist mode:
If enabled, the player will automatically be loaded with the next available item
in ASSIST mode. If disabled, the user must load the player manually by dragging
an item into it, or using remote control commands.
- Auto load on demand:
If enabled, the player will not be auto-loaded until a
START command is issued,
or the START button is clicked. - Only auto-load if all other players are empty:
By enabling this option for all (auto-loading) players, only a single player will
be loaded at a time. This may help the DJ to identify the next player to start
mor easily.
- Auto close on STOP in assist mode:
If enabled, the player will unload itself when a
STOP command is issued in ASSIST mode. - Auto close on ERROR in assist mode:
If enabled, the player will unload itself if an item failed to load in ASSIST mode.
- Auto close at EOF in assist mode:
If enabled, the player will unload itself when playback stops at end of file in ASSIST mode.
This overrides the Auto rewind at EOF option below.
- Auto rewind at EOF in assist mode:
If enabled, the player will rewind and return to LOADED state when reaching EOF in
ASSIST mode. The Auto close at EOF option above must not be enabled.
- Auto release PAUSE when other player is playing or started:
This option can be used together with the
PAUSE/STOP commands for remote control.
When the DJ closes the fader, the player will initially go into PAUSE state.
At this point, the DJ can either choose to open the fader again - then the player
will continue to play from that position. Or the DJ can start another player,
and then this player will simulate a STOP command and unload itself (depending
on the options above). - Auto PFL OFF on START:
If enabled, PFL mode will be canceled when on air playback is started in ASSIST mode.
- Auto close PFL at EOF:
If enabled, PFL mode will be canceled when playback reaches EOF in ASSIST mode.
Allow simultaneous playback and PFL (see below) must be enabled as well.
- Auto fadeout at Fade Out marker in assist mode:
If enabled, playback will automatically fade out at the Fade Out marker even
in ASSIST mode, similar to AUTO mode. If disabled, audio will never fade automatically
in ASSIST mode, but the DJ is responsible to execute all crossfades manually.
- Use in automation mode:
Uncheck this option to prevent this player from being used in AUTO mode.
Note: There must be at least one player for which this option is enabled, otherwise
all players will be used in AUTO mode.
- Move item to history when closing paused/EOF player:
If enabled, items will be marked as played when it they are ejected from this player
after playback.
- Move item to history when closing loaded player:
If enabled, items will be marked as skipped when it they are ejected from this player
without having been played.
- Include in logging:
If enabled, items played from this player will be injected into the logging subsystem.
- Allow simultaneous playback and PFL:
Usually, each player can only be playing on air, or playing in PFL mode, but not
both at the same time. This is because on air and PFL audio is typically routed to the
same mixing console channel. Depending on your setup, you may be using a separate
audio channel for PFL operations. In this case, you can enable this option, and
PFL mode can be engaged even when the player is currently playing on air.
- Only use PFL audio device while player is playing:
This option can be used together with the Allow simultaneous playback and PFL
option above. It controls which device is used for PFL mode while on air playback
is not active. If disabled, PFL mode will always use the player’s PFL device
set in Audio Routing. If enabled, PFL mode will use the
On Air device when there is no simultaneous on air playback, and the PFL device
if both on air and PFL are playing at the same time. This way, you can use the
regular mixing console channel for non-simultaneous PFL mode, and a separate channel
only for simultaneous PFL.
- PFL during playback starts End Mon:
If enabled, PFL playback will automatically jump to the last few seconds of the
item when you enabled PFL mode during on air playback.
This option only has effect if Allow simultaneous playback and PFL is enabled as well.
- Loop audio:
If enabled, the player will loop between Loop In (or Cue In) and Loop Out (or EOF).
Loop mode can be toggled at runtime by using the Loop button the player.
- Switch off loop mode when player is closed:
If enabled, Loop mode is disabled automatically when the item is ejected.
GUI Options
- Auto-truncate time:
If enabled, leading zeroes will be removed from all duration and ramp strings.
- Show cue editor during PFL:
If enabled, the Cue Editor will be displayed in a popup window as long as PFL is
active.
- Show save buttons in PFL cue dialog:
Check this box to add buttons to the Cue Editor to save the item metadata to the
database, file tag, or MMD file.
- Flash during EOF warning:
If enabled, the player will flash during the last few seconds before EOF, according
to the setting on the General page.
- Show ramp:
If enabled, the duration label will turn into a ramp countdown while the ramp part
of the item is playing.
- Show ramp when idle:
If enabled, the ramp countdown will already be displayed in Loaded state, not only
after playback was started.
- Show only nearest ramp:
If enabled, only the next ramp marker from the current playback position (for items
with more than one ramp set) will be considered in the countdown.
- Swap artist and title:
Check this option to swap the artist and title labels in the player object (artist
will be on top, title below).
- Use item color when idle:
If enabled, the color set for the item in the Properties dialog will be used for
the player background while it is in Loaded state.
- Use “stutter” mode while cueing:
- Allow dragging:
This option will make it possible to drag a loaded item out of the player with the
mouse. The Command when clicked setting will not have any effect anymore.
- Show volume slider:
Check this to enable the volume slider on the right hand side of the player object.
- Transparent buttons:
This option will make the background of the buttons transparent.
On this tab, select the buttons that should be displayed in the player.
Deselecting all buttons will hide the button toolbar completely.
Progress Bar
The options on this tab control the progress bar displayed in the player.
See the Common Settings section for a description of the
available options.
These options refer to the waveform display in the player object.
See the Common Settings section for a description
of the various options.
Peakmeter
These options refer to the peakmeter in the player object.
See the Common Settings section for a description.
Item Types
On this tab, select the item types that should be included in the Auto Load function
by default. Hint: The right-click menu allows you to select all/no items at once.
2 - Cartwall
This configuration page contains the settings related to the cartwall.
General
To enable the cartwall, the Enable Cartwall box must be checked.
Grid Size
Audio items in the cartwall are arranged in a grid, and each field of the grid serves
as a (virtual) cart player – although you can resize individual items so that they
span multiple fields in the grid.
The grid size can be adjusted freely. The resulting number of players is the
grid width multiplied by the grid height.
Settings
The following settings can be made:
Numbering:
The fields in the cartwall grid can be numbered in one of the following ways:
- None:
No numbers will be used. This will also disable any
CARTWALL <index> ... remote
control commands, as well as cart player state feedback for remote control
interfaces that support it (e.g. D&R Airlite). - Left to right:
First row of fields has numbers 1, 2, 3, etc.; then numbering continues with
the second row, and so on.
- Left to right (occupied positions only):
Same as Left to right, but only those fields that actually contain an item
receive a number, empty fields are skipped.
- Top to bottom:
First column of fields has numbers 1, 2, 3, etc.; then numbering continues with
the second column, and so on.
- Top to bottom (occupied positions only):
Same as Top to bottom, but only those fields that actually contain an item
receive a number, empty fields are skipped.
When a cart player is resized so that it spans multiple fields in the grid,
its number will be the one of the top left field it occupies.
Start in mode:
The cartwall operates in one of the modes ON, OFF or PFL at any time,
which are toggled through remote control commands (CARTWALL MODE ...) or the
buttons in the cartwall toolbar. Set the desired mode at program startup here.
EOF warning:
Specify the number of seconds before EOF when a player should start flashing
and trigger the OnCartwallPlayerEOFWarning procedure in background scripts.
Fade duration:
Enter the duration, in seconds, that the audio should fade out when a FADEOUT
command is issued.
The value 0 means that the default fade duration from the Misc. Settings page
will be used.
Time format and Ramp format:
You can adjust the time format strings used for
the playback position and ramp countdown here.
Position and Window Options
The cartwall can be displayed in one of the following ways:
- Embedded in main window:
The cartwall is located below the playlist(s) in the main window.
- Separate window - restore last position or use layout:
The cartwall is displayed in a separate window, which is restored to its last
position when you restart the software (see Remember window position and size below).
- Separate window - maximize on monitor n:
The cartwall is displayed in a separate window, which is always maximized on the
selected monitor. This is useful in multi-screen setups. One entry is available
for each monitor connected to the computer.
The Identify Monitors button will help you to identify which monitor is Monitor 1 etc.
Additionally, the following options are available:
- Always on top:
If enabled, and a separate window is used for the cartwall, that windows will
always be displayed on top of all other windows.
- Remember window position and size:
This should be checked if the position set to Separate window - restore last position,
so that mAirList records the current window position when you exit the software.
- Show Cartwall button in toolbar:
If checked, a Cartwall button will be added to the main toolbar of the playout
window. Click that button to hide/show the cartwall (for “embedded into main window”
mode), or to open the cartwall window and bring it to front (for “separate window” mode).
Options
The Options page contains several tabs with options related to the cartwall.
General
- Include in logging:
If enabled, items played from the cartwall will be injected into the logging subsystem.
- Always show grid:
If checked, the grid will always be displayed, even if there are no open tabs.
- Always show cart numbers in grid:
If checked, the field numbers in the grid will be displayed all the time, even
for empty fields. The Always show grid option must be enabled as well.
- Show ON button in toolbar:
Uncheck to hide the ON button (that toggles between ON and OFF mode)
from the cartwall toolbar.
- Show PFL button in toolbar:
Uncheck to hide the PFL button from the cartwall toolbar.
- Show artist:
If enabled, the artist of each item will be displayed in the cart players along with
the title; otherwise only the title.
- Show ramp:
If enabled, the duration label will turn into a ramp countdown while the ramp part
of the item is playing.
- Show ramp when idle:
If enabled, the ramp countdown will already be displayed in Loaded state, not only
after playback was started.
- Show only nearest ramp:
If enabled, only the next ramp marker from the current playback position (for items
with more than one ramp set) will be considered in the countdown.
- Show icon instead of title when available:
If enabled, and an icon is set for the item in its Properties dialog, the icon
will be displayed instead of the title.
- Show peakmeter:
If enabled, a peakmeter will be displayed in each individual cart player.
- Show volume slider:
If enabled, a volume slider will be displayed in each individual cart player.
- Flash during EOF warning:
If enabled, cart players will flash during the last few seconds of playback
(see EOF warning setting on the General page).
- Show save confirmation:
If checked, a confirmation dialog will appear when you close a tab that has unsaved
changes.
- Ask for confirmation when closing pages:
If checked, a confirmation dialog will appear when you close any changed or unchanged
tab.
- Prevent leaving ON mode when players are active:
If you uncheck this option, ON mode can be canceled at any time (switching to
OFF or PFL mode), and all cart players will stop playing as you do so.
- Prevent leaving PFL mode when players are active:
If you uncheck this option, PFL mode can be canceled at any time (switching to
ON or OFF mode), and all cart players will stop playing as you do so.
- Automatically switch to ON mode when player is started in OFF mode:
When this option is enabled, the cartwall will process remote control start commands and
mouse clicks even in OFF mode, and switch to ON mode automatically before it starts
playing.
- Ignore mouse clicks:
By checking this option, you can prevent cart players reacting to mouse clicks.
This is for situations where the cartwall should only be controlled by remote
control commands.
- Allow dragging of items to playlist:
If enabled, you can drag items from the cartwall to the playlist with the mouse.
Cart players will then start and stop when the mouse button is released
(rather than when it is pressed), so that a drag operation does not start the player.
- Only one cart per column can be selected:
This option constraints the
CARTWALL <number> SELECT command to one cart per column;
if you select another cart from the same column, the first one is unchecked
automatically. - Selection per column is locked while cart is playing:
If enabled, carts cannot be selected or unselected while they are playing.
- Auto-reload Favorites:
Check this option to re-scan the folders set up in on the Favorites page
(see below) every time you open the Favorites menu.
Progress Bar
The options on this tab control the progress bar displayed in the cart players.
See the Common Settings section for a description of the
available options.
These options refer to the waveform display in the cartwall toolbar.
See the Common Settings section for a description
of the various options.
Many of the options on the General tab can also be changed at runtime, through the
Options submenu in the context menu of the cartwall grid.
Favorites
On this page, you can register one or more files and folders that should be presented
in the favorites menu that appears when you click the button with the heart icon
in the cartwall toolbar. The button will only appear when there is at least one
file/folder registered here.
The following items are supported:
- Cartwall Page files (
*.mcp) - Cartwall Set files (
*.mlc, from earlier version) - Folders – they will be recursively scanned for
*.mcp and *.mlc files in them.
If there are more than 15 favorites, a selection dialog is displayed instead of a menu.
3 - GUI
In this section of the configuration you can adjust the appearance of the
graphical user interface (GUI) of mAirList.
General
On the General tab, the following settings can be adjusted:
- Window position:
Choose whether the main window should appear maximized on one of the available
monitors, or use the default position (which will possibly be remembered when you close
and re-open the software, see option below).
- Show GUI in language:
mAirList comes with a number of international translations, selecting the appropriate
one according to your Windows locale settings. If you want to override this
automatic selection, choose a specific language from the dropdown list.
- Global progress bar interval:
This is how often the progress bar is updated. A shorter interval will result in
a smoother display, but also higher CPU load.
- Clock time format:
Select the display format for the clock; the default is
tt which corresponds
to the default time display format from the Windows local settings. You can
override it using the same
variables as available for logging.
Additionally, the following options are available:
- Remember window size and position:
If enabled, mAirList will remember the last window size and position when you close
the software, and restore it in the same place when you re-open it.
- Show status bar:
Controls whether the status bar (with last log error/warning, ON AIR status and
current time) will be displayed in the main window.
- Show close confirmations if there are active players:
If enabled, an additional warning will be displayed when the user tries to exit
the software while there are players playing on air.
- Minimize to try:
If enabled, the software will move its icon away from the taskbar to the Windows tray
when the application window is minimized.
- Use small icons:
when checked, the toolbar of the main window uses smaller icons, which can save
some space on smaller displays.
- Use separate tabs for playlists:
When more than one playlist is configured, they are usually displayed below each
other (or side by side, see next option). With this option enabled, they will be
presented on separate tabs instead.
- Side-by-side alignment of playlists:
Check this option if you want the playlists to be displayed side by side, rather
than below each other.
Browser
The options and settings on this page refer to the browser part of the main playout
window.
- Use full height for the browser:
If enabled, the browser will use the full height of the right hand side of the
playout window, making the players less wide.
- Show Browser button in toolbar:
If enabled, a Browser button is displayed in the toolbar which can be used
to show/hide the browser.
- Visible at startup:
Check this option to display the browser by default when the software starts.
If unchecked, the user must click the Browser button first to display it.
- Use a separate window for the browser:
With this option, the browser can be detached from the main window, and displayed
in its own separate window.
- Separate browser window is always on top:
If enabled, the separate browser window will always be on top of the main window.
- Allow stack of panes to be minimized:
If enabled, the user can minimize browser tabs with the mouse, turning them into
small side-by-side buttons, to save screen space.
- Show panes as tabs:
This option will use plain Windows-style tabs for the browser tabs, rather than
the default panes.
- Show file durations (may be slow):
If enabled, mAirList will read out the duration of all files in directory browsers.
- Auto update folder contents:
If enabled, mAirList will update the contents of directory browser regularly.
- Keep search history:
If enabled, a dropdown with the most recently used search terms will be available
in the Database Search browser.
- Enable autocompletion for search history:
This option enabled autocompletion in the search history of the Database Search browser.
Additional File Extensions
By default, folder browsers only display files with the audio and playlist file
extensions known to mAirList. If you want to use other file types (that can be
decoded by one of the installed audio codecs), enter their extensions here,
separated by spaces, e.g. wv tta. The leading dot is optional.
A restart of the software is required for this setting to take effect.
Quick Folders
Folders added to this list are displayed in the Add menu of the browser, so that
a folder browser for them can be opened with a single click.
See the Browser chapter for more information about the browser.
Cue Editor
This section provides settings for the Cue Editor, both in the Item Properties dialog,
and in the PFL window that appears when a player is started in PFL mode.
On the Favorites tab, you can select the most frequently used cue marker types.
If one or more type is selected, a new tab labeled Favorites is displayed in the Cue
Editor with only these types, and the complete list of markers is displayed on
another tab labeled All.
On the Options tab, you can enabled “Stutter” mode, which will repeatedly play
a small part of the audio as you edit a cue marker, similar to the function found
in DJ CD players.
The options on the Waveform tab control the appearance and behavior of the
waveform in the Cue Editor.
See the Common Settings section for a description
of the various options.
Progress Bar
The options on this tab control the “global” progress bar displayed below the playlists.
See the Common Settings section for a description of the
available options.
Item Colors
On this tab, you can define colors for playlist items, based on their item type
(music, jingle, advertising, etc.). These colors will be used when no specific
color is defined or a particular item in its properties.
Screen Objects
Screen objects allow you to add additional elements (buttons, labels, utilities, …)
to the playout window.
To add a new screen object, use the Add button and select the desired type from
the dropdown list. To edit the properties of an existing object, double-click it,
or select it from the list and click Configure.
The order of the screen objects can be rearranged by dragging items around with the
mouse; this will also affect the order in which they are displayed in the playout GUI.
Common Settings
On the Advanced tab of the screen object properties dialog, there are some
settings that are common to all or some types of screen objects:
- Position:
Select whether the screen objects should be displayed above or below the browser,
or in a separate Tools window that can be accesses through the Tools button
in the main toolbar (only visible when at least one screen object is set to
Tools Window). You can also select the alignment within the Tools window.
- Automatically hide or minimize:
Some screen object types can automatically hide themselves in situations where
there is no information to display. For example, the Countdown to next event
object can hide itself when there are no upcoming events. Check this option to
enable this automatic hiding. The option is grayed out for those objects that
don’t support it.
- Border:
mAirList can display an optional border around the object. To enable the border, set
the border width greater than 0, and select the desired color.
- Remote ID:
Some screen object types can process remote control commands. For example, the
Extended Button object can receive a
PRESS command that simulates a click.
To enable processing of remote control commands, you must configure a remote ID
for that screen object, which will serve as the prefix for the remote control
commands. It should be in all capital letters or digits, and should not contain
spaces. For example, when you set MYBUTTON as the remote ID, the resulting command
will be MYBUTTON PRESS. A list of supported commands is given in the description
of the various screen objects below. Please note that, due to the dynamic nature
of these commands, they will not appear in the command selection dropdown list
of the remote control configuration.
For all text-based and button screen objects (e.g. “Date or time”),
the font, font color background color and text alignment can be adjusted and
previewed on the Appearance page.
Streaming Encoder Status
This screen object displays the status of the encoder and
allows the user connect or disconnect the encoder, and toggle the live (LINE and MIC)
inputs.
For more information,
see the description of the screen object in the Encoder chapter.
Date or Time
This screen object displays the current date or time, according to the time format
which is specified in Delphi’s FormatDateTime formatting.
See here for a list
of possible formatting variables.
If you want to display static text before or after the time string, enter it into the
text format field, and use %s as the placeholder for the actual time string.
LED Clock
This screen object contains a studio-style LED clock. You can adjust the colors for
both the dots and the clock background.
Countdown to Top of the Hour
This screen object displays the remaining time until the top of the hour (xx:00:00).
The format settings are the same as those for the Date or Time screen object.
Player Countdown
This screen object displays a countdown for the active player. You can choose from
the following countdown types:
- Remaining time
- Elapsed time
- Total duration
- Remaining ramp
- EOF warning
- Remaining time to outro
The format settings are the same as those for the Date or Time screen object.
This screen object displays the value of the Comment field of the item currently
selected in the playlist.
On Air Status
This screen object shows the current ON AIR status (ON AIR or OFF AIR).
Fonts and colors can be set individually for both states.
On Air Switch
The same as On Air Status, but you can toggle between ON AIR and OFF AIR
by clicking the screen object.
This screen object displays a single Windows-style button. When the user clicks the
button, the Actions configured on the Actions tab are executed.
This screen object provides a button with a number of configurable options.
The button can either be a “simple” click button (actions from the Action tab
are executed when clicked), or a “toggle” button (button can be toggled between
“active” and “inactive”).
You can freely configure the texts and appearance used for each of the possible states
(inactive, active, disabled, disabled+active). The default text will be used
for all states that don’t have a specific text set.
If the button is configured as a “toggle” button, it will execute the appropriate
action list from the Action tab when it is activated or deactivated, and the
following additional options are available:
- Active at startup:
Check if you want the button to be active when the software is started.
- Execute actions when toggled remotely:
Determines whether the action lists should be executed when the button is toggled
from a remote control command (see below).
- Status controlled by script:
If checked, the button will not toggle its status on its own when clicked, but
only execute the action lists; its state can only be toggled from a remote
control command (see below). This can be used for interactions with scripts when
you want the button to toggle only if the script processed the action/command
successfully.
In order to control the button through remote control commands, set a Remote ID
on the Advanced tab, e.g. MYBUTTON. Thereafter the button will process the following
commands (prefixed by your Remote ID, e.g. MYBUTTON ENABLE):
DISABLE:
Disable the button (user cannot click it with the mouse).ENABLE:
Enable the button again.ACTIVATE or ON:
Switch to active state (toggle button only)DEACTIVATE or OFF:
Switch to inactive state (toggle button only)ACTIVATE/DEACTIVATE or ON/OFF:
Toggle between active and inactive state (toggle button only)PRESS:
Simulate a click and execute actions (simple mode button only)TEXT <value>:
Change the default text of the button. Use "" to clear the text.INACTIVE TEXT <value>,
ACTIVE TEXT <value>,
DISABLED TEXT <value>,
DISABLEACTIVE TEXT <value>:
Change the text for a particular button state. Use "" to clear the text.FONTNAME <value>:
Change the font name.FONTSIZE <value>:
Change the font size.FONTSTYLE <value>:
Change the font style.FONTCOLOR <HTML color code>:
Change the font color.
Static Text
This screen object displays a simple static text.
Status Display
This screen object works similar to the On Air Status, but it is used to display
any kind of custom status, controlled by remote control commands and/or a script.
To toggle between the states, define a Remote ID and use the commands
<REMOTEID> ON and <REMOTEID> OFF.
Image
This screen object displays an image, e.g. station logo. All common image formats
(PNG, JPG, SVG, etc.) are supported.
PFL Player
The PFL Player screen object provides a quick way to pre-listen to any audio item
by dragging it onto the player.
Talk Timer
This screen object displays a talk timer that can be used as a stopwatch during live shows.
The format settings are the same as those for the Date or Time screen object.
The timer can be started or stopped by clicking it with the mouse. Additionally,
the following remote control commands are available:
STARTSTOPSTART/STOP (same to mouse click)RESET
Time of Next Event
This screen object displays the time of the next upcoming event in the Event Scheduler.
The format settings are the same as those for the Date or Time screen object.
Countdown to Next Event
This screen object displays the remaining time until the next upcoming event in the Event Scheduler.
The format settings are the same as those for the Date or Time screen object.
Countdown to Next Fixed Time
This screen object displays the remaining time until the next upcoming fixed time
item im the playlist.
The format settings are the same as those for the Date or Time screen object.
Mix Editor
This screen objects provides a fully-functional, embedded Mix Editor,
which is automatically loaded with the items currently selected in the playlist.
The OK and Cancel buttons are not available in the embedded Mix Editor; all changes
are applied immediately.
The following settings are available:
- Number of items when following playlist selection:
When a single item is selected in the playlist, the Mix Editor loads this number of items,
starting with the selected one. When multiple items are selected, exactly these items
are loaded. The default is 3.
- Follow playlist selection:
If enabled, the Mix Editor is reloaded every time the selection in the playlist changes.
- Automatically zoom to first mix point:
If enabled, the Mix Editor zooms in on the first transition after loading the items.
Web Browser
This screen object provides an embedded web browser
It uses Microsoft Edge internally, and the
WebView2 Runtime
must be downloaded and installed before you can use it.
The browser always starts with a fixed URL, and is it does not provide any address bar
or other controls (except the right-click menu), you should only use it to display
small dedicated web widgets that do not require a large amount of navigation.
Good examples for suitable use are a chat application or a DHD 52 WebView.
Aircheck Recorder
The Aircheck Recorder provides a convenient recording facility for live shows.
See here for more information.
Stream Monitor Status
This screen object displays the status (connection list) of the
Stream Monitor.
4 - Audio Routing
On this configuration page, the audio routing of all audio-related functions can
be adjusted, in particular:
- the playback devices for players, cartwall, PFL, etc.;
- the record devices for the encoder, live feed inputs, etc.
Routing Tree
The playback and record functions are arranged on two separate tabs, Playback
and Recording, and arranged in a tree-like manner.
In particular, there are nodes/sub-trees for the general default devices, the
playlists and their players, the cartwall and its players, etc.
If not specific selection was made for a particular playback or record function,
the device will be displayed in gray and italics, and the default device for that
audio function will be used instead. This is typically one of the devices from
the Default devices section (playback, PFL, or recording), with a few exceptions:
- The PFL device of the players and the cartwall will follow the playback/ON AIR
device of the same player if not set.
- The cartwall has a default set of ON AIR/PFL devices that will be used for all
players for which no specific devices are configured.
If Regionalization is enabled, each playback function will have a separate set
of sub-nodes, one for each region, where you can select the output device
for that particular playback function and region.
Change Assignment
To change the audio device of any playback or record function, double-click the
entry in the tree, and a dialog with a list of available devices will be presented.
Select the desired device and click OK to save the assignment.
The first entry in the list – Not set (use default device) – will clear the
assignment for the selected playback function, so that it reverts to the default
device for that function. For example, when you clear the specific assignment
for “Cartwall Player 1 ON AIR device”, it will use the “Cartwall ON AIR device”
assignment again (displayed in gray).
The device selection dialog as a built-in test function that will help you to
identify the correct input or output. For playback devices, it will output
a 1kHz test tone to the sound card output selected in the list. For record devices,
it will open the device and display the audio level received from the selected
input in the peakmeter at the bottom of the dialog.
Errors and Warnings
Whenever possible, audio devices are identified by unique ID that is assigned by
Windows by the time the device is detected/installed. This is so mAirList can still
identify them even when renamed in Windows Control Panel.
There are however situations when Windows unexpectedly re-detects a device, and
assigns a new ID to it. In this case, one of following icons may be displayed
in the tree:
- Yellow warning icon: The originally selected device is no longer available, but another
device with the same name was found and is being used instead.
You can click the Repair icon in the toolbar to clear these warnings and
make the auto-selected new assignment permanent.
- Red error icon: The originally selected device is no longer available, and no
matching new devices was found. Please select the new device manually.
Load and Save
The audio configuration for playback or recording can be saved and restored to/from
an .ini file using the buttons in the toolbar. Only the playback or recording
part of the routing will be affected, according to the currently selected tab
(Playback or Recording).
5 - Audio Settings
On this configuration page, general audio output settings can be adjusted,
as well as the settings and options for all sound cards.
General
mAirList uses the BASS audio library for all audio
operations. On this tab, the general parameters for the library can be adjusted.
Most of these settings correspond to the BASS_CONFIG_xxx config options of the
BASS library. Detailed information on these options can be found in the
BASS documentation.
- Update period:
Corresponds to
BASS_CONFIG_UPDATEPERIOD option. - Network buffer size:
Corresponds to
BASS_CONFIG_NET_BUFFER option. - Network prebuffer amount:
Corresponds to
BASS_CONFIG_NET_PREBUF option. - Network connection timeout:
Corresponds to
BASS_CONFIG_NET_TIMEOUT option. - Network read timeout:
Corresponds to
BASS_CONFIG_NET_READTIMEOUT option. - Asynchronous file buffer:
Corresponds to
BASS_CONFIG_ASYNCFILE_BUFFER option. - Default recording prebuffer length:
Length (in milliseconds) of prebuffered audio when recording from a sound card
(e.g. for Live Feed playback).
The Default Recording Format is used for all recording functions in mAirList for
which no specific format is configured.
- Pitch and tempo adjustment using BASS_FX.DLL:
If enabled, all audio is routed through the
BASS_FX add-on, to enable pitch and
tempo adjustment. This involves additional overhead even if playing at the default
pitch and tempo, so it is disabled by default, and any pitch or tempo set in the
item properties won’t have any effect until you enable the feature here. - Force high precision cueing for VBR files (BASS_STREAM_PRESCAN):
When enabled, all files will be scanned to determine the exact file position
for a particular playback position. Enable this option if you deal with variable bitrate
(VBR) files a lot, because cueing might be imprecise without it.
- Cache remote files (faster opening, needs RAM):
If enabled, files played from an HTTP/FTP URL will be cached into RAM during playback.
- Use asynchronous file reading:
If enabled, the reading of audio files will be performed in a separate background
thread, which may improve stability in situations where you encounter audio dropouts.
WASAPI
WASAPI (Windows Audio Session API) is the default audio output method used by mAirList.
All soundcards available in the Windows Sound Settings control panel support this
output method. It has been available (and the default) since Windows Vista.
- Use event-driven buffering:
If enabled, the device is opened in “even-driven” mode, which means that WASAPI
will pull audio data as required, rather than that the application periodically
pushes it to WASAPI periodically.
- Raw mode (disable enhancements):
If enabled, the device is requested to be opened in “raw mode”, which disables
all enhancements set up in Windows Control Panel.
DirectSound
DirectSound is the older audio output method provided by Windows before Windows Vista
was released. It is still available as an API in modern Windows version, but you should
avoid using it normally, and use WASAPI instead. Internally, Windows will route
all DirectSound data through the WASAPI layer anyway, so there is no point in using
DirectSound; however there is a small number of older soundcards that may not work
properly when accessed directly through WASAPI, so the DirectSound functions are
still available in mAirList as a last resort when WASAPI doesn’t work.
To adjust the settings for a playback or record device, switch to the respective tab
and select the device from the drop down list.
The following settings and options are available:
- Sample rate:
Select the sample rate to run the soundcard with. This should match the sample rate
set up in Windows control panel for this sound card.
- Buffer size: (playback only)
The size of the output buffer. This is also the playback latency, so it should be
set as low as possible, but not too low, or you will hear dropouts.
- Force multichannel output: (playback only)
If this option is checked, the soundcard is assumed to have 8 channels, and 4 stereo
pairs are made available as virtual devices after you restart the software.
Use this option if Windows does not report all available stereo pairs correctly.
- Enable multichannel device: (playback only)
For a 5.1 or 7.1 soundcard, you may enable this option in order to create another
multi-channel audio device in the playback routing, which allows you to play 5.1
or 7.1 audio files.
- Ignore speaker assignment: (playback only)
Sometimes Windows will report the outputs/speakers in a wrong order; check this option
to fix this.
- Use floating point data (BASS_SAMPLE_FLOAT):
If enabled, PCM audio will be passed in 32-bit floating point resolution.
If disabled, 16-bit PCM data will be used.
ASIO
ASIO (trademark of Steinberg) is an alternative driver model supported mostly by
mid- and high-end audio cards. You can use ASIO if your soundcard doesn’t support
WASAPI.
- Ignore this device:
By default, mAirList will ignore all ASIO devices, as it would usually result in
a conflict when the device is used in WASAPI mode at the same time (e.g. by being
the Windows default device). So if you are going to use this device in ASIO mode,
first uncheck this option, then restart the configuration.
- Use floating point data (BASS_SAMPLE_FLOAT):
If enabled, PCM audio will be passed in 32-bit floating point resolution.
If disabled, 16-bit PCM data will be used.
- Use a separate thread for processing.:
If you are using more than one ASIO device at the same time, they will usually
be processed in a common background thread. By checking this option, a separate
thread will be used for this particular device.
Sound Processing
On this page, you can add DSP plugins (e.g. compressors, AGC, VST plugins, Stereo Tool,
or the Silence Detector) to each playback and recording device. Select Playback or
Recording at the top, choose the device from the list, and manage its DSP chain below.
Please see the Sound Processing chapter for a description
of the DSP chain and all available plugins.
6 - Encoder
On this page, you can find the settings for the
integrated streaming encoder.
See here for a description of the configuration.
7 - Remote Control
mAirList can be controlled by a wide range of external hardware and software: keyboards,
MIDI controllers, USB devices, mixing consoles, network clients, and more.
Each of these is set up as a remote control interface on this configuration page.
Most remote control interfaces translate incoming events (a key press, a MIDI message,
a GPIO input, a fader being opened) into
remote control commands, e.g. PLAYER 1-1 START.
Interfaces for mixing consoles usually also work the other way round, and send the
state of mAirList (e.g. “player is playing”) back to the console, e.g. to light up
buttons.
This page is also available in the live configuration (mAirList Control Panel).
Managing Remote Control Interfaces
The list shows all configured remote control interfaces. The following functions are
available from the toolbar:
- Add…:
Add a new remote control interface. A menu will pop up, with the available interface
types grouped by category (manufacturer), and the configuration dialog of the new
interface will be opened.
- Configure:
Open the configuration dialog of the selected interface.
You can also double-click the entry in the list.
- Remove:
Remove the selected interface from the configuration.
- Export:
Save the selected interface(s) to an
.ini file. - Import:
Add the interface(s) from a previously exported
.ini file to the list.
You can set up any number of interfaces, also more than one of the same type, e.g.
when you have two MIDI controllers connected.
Players Tab
Interfaces for mixing consoles and similar devices often have a Players tab in their
configuration dialog. It contains a row of tabs for each playlist, and a row of tabs
for each player of the selected playlist. On these tabs, you can assign console
channels, faders or GPIOs to each player (e.g. for fader start or ON AIR lamps),
without having to enter raw commands. The Players tab is only displayed when at
least one playlist is configured.
The interface types are described in detail on the following pages.
7.1 - Generic
This section covers the generic remote control interfaces that are not tied to
a particular manufacturer: keyboard hotkeys, MIDI, and serial ports.
7.1.1 - Hotkey Remote Control
This article covers the configuration of hotkeys for the remote control of mAirList.
Local and Global (System-Wide) Hotkeys
mAirList supports two kinds of hotkeys, represented by two distinct remote control
interfaces:
- Local: Hotkeys only work when mAirList application is in the foreground and
focused.
- System-wide: Hotkeys work regardless of whether the mAirList
application is in the foreground or background. System-wide hotkeys are always
routed to mAirList, so they cannot be used by any other application anymore.
As a thumb rule, use system-wide hotkeys only for very special shortcuts
(e.g. Alt+Ctrl+F1) that are not used in any other software.
System-wide hotkeys are often used with programmable POS keyboards.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of the desired type (local or system-wide hotkeys).
To add a new shortcut, click the Shortcut field first, then press the desired key or
key combination. It will appear in the Shortcut field.
Click Add to add it to the list of hotkeys in the upper part of the dialog.
To assign a remote control command to the shortcut,
select it from the drop down menu, or type it manually in the table cell next
to the shortcut.
7.1.2 - MIDI
The MIDI remote control lets you control mAirList with any MIDI device, e.g. a MIDI
keyboard or a DJ controller. Incoming MIDI messages are mapped to
remote control commands.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type MIDI (Generic category).
General
On the General tab, select the MIDI input Device that mAirList should listen to.
The Monitor helps you to find out which messages your MIDI device sends.
Check Enable Monitor, then press a button or move a fader on your device.
The received messages will be displayed in the list, with their status/channel byte,
Data1 and Data2 values (decimal and hexadecimal).
Double-click a message to add it to the command list.
Commands
The Commands tab contains the list of MIDI messages that mAirList will react to,
along with the command to execute. Use the toolbar to add, edit, or remove entries.
Each entry consists of the following settings:
- Status/Channel:
The MIDI status byte, which contains both the message type and the MIDI channel,
e.g. 144 (90 hex) for a Note On message on channel 1.
- Data1:
The first data byte, e.g. the note or controller number.
- Data2 Condition and Data2 Value:
A condition for the second data byte (e.g. the velocity or controller value).
Choose one of
=, !=, <, <=, >=, > to compare the received value against
the Data2 Value, or * to match any value. - Command:
The remote control command to execute when a matching
message is received.
The variable $DATA2 in the command will be replaced by the actual Data2 value of
the received message (0 to 127). This way, a single entry with the * condition
can pass the position of a fader or rotary control on to a command.
Hint
A typical MIDI button sends a Note On message with a velocity greater than 0
when it is pressed, and a message with velocity 0 (or a Note Off message) when it
is released. To trigger a command only when the button is pressed, use the Data2
condition > with value 0.
SYSEX messages are not supported for commands.
Scripting
MIDI messages can also be processed by background scripts,
using the OnMidiMessage and OnMidiSysex event handlers. Scripts can also send
MIDI messages, e.g. to control the LEDs of a MIDI controller: Open the output device
with MidiOutOpen, then use MidiOut and MidiOutSysEx to send messages.
MidiOutListDevices writes the list of available output devices to the System Log.
7.1.3 - Serial Port
The serial port remote control allows you to receive raw
remote control commands over a serial port.
Configuration
Before you can set up this remote control, you must first configure the serial port
parameters (baud rate etc.) in the
Miscellaneous section
of the configuration.
Thereafter you can add the Serial Port remote control interface, and select
the appropriate serial port from the list.
Usage
Commands - e.g. PLAYER 1-1 START - must be sent as plain ASCII text,
terminated with a CR character (ASCII 13) each.
7.1.4 - Art-Net DMX
The Art-Net DMX interface lets mAirList control lighting equipment (e.g. ON AIR lights,
studio lighting, or LED effects) via Art-Net, the protocol for transmitting DMX over the
network. Unlike most other remote control interfaces, it does not receive commands from
an external device, but sends DMX values, triggered by
remote control commands.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Art-Net DMX (Generic category).
- Broadcast Address and Port:
The IP or broadcast address that the Art-Net packets are sent to, e.g. the address of
the Art-Net node, or the broadcast address of the network. The default is the standard
Art-Net broadcast address
2.255.255.255, port 6454. - Bind IP:
The local IP address to send from, i.e. the network interface to use. Leave empty
to let Windows choose.
- Remote Control ID:
The prefix of the commands that are handled by this interface. The default is
ARTNET. Use different IDs if you set up more than one Art-Net interface.
Commands
The following commands are available (assuming the default ID ARTNET):
ARTNET SET <universe> <channel> <value>:
Sets a DMX channel (1 to 512) of the specified universe to a value (0 to 255).ARTNET FADE <universe> <channel> <from> <to> <duration>:
Fades a DMX channel from one value to another, over the specified duration in
milliseconds.
Example: ARTNET FADE 0 1 0 255 2000 fades channel 1 of universe 0 from 0 to full
brightness within two seconds.
The commands can be used anywhere commands are accepted, e.g. in actions, event
scheduler entries, or the commands of other remote control interfaces.
7.2 - USB
This section covers remote control interfaces for USB devices: game controllers
(joysticks/gamepads), and the IO-Warrior and Velleman K8055 I/O boards, which provide
digital inputs and outputs, e.g. for GPIO connections to a mixing console.
7.2.1 - Joystick
The Joystick/Gamepad remote control lets you trigger
remote control commands with the buttons of any game
controller recognized by Windows.
This is not limited to actual joysticks: Many USB button boxes and encoder
interfaces (often sold for arcade machines or flight simulators) register as
game controllers, and are an inexpensive way to build custom button panels.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Joystick/Gamepad (USB category).
On the General tab, select the Device from the list of game controllers, or
(First available device) to use the first one found.
In the table below, you can enter a command for each button, separately for when the
button is Pressed and when it is Released. Click a cell to edit the command.
Leave the cell empty if no command should be executed.
7.2.2 - IO-Warrior
The IO-Warrior is a family of USB I/O boards by Code Mercenaries, which provide a number
of digital I/O pins. mAirList supports the IO-Warrior 24, 28, 28L, 40, 56 and 100.
Each pin can be used as an input, to trigger remote control commands,
or as an output, controlled by a script.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type IO-Warrior (USB category).
Device
On the Device tab, click Select Device… and choose your IO-Warrior from the list
of connected devices. This will fill in the Vendor/Product ID, Serial Number and
Path fields.
When a Path is set, mAirList will open exactly this device (i.e. the device connected
to this particular USB port). Clear the Path field to identify the device by its
vendor/product ID and serial number instead, so it is still found when plugged into
a different USB port.
Commands
The Commands tab lists all pins of the device. The pins are named P<port>.<bit>, e.g.
P0.3 for bit 3 of port 0, followed by a consecutive number in parentheses.
For each pin, enter the command to execute when the input goes On and Off,
respectively. Click a cell to edit the command.
The inputs are active-low: A pin is considered On when it is connected to ground
(e.g. through a switch or relay contact), and Off otherwise.
Outputs
The pins can also be used as outputs, e.g. to drive an LED or a relay, from a
background script:
IOWarriorRemote(0).SetPin(3, true);
The first parameter of IOWarriorRemote is the index of the IO-Warrior interface
(0 for the first one, if you have more than one configured).
The first parameter of SetPin is the pin number, counted from 0 (P0.0 = 0,
P1.0 = 8, etc.); the second parameter switches the output on (pulled to ground) or off.
While a pin is switched on as an output, it will not trigger any input commands.
7.2.3 - Velleman K8055
The Velleman K8055 (and its successor, the K8055N) is a USB experiment board with five
digital inputs, eight digital outputs, and two analog inputs and outputs.
mAirList can use the digital inputs to trigger remote control commands,
and set the outputs from a script.
The required driver library (K8055D.dll) is included with mAirList.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Velleman K8055/K8055N (USB category).
Device
- Device address:
The address of the board (0 to 3), as set with the jumpers on the board.
This allows you to use up to four boards on the same computer.
- Update interval:
How often (in milliseconds) mAirList polls the board for changes of the inputs.
The default is 50 ms.
Commands
On the Commands tab, enter the command to execute for each of the five digital
inputs when it goes ON, and when it goes OFF.
Outputs
The outputs can be controlled from a background script
through the following methods:
K8055Remote(0).SetDigitalChannel(1); // switch on digital output 1
K8055Remote(0).ClearDigitalChannel(1); // switch off digital output 1
K8055Remote(0).ClearAllDigital; // switch off all digital outputs
K8055Remote(0).OutputAnalogChannel(1, 255); // set analog output 1 (0..255)
The parameter of K8055Remote is the index of the K8055 interface (0 for the first one,
if you have more than one configured).
The current state of the inputs can be read with ReadDigitalChannel and ReadAllDigital.
7.2.4 - Elgato Stream Deck
mAirList can be controlled with an Elgato Stream Deck. The buttons can execute
remote control commands, or trigger cart players, with
the button color indicating the state of the cart player.
The integration consists of two parts: a remote control interface in mAirList, and a
plugin for the Stream Deck software, which connects to mAirList.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Elgato Stream Deck (USB category).
Install the Stream Deck software from Elgato, then click Click here to install the
plugin in the configuration dialog to install the mAirList plugin.
Advanced Settings:
- HTTP Port:
The port that the plugin connects to. The default is 10810.
- Allow connections from other computers:
By default, only the Stream Deck software on the same computer can connect.
Check this option to allow connections over the network, e.g. when the Stream Deck is
connected to a different computer.
Stream Deck Actions
In the Stream Deck software, the plugin provides the following actions:
- Cart Player:
Triggers a cart player (enter the Cart Number). The button shows the number of the
cart player, colored green when an item is loaded and red while it is playing.
By default, the button is only active when the cartwall is ON AIR (or in PFL or
voice tracking mode); check Enable button when OFF AIR to change this.
- Execute Command:
Executes the entered Command when the button is pressed.
If mAirList runs on a different computer, or uses a different port, enter the
Host/IP and Port in the plugin settings.
7.3 - Lawo/Studer
This section covers the integration with Lawo and Studer mixing consoles through the
SAS protocol. For Lawo consoles with Ember+ support, see also the
Ember+ section.
7.3.1 - SAS
The SAS remote connects mAirList to Lawo and Studer consoles (e.g. Lawo Zirkon,
Crystal, and Studer OnAir series) through the SAS automation protocol.
mAirList identifies the console channels by their source names: When a source is
selected on a fader, the console reports the source name, and mAirList knows which
player is on which fader. Fader start, PFL, and GPIs of the console can then be used
to control mAirList.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of the desired type (Lawo/Studer category):
- SAS (TCP/IP): Connection via network. Enter the Host name or IP of the
console/SAS interface, and the Port (default 18512).
- SAS (serial port): Connection via a serial port. Select the COM Port.
The port parameters (baud rate etc.) must be set up in the
Serial Ports section of the configuration
first.
The connection settings are found on the Communication tab.
Players
On the Players tab, select the playlist and player, and enter the Source name of
the console source that the player is connected to. Leave empty to disable the
assignment for that player.
When the fader of that source is opened (fader start), the player is started; when it is
closed, the player is stopped.
Options:
- Automatic PFL switch:
The PFL button of the fader switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped (PAUSE/STOP
command, i.e. the player is stopped if it is already paused).
Cartwall
Enter the Source name of the cartwall source. When its fader is opened, the cartwall
is switched to ON AIR mode, and back to OFF AIR mode when the fader is closed.
PFL on that fader switches the cartwall to PFL mode.
The options determine what mAirList does on the console when the cartwall mode
changes in mAirList:
- Open fader when cartwall goes ON
- Turn channel on when cartwall goes ON (Studer)
- Close fader when cartwall goes OFF
- Turn channel off when cartwall goes OFF (Studer)
Voice Tracking
Enter the source names used for voice tracking: Player A, Player B, and
Microphone. Opening the fader of the player sources starts the respective
voice tracking player; opening the microphone fader starts the voice track recording.
The fader levels of the player sources are applied to the volume of the voice tracking
players.
Other Sources
Enter the names of further console sources (one per line) that are not bound to a
player, but which you want to control with SAS actions or from scripts.
GPI
The GPI tab lists the GPIs of the console. For each GPI, you can enter the
remote control command to execute when it goes On
and Off.
Monitor
The Monitor tab displays the communication with the console, which is helpful for
troubleshooting.
Actions
The following actions (SAS category) are available, e.g. for use in event scheduler
or cartwall actions: Set fader level, Set fader input gain,
Turn on/off fader start button light, Turn on/off PFL, and Turn on/off GPI.
7.4 - Barth
This section covers the integration with mixing consoles by Barth.
7.4.1 - D.MAX
The D.MAX remote connects mAirList to a Barth D.MAX mixing console via a serial port.
mAirList receives the state of the fader start (GO), PFL, NEXT and OPT keys, as well as
the fader levels, and executes the configured
remote control commands.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type D.MAX (Barth category).
Select the COM Port that the console is connected to. The port parameters
(baud rate etc.) must be set up in the
Serial Ports section of the configuration
first.
Commands
The commands are assigned to the console inputs (1 to 32), not to the fader numbers.
mAirList keeps track of which input is currently routed to which fader, so the commands
follow the source when it is assigned to a different fader.
There is a separate tab for each key type: Fader (fader start), PFL, Next, and
OPT. For each input, enter the command to execute when the key goes ON and OFF.
A fader start only triggers the Fader command when the GO key is active and the fader
is open; closing the fader or releasing the GO key triggers the OFF command.
Volume
On the Volume tab, you can enter a command for each input that is executed whenever its
fader level changes. The following variables can be used:
$VALUE – the raw fader value as sent by the console,$DB – the fader level in dB.
Example: PLAYER 1-1 VOLUME $DB
7.5 - DHD
mAirList supports DHD mixing consoles and audio cores through three interface types:
- DHD ECP for Series 52 cores and the RM4200D/RM3200D, using the External Control
Protocol via TCP/IP or serial port.
- DHD Control API for DHD cores with firmware 10.3 or newer, using the
JSON/WebSocket-based Control API.
- DHD RM2200D for the older RM2200D console.
7.5.1 - DHD ECP (Series 52, RM4200D, RM3200D)
This interface connects mAirList to DHD Series 52, RM4200D and RM3200D consoles
through the DHD External Control Protocol (ECP). It supports fader start, PFL,
channel on/off switching, motorized faders, and the exchange of logic states in both
directions.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type DHD ECP (Series 52, RM4200D, RM3200D) (DHD category).
General
- Communication:
Select either TCP/IP, and enter the Hostname or IP and Port (default 2008)
of the DHD core, or select the Serial Port that the core is connected to.
- Console/Core Type and Firmware Version:
Select Firmware 7.x or newer, Firmware 6.x, Firmware 5.x, or RM3200D.
- Fader Level Notifications:
Determines whether the core should report fader level changes to mAirList,
either Channel-based or Fader-based, or Off.
For easier configuration, export the Audio IDs, Logic IDs and Fader Channels from DHD
Toolbox to an “Ext. DHD AudioID/LogicID Export” (*.dpx) or XML Export (*.xp5) file,
and click Import Toolbox Data to import that file.
The imported data is displayed on the Logic IDs, Audio IDs and Fader Channels tabs.
It allows you to select logics and fader channels by name in the rest of the dialog
(the … and Select Fader Channel… buttons), rather than entering numeric IDs.
Players
On the Players tab, select the playlist and player, and set up the assignment:
- Automatic Setup:
Click Select Fader Channel… to choose the fader channel the player is
connected to from the imported Toolbox data. This will fill in the fields below.
- FaderStart logic or fader number:
The logic ID of the fader start, or alternatively, a fixed fader number.
- Fader channel number:
The fader channel (used for channel on/off switching, motorized faders, and
channel labels).
- PFL logic:
The logic ID for the PFL of the channel.
In the State Indication Logics table, you can enter logic IDs that are set by mAirList
to indicate the state of the player (e.g. to light up buttons on the console).
Options:
- Automatic PFL switch:
The PFL of the channel switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped.
- Keep channel on when player is paused
- Disable channel on/off switching:
By default, mAirList switches the console channel on and off along with the player.
Check this option to disable this.
- Enable motorized fader control:
Moves the motorized fader along with the player state.
- Set channel label to item title:
Displays the title of the loaded item in the channel display of the console.
Cartwall
The Cartwall Fader settings work the same as for the players (see above). When the
cartwall fader is opened, the cartwall goes ON AIR.
In the Player Logic IDs table, you can assign logic IDs to the individual cartwall
players, to start them from the console, and to indicate their state.
The options Disable channel on/off switching and Enable motorized fader control are
also available for the cartwall.
Voice Tracking
Set up the fader assignment (fader start logic or fixed fader number, or fader channel
number with firmware 6.x and up) for the voice tracking Player A, Player B, and Mic
channels.
Logic
On the States tab, you can link global mAirList states to DHD logics. For each of the
states ON AIR, PFL active, ExtPFL active, AUTOMATION 1 active, and VT active:
- Logic: The logic that is updated when the state changes in mAirList, and/or
changes the state in mAirList when it changes on the console.
- Outgoing Logic: An optional separate logic that is only set by mAirList.
- Console is master (request current state at startup):
When mAirList connects, the current state of the logic is retrieved from the console
and applied to mAirList, rather than the other way round.
- Invert: Inverts the logic state.
On the Commands tab, you can enter remote control commands to
execute when a logic (identified by its address) goes On and Off.
Monitor
The Monitor tab displays the communication with the core, which is helpful for
troubleshooting.
Actions
The following actions (DHD category) are available: Set Logic, Set PFL,
Set all PFL off, and Set Fader On/Off.
7.5.2 - DHD RM2200D
This interface connects mAirList to a DHD RM2200D console via TCP/IP. It supports fader
start and PFL for players, the cartwall, and voice tracking, as well as commands for the
console buttons.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type DHD RM2200D (DHD category).
On the Connection tab, enter the Host name or IP and the Port (default 2200)
of the console.
Players
On the Players tab, select the playlist and player, and enter either the
Fixed fader number or the Audio Source ID that the player is connected to.
When an audio source ID is used, mAirList follows the source when it is assigned to a
different fader.
Options:
- Automatic PFL switch:
The PFL of the channel switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped.
Cartwall
Enter the Fixed fader number or Audio Source ID of the cartwall fader.
In the Player Logic IDs table, you can assign logic IDs to the individual cartwall
players.
Voice Tracking
Enter the Fixed fader number or Audio Source ID for the voice tracking
Player A, Player B, and Mic channels.
On the Buttons tab, you can enter remote control commands to
execute when a button of the console is pressed (On) and released (Off).
Monitor
The Monitor tab displays the communication with the console, which is helpful for
troubleshooting.
7.5.3 - DHD Control API
This interface connects mAirList to DHD audio cores through the
DHD Control API, a JSON-based
protocol over WebSocket, which is available from DHD firmware 10.3 onwards.
It offers the same functions as the
ECP interface (fader start, PFL, channel on/off, motorized faders, logic
exchange), and additionally supports external button lists for the cartwall.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type DHD Control API (DHD category).
General
- Core Communication:
Enter the URL of the core, e.g.
http://192.168.1.100, and the API Token
configured on the core. mAirList connects to the WebSocket endpoint (/api/ws) of the
core automatically; an https:// URL results in an encrypted connection. - Number of Faders of Virtual Mixers:
Click Retrieve to read the virtual mixers and their number of faders from the core.
This information is required to select fader channels in the rest of the dialog.
Players
On the Players tab, select the playlist and player, and set up the assignment:
- Automatic Setup:
Click Select Fader Channel… to choose the fader channel the player is
connected to.
- Mixer and Fader channel number, or fader number:
The virtual mixer and the fader channel (or alternatively, a fixed fader number) that
the player is assigned to.
The State Indication Logics and the Options are the same as for the
ECP interface.
Cartwall
The Cartwall Fader settings, Player Logic IDs and Options work the same as for
the ECP interface.
External Button List for Cart Players:
Enter the List ID of an external button list configured on the core. mAirList will
fill the list with one entry per cart player, showing its number and title, colored
green when an item is loaded and red while it is playing. Pressing an entry on the
console triggers the cart player. Set to 0 to disable this feature.
Voice Tracking
Set up the fader assignment (mixer and fader channel number, or a fixed fader number) for
the voice tracking Player A, Player B, and Mic channels.
Logic
On the States tab, you can link the global mAirList states (ON AIR, PFL active,
ExtPFL active, AUTOMATION 1 active, VT active) to DHD logics, with the options
Console is master and Invert, the same as for the ECP interface.
On the Commands tab, you can enter remote control commands to
execute when a logic (identified by its address) goes On and Off.
7.6 - Network
This section covers the remote control interfaces that work over the network
(TCP/IP or UDP). They allow other software, scripts, or devices to send
remote control commands to mAirList, or to query its status.
- The REST interface is an HTTP(S) server with user authentication, and the
recommended choice for new integrations.
- The TCP Server, TCP Client and UDP Server
interfaces receive plain text commands, one per line or packet.
- The JSON Server and JSON Client interfaces exchange
JSON data, which is processed by background scripts.
7.6.1 - REST
The REST remote (REST Remote Access) is a built-in HTTP/HTTPS server, through which
other software can execute remote control commands and query
the status of mAirList. All requests require authentication with a username and
password, or a token.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type REST Remote Access (Network category).
General
- Server Settings:
Select the Mode (HTTP only, HTTPS only, or HTTP and HTTPS), and the
HTTP Port (default 9300) and HTTPS Port (default 9301).
- SSL Certificate Files:
For HTTPS, select the Certificate and Key files (PEM format), and an optional
Root Certificate.
- User Management:
Select where the user accounts are stored: either in the local configuration
(Local configuration (auth.db file)), or in one of the configured
mAirListDB databases.
Click Manage Users… to add or edit users. When a database is selected, you
must first sign in with a database user with administrator level.
In the user management dialog, you can set up users and groups, and set their passwords.
For each user or group, the permissions determine which functions of the REST
interface they may access, e.g. Command execution, General status (read-only),
Playlist read access, Encoder status, or File Server.
File Server
The REST server can also serve static files, e.g. a custom web interface
that uses the REST API.
- Enable File Server:
Turns on the file server.
- URL Prefix:
The path under which the files are available, e.g.
www. - Document Root:
The local folder that contains the files.
- Allow unauthenticated access:
If checked, the files can be retrieved without signing in.
Authentication
Clients authenticate using HTTP Basic authentication (username and password),
or with a token (Authorization: Bearer ... header). Tokens can be obtained through the
/auth endpoint.
Endpoints
The following endpoints are available. Numbers in the path (e.g. the playlist number)
are counted from 0.
| Method | Path | Description |
|---|
GET, POST | /execute | Execute a remote control command, passed as parameter command. |
POST | /actions | Execute an action list, passed as request body. Optional parameters: playlist, timeoffset. |
GET | /status/onair | Returns the current ON AIR status (true or false). |
GET | /runtimedata/<name> | Returns the value of a runtime data variable. |
GET | /logic/<name> | Returns the value of an internal logic state. |
GET | /playlist/<n>/content | Returns the content of playlist n as JSON. |
GET | /playlist/<n>/content.xml | Returns the content of playlist n as XML. |
POST | /log/start | Log the start of an item, passed as JSON body (item, id, optional region). |
POST | /log/stop | Log the stop of an item, passed as JSON body (item, id, optional region and duration). |
GET | /encoder/summary | Returns the status of the encoder and all connections. |
GET | /encoder/connected | Returns the connection state of the encoder. |
GET | /encoder/listeners | Returns the total number of current listeners. |
GET | /encoder/silence | Returns the number of seconds the audio level has been below the silence threshold. |
POST | /encoder/streamtitle | Updates the stream title on all encoder connections, passed as parameter title. |
GET | /encoder/connection/<n>/summary | Returns the status of an encoder connection. |
GET | /encoder/connection/<n>/name | Returns the name of an encoder connection. |
GET | /encoder/connection/<n>/enabled | Returns whether an encoder connection is enabled. |
GET | /encoder/connection/<n>/connected | Returns whether an encoder connection is established. |
GET | /encoder/connection/<n>/listeners | Returns the number of listeners on an encoder connection. |
GET | /streammonitor/summary | Returns the status of the StreamMonitor and all streams. |
Example, using curl:
curl -u user:password -d "command=PLAYER 1-1 START" http://localhost:9300/execute
Further endpoints can be implemented in a background script
with the OnRESTRequest event handler.
7.6.2 - TCP Server
The TCP Server remote opens a TCP port that other software can connect to and send
remote control commands, e.g. from a telnet client, a script,
or a home automation system.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type TCP Server (Network category).
- Bind IP:
The local IP address(es) to listen on, separated by commas.
Leave empty to listen on all network interfaces.
- Port:
The TCP port to listen on. The default is 9302.
- Password:
If set, clients must authenticate before they can send commands (see below).
- Command prefix:
If set, only lines starting with this prefix (followed by a space) are executed,
and the prefix is removed before execution. All other lines are ignored.
Usage
Send one command per line, terminated by CR/LF, e.g.:
PLAYER 1-1 START
If a password is set, the first line must be AUTH <password>. mAirList replies with
AUTH OK if the password is correct, or AUTH REQUIRED otherwise. Until the client is
authenticated, all other lines are rejected with AUTH REQUIRED.
Multiple clients can be connected at the same time. Connections and disconnections are
recorded in the System Log.
A script can send data to all connected clients using the SendString and
WriteLine methods of the interface, available through TCPServerRemote(<index>).
7.6.3 - TCP Client
The TCP Client remote is the counterpart of the TCP Server: mAirList
connects to a TCP server, and executes each line received from that server as a
remote control command.
This is useful when the device or software sending the commands can only act as a
server, or to connect two mAirList instances (with a TCP Server remote on the
other instance).
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type TCP Client (Network category).
- Host name or IP and Port:
The address of the TCP server to connect to. The default port is 9303.
- Password:
If set, mAirList sends
AUTH <password> to the server after connecting.
Use this when connecting to the TCP Server remote of another mAirList instance. - Command prefix:
If set, only lines starting with this prefix (followed by a space) are executed,
and the prefix is removed before execution. All other lines are ignored.
- Dummy mode:
If checked, all incoming data is discarded and no commands are executed.
Use this option when the connection is only used to send data from a script.
mAirList connects automatically when the interface is started, and tries to reconnect
every few seconds if the connection is lost or cannot be established.
Scripting
A script can send data to the server using the SendString and WriteLine methods of
the interface, available through TCPClientRemote(<index>).
For sending a one-off string to a TCP server without setting up a remote control
interface, scripts can use the TCPSendString(Server, Port, Text) procedure.
7.6.4 - UDP Server
The UDP Server remote receives remote control commands as UDP
packets. Unlike TCP, no connection needs to be established, which makes UDP a good
choice for devices that send short, single messages, e.g. GPIO-to-network converters
or broadcast consoles with “UDP trigger” functions.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type UDP Server (Network category).
- Bind IP:
The local IP address(es) to listen on, separated by commas.
Leave empty to listen on all network interfaces.
- Port:
The UDP port to listen on. The default is 9303.
Usage
Each UDP packet must contain exactly one command, as UTF-8 encoded text, e.g.
PLAYER 1-1 START. There is no authentication, and no reply is sent.
Warning
As there is no authentication, anybody who can reach the UDP port can control
mAirList. Use the Bind IP setting and a firewall to restrict access.
Scripts can send UDP packets with the UDPSendString(Server, Port, Text) procedure,
e.g. to control another mAirList instance.
7.6.5 - JSON Server
The JSON Server remote opens a TCP port through which clients can exchange JSON
messages with mAirList. Unlike the TCP Server, the received data is
not executed as commands. Instead, it is passed to
background scripts, which can process it and send
replies. This makes it possible to implement custom protocols.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type JSON Server (Network category).
- Bind IP:
The local IP address(es) to listen on, separated by commas.
Leave empty to listen on all network interfaces.
- Port:
The TCP port to listen on. The default is 9303.
Protocol
Each message is a JSON document, encoded as UTF-8 and terminated by a null byte
(ASCII 0). Messages that are not valid JSON are ignored.
Scripting
The following event handlers are available in background scripts:
procedure OnJSONServerRemoteClientConnect(Remote: IJSONServerRemote; ClientID: cardinal);
procedure OnJSONServerRemoteClientDisconnect(Remote: IJSONServerRemote; ClientID: cardinal);
procedure OnJSONServerRemoteClientData(Remote: IJSONServerRemote; ClientID: cardinal; Data: IPersistentStorage);
procedure OnJSONServerRemoteClientDataObject(Remote: IJSONServerRemote; ClientID: cardinal; Data: IPersistentObject);
OnJSONServerRemoteClientDataObject is only called when the received document is a JSON
object (rather than an array or a single value).
To send data, use the following methods of the Remote object (or
JSONServerRemote(<index>)):
SendTo(ClientID, Data) – send to a single client,Broadcast(Data) – send to all connected clients,BroadcastExcept(ClientID, Data) – send to all clients except the specified one.
7.6.6 - JSON Client
The JSON Client remote is the counterpart of the JSON Server: mAirList
connects to a TCP server, and exchanges JSON messages with it. The received data is
passed to background scripts for processing.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type JSON Client (Network category).
Enter the Host name or IP and Port of the server to connect to.
The default port is 9303.
mAirList connects automatically when the interface is started, and tries to reconnect
every few seconds if the connection is lost or cannot be established.
Protocol
Each message is a JSON document, encoded as UTF-8 and terminated by a null byte
(ASCII 0), the same as for the JSON Server.
Scripting
The following event handlers are available in background scripts:
procedure OnJSONClientRemoteConnect(Remote: IJSONClientRemote; ClientID: cardinal);
procedure OnJSONClientRemoteDisconnect(Remote: IJSONClientRemote; ClientID: cardinal);
procedure OnJSONClientRemoteData(Remote: IJSONClientRemote; Data: IPersistentStorage);
procedure OnJSONClientRemoteDataObject(Remote: IJSONClientRemote; Data: IPersistentObject);
OnJSONClientRemoteConnect and OnJSONClientRemoteDisconnect are called whenever the
connection to the server is (re-)established or lost. Their ClientID parameter is always
0; it only exists for compatibility with the JSON Server event handlers.
OnJSONClientRemoteDataObject is only called when the received document is a JSON
object.
To send data to the server, call Remote.Send(Data) (or JSONClientRemote(<index>).Send(Data)).
For sending a single JSON document to a server without setting up a remote control
interface, scripts can use the JSONSendString(Server, Port, Data) procedure.
7.7 - Livewire
This section covers the integration with Livewire/Axia devices by Telos Alliance:
- LWRP – GPIO control of Axia consoles and xNodes via the Livewire Routing
Protocol.
- Telos VX – control of Telos VX phone systems via the Livewire Control
Protocol (LWCP).
7.7.1 - LWRP
The Axia GPIO TCP/IP Direct Interface (LWRP) connects mAirList to an Axia console or
xNode via the Livewire Routing Protocol. It uses the virtual GPIO ports of the device,
so no physical GPIO wiring is required.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Axia GPIO TCP/IP Direct Interface (LWRP) (Livewire category).
On the Connection tab, enter the Host name or IP of the device. The default port
is 93 (LWRP).
Players
On the Players tab, select the playlist and player, and enter the GPIO Number
(port 1 to 24) that is assigned to the console channel of that player.
mAirList uses the standard Axia GPIO pin assignment for console channels:
- Pin 4 (channel ON) starts the player.
- Pin 5 (channel OFF) stops the player.
- Pin 3 (PFL) switches the PFL of the player, if Automatic PFL switch is enabled.
Options:
- Automatic PFL switch:
Pin 3 switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the channel is switched off, the player is paused rather than stopped.
GPO Events
The GPO Events tab lists all GPIO ports and pins. For each pin, you can enter a
remote control command to execute when the pin goes High
and Low.
Actions
The Set GPI action (Livewire category) sets the state of the pins of a GPIO port.
For each of the five pins, select H (high), L (low), or x (no change).
7.7.2 - Telos VX (LWCP)
This interface connects mAirList to a Telos VX broadcast phone system via the Livewire
Control Protocol (LWCP). It allows scripts to monitor the state of the phone lines and to
control calls, e.g. to build a custom call screener interface.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Telos VX LWCP (Livewire category).
- Host name or IP and Port:
The address of the VX engine. The default port is 20518.
- Authentication:
The User and Password for the VX engine.
- Studio ID or name:
The studio to select after logging in, either by its numeric ID or its name.
The Monitor tab displays the communication with the VX engine, which is helpful for
troubleshooting.
Scripting
This interface does not execute any commands by itself. It is controlled by
background scripts.
To control the phone lines, use the following methods of VXLWCPRemote(<index>):
CallNumber(Line, Number) – dial a number on a line,TakeCall(Line) – take a call,HoldCall(Line, Ready) – put a call on hold,DropCall(Line) – drop a call,SelectStudio(Value) – select a different studio.
Changes of the line states are reported through the following event handler:
procedure OnVXLineEvent(Remote: IVXLWCPRemote; Line, Hybrid: integer;
Comment, State, CallState: string; Time, Cause: integer;
Busy: boolean; RemoteNumber, CallerID, Direction: string);
In addition, all LWCP messages received from the VX engine (including line events) are
passed to the OnLWCPCommand(Remote, Command, ObjectName, Data) event handler.
7.8 - Wheatstone
This section covers the integration with Wheatstone WheatNet-IP systems:
7.8.1 - WheatNet-IP Mixer
This interface connects mAirList to a WheatNet-IP mixing console (e.g. an LXE, Strata or
GSX surface) via TCP/IP, and executes remote control commands
when an input channel is switched on or off, or when its CUE is switched on or off.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type WheatNet-IP Mixer (Wheatstone category).
On the Connection tab, enter the Host name or IP of the mixer engine, and the
Port (default 55777).
On the Input Commands tab, enter the commands for each input (1 to 64) and function:
- Channel On / Channel Off
- CUE On / CUE Off
mAirList only subscribes to the events of those inputs and functions for which a command
is configured.
7.8.2 - WheatNet-IP BLADE
This interface connects mAirList to a WheatNet-IP BLADE via TCP/IP, and uses the software
logic I/Os (SLIOs) of the BLADE to exchange logic signals with the WheatNet-IP network.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type WheatNet-IP BLADE (Wheatstone category).
On the Connection tab, enter the Host name or IP of the BLADE, and the
Port (default 55776).
On the SLIO tab, enter the remote control commands to
execute when an SLIO (1 to 192) goes ON and OFF.
Scripting
SLIOs can also be read and set from background scripts
through WheatNetBladeRemote(<index>), using the methods SetSLIO(Index, State),
GetSLIOState(Index), QuerySLIO(Index) and SubscribeSLIO(Index).
7.9 - AEQ
This section covers the integration with mixing consoles by AEQ.
7.9.1 - AEQ Virtual GPIO (Capitol IP, Forum IP)
AEQ Capitol IP and Forum IP consoles can send the state of their virtual GPIOs as UDP
packets over the network. This interface receives these packets and executes
remote control commands when a virtual GPI changes its state.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type AEQ Virtual GPIO (Capitol IP, Forum IP) (AEQ category).
On the Connection tab, enter the Bind IP (leave empty to listen on all network
interfaces) and the UDP Port (default 2001). Configure the console to send its
virtual GPIO messages to the IP address of the mAirList computer and this port.
On the GPI tab, enter the command to execute when a virtual GPI (0 to 255) goes
ON and OFF.
7.10 - D&R
This section covers the integration with mixing consoles by D&R:
- AIRENCE – USB console with built-in control switches.
- AIRLAB – connected via serial port.
- AIRLITE and WEBSTATION – USB consoles, controlled through
the AIRLITE Control/WEBSTATION Control software by D&R.
- AURON – connected via TCP/IP.
- AXITE/AXUM – connected via the MambaNet protocol.
Most of these interfaces support fader start and PFL for the players, using the cartwall
with the control switches of the console (including colored button LEDs), and
assigning remote control commands to buttons and switches.
7.10.1 - D&R AIRENCE
The D&R AIRENCE is a USB broadcast mixer with built-in control switches. mAirList
communicates with it via USB, using the airence.dll driver library that is
included with mAirList.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type D&R AIRENCE (D&R category).
Players
On the Players tab, select the playlist and player, and choose the
USB channel used by this player (USB 1 to USB 4, or none). Opening and closing
the fader of that USB channel starts and stops the player.
Options:
- Automatic PFL switch:
The PFL (CUE) button of the channel switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped.
Cartwall
Check Use control switches for cartwall to control the cart players with the
control switches of the AIRENCE, and select the Buttons to use for Cartwall:
the “A” Buttons, the “B” Buttons, or both (numbered either top to bottom or
left to right).
The Color Settings determine how the button LEDs indicate the state of each cart
player: For each player state, select a Color (off, Red, Green, or Yellow),
and optionally enable Blink with a second Blink Color and a Speed.
Switches
On the Switches tab, you can assign a command to each switch (1 to 39) for when it
is switched On and Off. Switches used for the cartwall are not available here.
Advanced
- Read timeout (ms):
How long mAirList waits for data from the device in each read cycle.
- Enable debug log file:
Writes a log file of the communication, for troubleshooting.
7.10.2 - D&R AIRLAB
This interface connects mAirList to a D&R AIRLAB mixing console via a serial port.
It executes remote control commands when channels are switched
on or off, and when the ON AIR signals of the console change.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type D&R AIRLAB (D&R category).
On the Communication tab, select the COM Port that the console is connected to.
The port parameters (baud rate etc.) must be set up in the
Serial Ports section of the configuration
first.
On the Channels tab, enter the commands to execute when a channel is switched
On and Off, e.g. PLAYER 1-1 START and PLAYER 1-1 STOP for fader start.
On the On Air tab, enter the commands to execute when one of the console’s ON AIR
signals goes On and Off.
7.10.3 - D&R AIRLITE
The D&R AIRLITE is a USB broadcast mixer. mAirList does not communicate with the console
directly, but through the AIRLITE Control software by D&R, using its UDP API.
Note
The AIRLITE Control software must be installed and running on the same computer
(or on the computer specified in the Advanced settings). Please refer to the D&R
documentation for its installation and setup.
The D&R WEBSTATION is configured in exactly the same way.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type D&R AIRLITE (D&R category).
Players
On the Players tab, select the playlist and player, and choose the
USB channel used by this player, i.e. the console module that the player’s audio is
connected to (or none). Opening and closing the fader of that module starts and stops
the player.
Options:
- Automatic PFL switch:
The CUE button of the module switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped.
- Send track state:
Sends the state of the player to the console, e.g. to light up the module buttons.
- Disable remote control during voice tracking:
The fader does not start or stop the player while voice tracking is active.
- Disable remote control when channel is set to Line:
The fader only controls the player when the module is switched to its USB input.
Cartwall
Check Use control switches for cartwall to control the cart players with the
control switches of the console, and select the Buttons to use for Cartwall
(“A” Buttons, “B” Buttons, or both, numbered top to bottom or left to right).
The Color Settings determine how the button LEDs indicate the state of each cart
player: For each player state, select a Color (off, Red, or Green), and
optionally enable Blink with a second Blink Color and a Speed.
Additionally, you can select the USB channel used by cartwall, so that the fader of
that module controls the cartwall.
Modules
On the Modules tab, you can assign commands to the functions of each module
(Cue, On, Fader, Start, VT), for when the function goes On and Off.
Switches
On the Switches tab, you can assign commands to the control switches
(Button 1A to Button 8B) and the Non-Stop, Mic On and Silence Detection
functions, for when they go On and Off.
Advanced
The Host, UDP send port (default 19551) and UDP receive port (default 19550)
for the communication with the AIRLITE Control software. The default host
(127.0.0.1) assumes that the software runs on the same computer as mAirList.
The ports should not be changed unless instructed by D&R support.
7.10.4 - D&R WEBSTATION
The D&R WEBSTATION is a USB broadcast mixer. Its integration works exactly the same as
for the D&R AIRLITE, through the UDP API of the WEBSTATION Control
software by D&R, which must be installed and running. Please refer to the D&R
documentation for its installation and setup.
In the configuration app or Control Panel, go to Remote Control and add an interface
of type D&R WEBSTATION (D&R category). Please see the
AIRLITE page for a description of the settings.
7.10.5 - D&R AXITE/AXUM (MambaNet)
D&R AXITE and AXUM consoles use the MambaNet protocol for communication between their
components. mAirList joins the MambaNet network as a node, and executes
remote control commands when its actuators are switched by the
console. The required mbn.dll library is included with mAirList.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type D&R AXITE/AXUM (MambaNet) (D&R category).
General
- Communication:
Select how mAirList connects to the MambaNet network:
- TCP or UDP: Enter the IP and Port (default 34848) of the console.
- Ethernet: Communicate directly on the Ethernet layer, through the selected
network Device.
- Address and Unique ID:
The MambaNet address and unique ID of the mAirList node. Each node in the network must
have a unique ID; only change these values if there is more than one mAirList node.
Commands
On the Commands tab, enter the commands to execute when an actuator of the mAirList
node is switched On and Off. The actuators can be assigned to console functions
(e.g. buttons or fader start) in the console configuration.
7.10.6 - D&R AURON
This interface connects mAirList to a D&R AURON mixing console via TCP/IP. It supports
fader start and PFL for the players, cartwall control through the console buttons
(including colored LEDs), and commands for all buttons of the console.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type D&R AURON (D&R category).
On the Connection tab, enter the Host name or IP of the console, and the
Port (default 9000).
Players
On the Players tab, select the playlist and player, and choose the
Channel used by this player (or none). Opening and closing the fader of that
channel starts and stops the player.
Options:
- Automatic PFL switch:
The PFL button of the channel switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped.
Cartwall
- Channel used by cartwall:
The console channel that the cartwall is connected to.
- Buttons to use for Cartwall:
None, the “A” Buttons, the “B” Buttons, or both (numbered top to bottom or
left to right).
- Color Settings:
For each cart player state, select a Color (off, Red, Green, or Yellow),
and optionally enable Blink with a second Blink Color and a Speed.
On the Buttons tab, you can assign commands to the buttons of the console, for when
they are Pressed and Released. The buttons are grouped into the channel buttons,
the control buttons, and the buttons of the CRM and Studio monitoring sections.
7.11 - Sonifex
This section covers the integration with mixing consoles by Sonifex.
7.11.1 - Sonifex S0
This interface connects mAirList to a Sonifex S0 mixer via a serial port, and executes
remote control commands for fader, PFL and start button events
of the mixer channels.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Sonifex S0 (Sonifex category).
Select the COM Port that the mixer is connected to. The port parameters (baud rate
etc.) must be set up in the Serial Ports
section of the configuration first.
On the Commands tab, enter the commands for each channel (1 to 9) and event:
- Fader open / Fader close:
Executed whenever the fader is opened or closed.
- PFL on / PFL off
- Start button:
Executed when the start button of the channel is pressed.
- Fader+Start on / Fader+Start off:
Fader start, i.e. the combination of start button and fader. The start button arms
the channel (pressing it again disarms it); Fader+Start on is executed when the
fader of an armed channel is opened (or when the start button is pressed while the
fader is already open), and Fader+Start off when it is closed again.
For a typical fader start setup, use Fader+Start on and Fader+Start off to start and
stop the player, e.g. PLAYER 1-1 START and PLAYER 1-1 STOP.
7.12 - Ember+
Ember+ is an open control protocol used by many broadcast devices, e.g. mixing consoles
by Lawo and others. A device that offers its parameters is called a provider, a device
that connects to it and reads or changes those parameters is called a consumer.
mAirList can act as both:
- Ember+ Consumer – connects to an Ember+ provider (e.g. a mixing console)
and executes commands when parameters change.
- Ember+ Consumer (Lawo) – the same, with additional fader start support for
Lawo consoles.
- Ember+ Provider – offers the internal logic states of mAirList as Ember+
parameters, so they can be read and changed by other devices.
7.12.1 - Ember+ Consumer
The Ember+ Consumer remote connects to an Ember+ provider (e.g. a mixing console) via
TCP/IP, and executes remote control commands when the value of a
parameter changes.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Ember+ Consumer (Ember+ category).
Connection
- Host name or IP and Port:
The address of the Ember+ provider. The default port is 9000.
- Keepalive Interval:
If set, mAirList sends keepalive requests in this interval, so that a broken
connection is detected and re-established.
The Monitor helps you to find the parameters you are interested in. Check
Enable Monitor, then operate the device: Each parameter change is displayed in the list.
Double-click a parameter to add it to the command list.
Parameter Tree
The Parameter Tree tab displays the complete parameter tree of the provider, along
with the current values. Double-click a parameter to add it to the command list.
Commands
The Commands tab contains the list of parameter changes that mAirList reacts to.
Each entry consists of:
- Parameter:
The path of the parameter in the Ember+ tree.
- Value Condition and Value:
A condition for the new value of the parameter:
=, !=, <, <=, >=, >
compare it to the specified Value, * matches any value. - Command:
The command to execute when the parameter changes and the condition is met.
The variable
$VALUE is replaced by the new value of the parameter.
7.12.2 - Ember+ Consumer (Lawo)
This interface is a variant of the Ember+ Consumer for Lawo mixing
consoles. In addition to the generic parameter commands, it supports fader start and
PFL for the players, based on the console’s source names.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Ember+ Consumer (Lawo) (Ember+ category).
The connection settings, monitor, parameter tree, and commands are the same as for the
Ember+ Consumer. Additionally, select the console’s
Product ID, i.e. the root node of its Ember+ tree.
Players
On the Players tab, select the playlist and player, and enter the Source name of
the console source that the player is connected to (leave empty to disable).
mAirList monitors the Fader Result Start, Channel On and PFL1 active parameters of
that source, and starts and stops the player accordingly.
Options:
- Automatic PFL switch:
The PFL of the source switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped.
7.12.3 - Ember+ Provider
The Ember+ Provider remote turns mAirList into an Ember+ provider: Ember+ consumers
(e.g. a mixing console, a broadcast controller, or a monitoring system) can connect to
mAirList and read the internal logic states of mAirList, such as the ON AIR state or the
states of the players, and receive updates when they change.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Ember+ Provider (Ember+ category).
- Bind IP:
The local IP address(es) to listen on, separated by commas.
Leave empty to listen on all network interfaces.
- Port:
The TCP port to listen on. The default is 9000.
- Read-only access:
If checked, consumers can only read the parameters. Otherwise, they can also change
them, e.g. to trigger functions in mAirList.
Connections and disconnections of consumers are recorded in the System Log.
7.13 - RODE
This section covers the integration with podcast/broadcast mixers by RØDE.
7.13.1 - RØDECaster Pro, Pro II and Duo
The RØDECaster Pro, RØDECaster Pro II and RØDECaster Duo send MIDI messages over USB
when faders are moved or buttons are pressed. mAirList uses these messages for fader
start and PFL of the players, and to trigger the cart players with the SMART pads.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of the type matching your device: RODECaster Pro, RODECaster Pro II, or
RODECaster Duo (RODE category).
On the MIDI tab, select the Input Device of the RØDECaster.
Players
On the Players tab, select the playlist and player, and choose the
Fader used for this player (or none). The player is started when the fader is
opened (and not muted), and stopped when it is closed or muted. The PFL button of the
fader switches the PFL of the player.
Option:
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped.
Cartwall
The SMART Pads of the device can be used to start and stop the cart players.
To do so, configure the pads as MIDI triggers in the RØDE Central software, set them to
Custom, and adjust their configuration as follows:
- Mode: Latching
- Type: CC
- Channel: 16
- Control: the cart player number minus 1 (i.e. 0 for cart player 1)
- On/Off values: 127 / 0
Fader State
The device only reports that the MUTE or PFL button of a channel has been pressed, but
not whether the function is currently on or off. mAirList tries to reconstruct the
state by tracking all messages. If the tracked state gets out of sync, you can adjust it
on the Fader State tab to match the actual state of the faders. Click
Save as Default to store the current state as the default state when mAirList starts.
7.14 - Axel Tech
This section covers the integration with mixing consoles by Axel Tech.
7.14.1 - Axel Tech Oxygen
This interface connects mAirList to an Axel Tech Oxygen 1000, 2000 or 3000 mixing console
via TCP/IP. It supports fader start and PFL for the players and the cartwall, and
commands for the channel events.
Configuration
In the configuration app or Control Panel, go to Remote Control and add an interface
of type Axel Tech Oxygen 1000/2000/3000 (Axel Tech category).
On the Connection tab, enter the Host name or IP of the console, and the
Port (default 93).
Players
On the Players tab, select the playlist and player, and choose the console
Channel (1 to 16, or none) that the player is connected to. The fader start of
that channel starts and stops the player.
Options:
- Automatic PFL switch:
The PFL of the channel switches the PFL of the player on and off.
- Use PAUSE/STOP:
When the fader is closed, the player is paused rather than stopped.
Cartwall
Choose the console Channel that the cartwall is connected to. The fader start of that
channel switches the cartwall ON AIR and OFF AIR, and PFL switches the cartwall to PFL
mode.
Commands
On the Commands tab, you can assign remote control commands to
the events of each channel: Channel on/off, Faderstart on/off, and PFL on/off.
8 - Databases
On this configuration page, you manage the database connections of this mAirList
installation. A database connection makes an audio library (and possibly scheduled
playlists) available in mAirList, e.g. in the database browsers, the playlist
search, and for the hourly playlist loading.
In most installations, this will be a single connection to an
mAirListDB database. You can, however, set up any number of connections,
including connections to 3rd party databases.
This page is also available in the live configuration (mAirList Control Panel).
Managing Connections
The list shows all configured database connections by their caption. The following
functions are available from the toolbar:
- Add…:
Add a new database connection. A menu will pop up from which you select the type of
the new connection (see below), and the configuration dialog for
the new connection will be opened.
- Configure:
Open the configuration dialog of the selected connection.
You can also double-click the entry in the list.
- Remove:
Remove the selected connection from the configuration.
This only removes the connection, not the database itself or its contents.
- Test:
Try to connect to the selected database, and display a message if the connection
was successful (or an error message otherwise).
- Export:
Save the selected connection(s) to an
.ini file. - Import:
Add the connection(s) from a previously exported
.ini file to the list.
Import and Export are useful when setting up multiple computers that connect to the same
database: Configure and test the connection on one computer, export it, and import it
on all other computers.
Note
Each mAirListDB database has a unique Database ID, which is stored in the configuration
along with the connection. If two or more connections with the same ID are configured
(e.g. because you imported the same connection twice), an error will be logged to the
System Log at startup. Remove the duplicate connection in this case.
Connection Types
The following connection types are available from the Add… menu.
All connection types have an Advanced tab in their configuration dialog, where
you can set a Custom Caption for the connection. This caption is used for the
database throughout the mAirList GUI, e.g. in the list on this page and as the title
of the database browser.
mAirListDB (Local Mode) and mAirListDB (SQL)
These are the connection types for the built-in mAirList database, either
stored in a local .mldb file, or on an SQL server (PostgreSQL, MySQL/MariaDB, or
Microsoft SQL Server).
Creating or connecting a database, as well as all settings of these connection types,
are described in detail in the Database Setup chapter.
mAirListDB (Internet Client)
This connection type is used to access an mAirListDB database from outside the
local network, through mAirList DBServer. On the Database Server tab, enter
the host name or IP address, port, and (optional) path of the DBServer, and check
Use SSL/HTTPS if the server is set up for encrypted connections.
Please see the Remote Access chapter for more information
on DBServer and the client configuration.
iTunes
This connection type gives read-only access to an iTunes (or Apple Music) library,
by reading the library XML file exported by iTunes.
- iTunes Music Library.xml File:
Select the location of the XML file.
- Path Substitution:
If the file locations stored in the XML file are not valid on this computer
(e.g. because the library was created on a different computer), you can replace the
beginning of each path. Enter the original path prefix in the Replace… field,
and the replacement in the With… field.
- Hourly Playlist Pattern:
iTunes playlists whose name matches this pattern will be used as hourly playlists,
e.g. when the playlist for the next hour is loaded automatically.
The pattern may contain logging variables for the
date and time, for example
mAirList-%Y-%M-%D-%h (the default). The Resolves to
label shows the playlist name for the current hour.
The XML file is read when the connection is established. To make changes in iTunes
available to mAirList, the database must be reconnected.
SAM Broadcaster v4
This connection type gives read-only access to the song list of a SAM Broadcaster v4
database. On the Database Connection tab, enter the SQL connection parameters
(protocol, host name, database, user and password) of the SAM database.
The songs are presented in the database browser grouped by artist, and can be
searched and dragged into the playlist.
MusicMaster Nexus Server
This connection type connects mAirList to the MusicMaster scheduling software,
through the MusicMaster Nexus API. See MusicMaster Integration
for an overview of the different ways to use MusicMaster with mAirList.
Before adding the connection, the Nexus API must be set up on the
MusicMaster Nexus sub-page (see below). In the connection
configuration, the following settings are available:
- General tab:
- Nexus API:
Click Select… to choose one of the APIs (servers and stations) set up on the
MusicMaster Nexus sub-page.
- Options:
- Reconciliation (report song start/stop): If enabled, mAirList will report the
start and stop of each song back to MusicMaster.
- Disable automatic update of MusicMaster fields for new files: By default,
mAirList will update the MusicMaster fields (e.g. cue markers) when new files are
added. Check this option to disable this.
- Library tab:
- Song Metadata Source:
Where the mAirList-specific metadata of the songs (cue markers etc.) is read from and
stored:
- MusicMaster (read/write): Read from MusicMaster, and changes are written back.
Fields without a mapping are stored as an XML block in the field mapped as
XML Metadata.
- MusicMaster (read-only): Read from MusicMaster, but never written back.
- Other database (by Internal ID) / Other database (by External ID): The metadata
is taken from another database connection; only the schedule comes from MusicMaster.
- Other database:
For the Other database modes: the Database to retrieve the metadata from (or
(First active connection)), and the ID pattern that is used to look up the item.
Available variables are
$SONGID (the MusicMaster song ID), $DBID (the value of the
field mapped as database ID), and $VERSION (the version, see below). If the ID must
be extracted from the database ID field, enter a regular expression under
DBID RegEx; the first match becomes $DBID. - Versioning:
The XML attribute of the schedule entries that contains the version of a song,
and the Default version for entries without it.
- Content tab:
- Advertising:
Log notes whose title starts with the specified prefix are treated as advertising
placeholders, and the advertising blocks are imported from the configured
Import source. A number after the prefix is the block number, e.g.
Traffic 15
imports block 15. - External Content:
Log notes whose title starts with the specified prefix refer to a playlist file,
e.g.
EXTERNAL news.m3u, which is loaded from the specified folder (unless an
absolute filename is given). - Region Suffixes:
If Regionalization is used, enter the filename suffix
used for each region (see MusicMaster Integration).
- Colors tab:
If a MusicMaster field is mapped as Color, enter the colors for its values, one per
line, in the form
<value>=<HTML color>, e.g. A1=#FF0000.
See also the MusicMaster actions, which
can be used to synchronize the playlist with the MusicMaster schedule.
Script
This connection type lets you implement your own database connection with a script.
Select the script file on the Settings tab.
The script must implement the functions CreatePlaylistItem (create a playlist item
from an item ID) and SavePlaylistItem (save changes to an item back to the database).
The following optional functions may be implemented to provide further features:
GetCapabilities, Connect, Disconnect, IsConnected, ConnectionAlive,
SearchItems, GetPlaylist, ExecuteSQL, FillDatabaseTree, and ReverseLookup.
MusicMaster Nexus
On the MusicMaster Nexus sub-page, you set up the connections to one or more
MusicMaster Nexus API servers, which are then referenced by the
MusicMaster Nexus Server database connections and the
MusicMaster playlist importer.
The configuration dialog of each API has the following tabs:
- General:
- Nexus Server:
The URL of the Nexus server, the HTTP and Nexus usernames and passwords, and an
optional alias (caption) for this API.
- Audio Folders:
The folder where the audio files referenced by MusicMaster are stored, and an
optional cache folder. Check Store absolute filenames in MusicMaster database
to store full paths rather than paths relative to the audio folder.
- Databases:
The MusicMaster primary/child database to use, and, for MusicMaster Enterprise
setups, the Enterprise Master database (leave empty for non-enterprise setups).
- Field Mapping:
Determines which MusicMaster fields correspond to the mAirList system fields
(artist, title, etc.), attributes, and cue markers.
9 - Background Scripts
On this configuration page, you set up the background scripts that are loaded when
mAirList starts. Background scripts stay active while mAirList is running, and react to
events through event handlers. Please see the Scripting chapter
for an introduction to scripting, and the list of available event handlers.
This page is also available in the live configuration (mAirList Control Panel).
Managing Background Scripts
The list shows all configured background scripts. The following functions are
available from the toolbar:
- Add…: Add a new background script and open its configuration dialog.
- Configure: Open the configuration dialog of the selected script.
You can also double-click the entry in the list.
- Remove: Remove the selected script from the configuration. The script file itself
is not deleted.
- Export / Import: Save the selected script entries to an
.ini file, or add
entries from such a file.
Script Settings
- Filename:
The script file (
.mls) to load. - Automatically reload when changed on disk:
If checked, mAirList detects when the script file is modified, and reloads the script
automatically. This is useful while developing a script, as changes take effect
without restarting mAirList.
Messages about loading the script, as well as any errors, are written to the System Log.
10 - Logging
11 - Actions
This configuration section contains action lists that are run automatically in certain
situations, as well as action commands that let you define your own remote control commands.
The available actions and their settings are described in the
Actions reference. Both pages are also available in the live
configuration (Control Panel), so changes can be made while the playout is running.
Standard Action Lists
Select the action list you want to edit from the dropdown list at the top of the page.
Use the toolbar to add, configure and remove actions, and drag the actions with the mouse
to change their order, just like in the Event Scheduler.
The following action lists are available:
Action Menu:
The actions in this list are displayed as entries in the Actions menu of the main toolbar
of the playout window, so that they can be run manually with a single click. The custom
title of each action, if set, is used as the menu caption. A No action entry is displayed
as a separator line, which helps you to structure larger menus.
Enable the option Show confirmation dialog when run manually for actions that should not
be run accidentally.
After Startup:
Run once after the playout application has been started, e.g. to load a playlist, connect
the encoder or switch on the automation.
Before Shutdown:
Run when the playout application is closed, before it actually shuts down.
When playlist runs empty during automation:
Run when the automation reaches the end of the playlist. Use it to fill the playlist
automatically with a fallback playlist, so that there is no dead air. The list is also run once when the automation reaches an item with a fixed
start time too early, and would otherwise have to wait in silence.
Important
Avoid loading playlists from a database in this action list. If loading fails
(e.g. because of a server or network outage), the playlist is still empty, so the
action list is triggered again and again, which can freeze the playout. Instead,
load a playlist that only contains local audio files, so that the action list
reliably fills the playlist.
When entering ON AIR mode and When entering OFF AIR mode:
Run when mAirList is switched to ON AIR or OFF AIR mode, e.g. to switch a light or a
logic on the mixing console.
When PFL output is started and When PFL output is stopped:
Run when the first PFL playback starts, and when the last PFL playback has stopped.
This can be used, for example, to switch a monitor speaker relay or mute the studio
speakers during PFL.
When non-player PFL output is started and When non-player PFL output is stopped:
Same as above, but only for PFL playback that does not originate from a player, e.g. the
PFL dialog (opened from the playlist, browser or cartwall), the Mix Editor, the PFL screen
object, or the database app.
Except for the Action Menu, the actions in these lists are run in the context of the
first playlist, unless a different Affected Playlist is set in an action. The
When playlist runs empty list is run in the context of the playlist that ran empty.
Commands
On the Commands page, you can define action commands: custom remote control commands
that run an action list when they are received. This way, you can trigger any action – for
example, loading a particular playlist file – from any remote control source, such as a
hardware button, a MIDI controller, a network command, or the Execute command action.
Click Add… to create a new action command. In the dialog, enter:
- Command: The command string, e.g.
LOAD MORNING SHOW. The action list is run when
a command is received that matches this string exactly, including upper and lower case. - Actions: The action list to run.
Each command in the list has a checkbox in front of it. Uncheck it to disable the
command temporarily.
Use the Import and Export buttons to transfer action commands to another installation.
12 - Voice Tracking
On this configuration page, you set up the Voice Track Recorder: the folder and audio
format for recorded voice tracks, display and behavior options, the progress bar, and
effects that are applied to every recording.
All settings are described in the Voice Tracking
chapter.
13 - Regionalization
On this configuration page, you set the number of regions to be used in playout, the code
and name of each region, and an optional custom region mapping.
Please see the Regionalization chapter for a
description of these settings, and for an introduction to regionalization in general.
14 - Stream Monitor
On this configuration page, you set up the streams that are monitored by the Stream
Monitor, and the actions that are executed when a monitored stream goes on air or off
air.
All settings are described in the Stream Monitor
chapter.
15 - Miscellaneous
15.1 - Serial Ports
15.2 - Passwords
15.3 - System Log
15.4 - File Import
15.5 - File Management
15.6 - Hooks
15.7 - Audio Editor
15.8 - Default Directories
15.9 - Auto Cue
15.10 - Normalization
15.11 - E-Mail
15.12 - Runtime Features
15.13 - Settings
15.14 - Options
16 - Advanced
17 - Common Settings
This chapter contains a description of settings that are available in multiple parts
of the software. For example, the Progress Bar options are available for both the
progress bar in the playlist, the players, and the global progress bar object.
Time format strings (for elapsed and remaining time, ramp, etc.) can use the
following variables:
hh - hournn - minutess - secondz - 1/10th of a secondzz - 1/100th of a secondzzz - milliseconds
These variables (with the exception of z and zz) correspond to those used by the
Delphi FormatDateTime function.
An optional ! sign marks the boundary up to which the “Automatically truncate…”
options will operate. The part after the ! sign will never be truncated.
For example, the format hh:n!n:ss will display a duration of 3 seconds as 0:03.
Progress Bar
- Enable progress bar:
Uncheck to hide the progress bar.
- Show ramp in progress bar:
If enabled, the ramp part of the item will be displayed in a different color.
- Split progress bar during ramp:
If enabled, the progress bar will be split horizontally while the ramp part is playing,
with the upper part representing the ramp.
- Show only nearest ramp:
If enabled, only the next ramp marker that is reached next from the current playback
position will be displayed (for items that have more than one Ramp cue marker set).
- Enable waveform display:
Toggles the display of the waveform in the player.
- Live update:
When enabled, cue markers will be updated immediately as they are dragged, not
only when you release the mouse button.
- Show current position as line:
Toggles the display of the current playback position.
- Show segment before current position using a different color:
If enabled, a different dark-ish color is used for the elapsed part of the playback,
so the waveform can be used as some kind of progress bar.
- Show cue markers:
If enabled, the set cue markers will be displayed as colored lines.
- Show cue marker labels:
Check this option to display the name of the cue markers next to the colored lines.
- Show cue marker position:
Check this option to display the position/value of the cue markers next to the colored
lines.
- Show fade envelope:
If enabled, a graphical representation of the fade (after the Fade Out marker)
will be displayed.
- Show volume envelope:
Enables display end editing of the volume envelope.
- Show timeline:
Enables display of the timeline at bottom of the waveform.
- Show scrollbar:
Enables a horizontal scrollbar.
- Mouse navigation:
If enabled, the user can use the mouse to navigate through the waveform
(mouse wheel to zoom, click and hold to move around).
- Allow seek on mouse click:
If enabled, the current playback position can be set by clicking into the waveform.
- Read only:
Checking this option makes the entire waveform read only, e.g. no cue markers,
volume envelopes etc. can be adjusted.
Peakmeter
- Enable peakmeter:
Uncheck to hide the peakmeter.
- Show clipping indicator:
If checked, a red clipping indicator will be displayed that flashes when the signal
exceeds 0 dBFS.