This is an old revision of the document!
−Table of Contents
Actions
Using “Actions”, you can execute various tasks in mAirList, bound to (timed) events.
Actions can be used in various places:
- In the Event Scheduler
- As “Actions on Start” or “Actions on Stop” in the properties of any playlist item
- Inside any Trigger in the Cartwall
- In any of the “standard action lists” (managed on the Actions page in the config app):
- After Startup
- Before Shutdown
- When playlist runs empty during automation
- When entering ON AIR mode
- When entering OFF AIR mode
- When PFL output is started
- When PFL output if stopped
- When non-player PFL output is started
- When non-player PFL output if stopped
- In the “Action Menu” in the playout window (also managed on the Actions page in the config app) – a new button Actions will appear in the main toolbar as soon as you add actions to this list, with a dropdown menu that contains the actions you defined.
- In the Stream Monitor
- etc.
Adding and Configuring Actions
All of the places that support actions, mentioned above, have a section in the GUI where you manage the list of actions to be executed. For example, this is how it looks in the Event Editor:
The toolbar contains buttons to add, delete and configure events, and to load/save the entire list from/to XML files.
The configuration settings largely depend on the type of action – see description below. But all actions have the same Options tab:
The following settings are found here:
- Custom Title: Enter a custom title for the action if desired; particularly useful for the Action Menu.
- Enable substitution of variables: If enabled, you can use logging variables, e.g. for the current date/time, in the action configuration. This setting applies to all actions that accept filenames.
- Show confirmation dialog when run manually: Applies to the Action Menu which will request confirmation from the user before executing the action when this option is set.
- Time adjustment: This setting allows you to change the current/date time (only for the scope of this action) while the action is executed. In particular, it will affect the date/time that is used for the substituation of logging variables.
- Affected playlist: Select the playlist that this action should work on; mainly applies to all actions that maninpulate the playlist (e.g. “Load and play playlist”).
Action Description
This section describes all available actions and their options.
Miscellaneous
Execute command
Executes any of the fader start commands.
Work an action list
Serves as a container for other actions, can be used to nest actions for easier management.
Emergency actions
Normally, when an action fails due to an error, the execution of the entire action list is aborted. When you add an Emergency actions action to the end of the list however, the execution will jump to that emergency actions and execute all actions found inside it. If you are a developer, this is pretty much like a try..finally block.
No action
Just a dummy…
Download file
Downloads a file via HTTP or FTP and saves it under the given filename. Can be used together with the Event Scheduler to implement a very simple download manager.
Send e-mail
Send an e-mail. Enter the recipient, subject and body. Note: Sender address and name as well as the SMTP server must be configured in the config app first.
Run script
Runs a script (*.mls file).
Send data to serial port
Sends data to a serial port, which must already be open (e.g. by using a Serial Port Remote Control). The data is sent in ANSI encoding by default. In order to send binary data, enter a dollar sign followed by the hexadecimal data, e.g. $C0BA0003
.
File
Insert File
Inserts the specified file at the top of the playlist, or below the currently playing item. You can use logging variables in the filename if substitution is enabled on the Options tab.
Plays File
Inserts the specified file at the top of the playlist, or below the currently playing item, and starts it immediately. You can use logging variables in the filename if substitution is enabled on the Options tab.
This action only works in AUTOMATION mode, as it uses the AUTOMATION x NEXT
command internally. In ASSIST mode, the file is only inserted but not played.
Playlist
Note: All “Playlist” actions accept logging variables inside the filename if substitution is enabled on the Options tab.
Load playlist
Loads the specified playlist file. The current playlist content (except for any playing items) is discarded.
Load and play playlist
Loads the specified playlist file, and issues an AUTOMATION NEXT command so that the automation jumps to the first item. Only works in AUTO mode.
Insert playlist
Inserts a playlist file at the top of the current playlist, or below the currently active item.
Insert playlist
Inserts a playlist file at the top of the current playlist, or below the currently active item, then issues an AUTOMATION NEXT command so that the automation jumps to the first item. Only works in AUTO mode.
Append playlist
Appends the specified playlist file to the current playlist.
Shuffle playlist
Shuffles the current playlist content.
Automation
Enable automation
Switches to AUTO mode.
Disable automation
Switches to ASSIST mode.
Start automation playback
Equivalent to clicking the PLAY button in the automation toolbar.
Fade to next item
Equivalent to clicking the NEXT button in the automation toolbar.
Stop automation playback
Equivalent to clicking the STOP button in the automation toolbar.