Click to Display Table of Contents Navigation: Operation > Scheduling playback > Scheduler commands |
List of available scheduler commands. With some exceptions, the same commands can be called from the Cart Wall or used directly in the playlist (menu Playlist -> Add command).
Note: The event window has a wizard that can enter most of the commands for you automatically. So most of the time, there is no need to enter commands manually.
Playback control
•play
•stop
•next
•prev
Playlist
Broadcast
Scheduler
Relay
Features
•set
Ads Scheduler
Music Library
System
•run
Other
•load
•send
Play track number X in the playlist |
|
Stop playback |
|
Pause playback |
|
next FadeOut |
Proceed to the next track. If FadeOut is specified, the track currently playing will be faded out for the duration specified (in milliseconds), e.g. next 2000 - fade out current track for 2 seconds. |
Return to the previous track |
|
Launch any program or batch (.bat) file
Example: run C:\dosomething.bat run C:\AnyProgram.exe -switch1 -switch2 |
|
Create a playlist from the playlist template called preset_name. For example, there is a template named “ROCK 2 Hours” (without quotes). To generate a playlist using that template, use the following command: generate Rock 2 hours |
|
Set the volume to X (0 to 100). For example, setvol 70. Moreover, you can specify the duration (in milliseconds) for the volume to reach the desired level (syntax: setvol X time_ms). For example, setvol 70 500 will set the volume level to 70 over a period of 0.5 second. |
|
Load the filename file. The file can contain a profile (.prf), playlist (.m3u), or scheduler task list (.sdl). If the full pathname is not specified, the application will look for a profile in the \Profile folder, for a playlist in the \Playlist folder, and for a scheduler list in the \Presets\Schedule folder. A playlist will be loaded into the Main list. |
|
load text ZN:Name; filename|text |
Load the text to the tab with a notebook. ZN: - zone number (Z2, Z3) Name - tab name filename|text - path to the file from which the text should be loaded or the text itself
Example: load text "this is test" to NOTE0 tab in zone 2 load text Z2:NOTE0; this is test |
Load a random playlist from the folder specified in Path. Example: getrandomplaylist d:\music\playlists |
|
Clear the playlist. If up modified is specified, will only remove the tracks above the currently playing track. If down modified is specified, will only remove the tracks below the currently playing track. |
|
Restart the system |
|
Shut down the system and turn off the power |
|
disconnect |
connect — connect to the broadcasting server. If no parameters are specified, the application will connect to all servers specified in the settings. You can use a value from 1 to N as a parameter for connecting to a specific server. Multiple servers can be specified, comma separated e.g. connect 1,3,5. disconnect — disconnect from the server. The parameters are the same as for connect. |
scheduler off |
Temporarily turns on/off the scheduler. These commands are useful for live shows. scheduler off — suspend the scheduler. No events will be started except for ones with the “scheduler on” command. scheduler on — turn the scheduler on from the suspended state. This command works only if the scheduler was turned off using the “scheduler off” command. It doesn’t work if the scheduler was turned off manually by unchecking the “On” check box.
scheduler on also turns off the Manual option. |
streamarchive FILENAME streamarchive DURATION FILENAME |
Turn on/off the Stream Archive feature (menu: Tools -> Stream Archive)
streamarchive on - turn on Stream Archive.
Start recording and save to the specified file name: streamarchive D:\myshow.mp3
Start recording and save to the file, limit record duration to 3600 seconds: streamarchive 3600 D:\myshow.mp3 |
makelibrary LibraryName|Dir1|Dir2|... makelibrary <options> LibraryName|Dir1|Dir2|... |
Create or update a music library. Command parameters are separated with the | character.
The first parameter sets music library name. The second and following parameters are the folders to scan (including subfolders). Instead of path you can specify playlist, music library file or a single music track. When a folder or a playlist is specified, the library will be rebuilt only with tracks from specified folders/playlists. When a single file is specified, it is added to the library.
Example: Create a music library file named music, and add tracks from the “C:\Music” folder. makelibrary music|C:\Music
Example: Same as above, but adds tracks from the “C:\Music” and “D:\MoreMusic” folders: makelibrary music|C:\Music|D:\MoreMusic
Example: Using playlist as source makelibrary music|C:\playlist.m3u8
Options specify additional processing options: scan for silence, BPM, normalize tracks. It is recommended to create command with options using the Tools->Schedule library update menu in Music Library.
Example: normalize tracks with -9.0 LUFS target; trim silence; scan for mix point at -14 dB; detect BPM. Skip tracks that already scanned. makelibrary <normalize:-9.0;skip|silence:skip|mixpoint:-14.0;skip|bpm:skip> music|C:\Music
Example: normalize tracks with -9.0 LUFS target, skip tracks with level tag set makelibrary <normalize:-9.0;skip> music|C:\Music
Example: normalize tracks with -9.0 LUFS target; trim silence; scan for mix point at -14 dB; detect BPM. Re-scan tracks where values are set (no skip modifier) makelibrary <normalize:-9.0|silence|mixpoint:-14.0|bpm> music|C:\Music |
Update advertisement events and playlists. Executing this command will produce the same result as clicking the “Create playlists and event” button in Ads Scheduler. |
|
Update advertisement events and playlists on remote RadioBOSS installation. |
|
Create a backup of application settings and events, saving it to the specified file. If SQLite database is used, its backup is also created.
Example: createbackup C:\RB_backup.7z createbackup C:\RB_Backup_?yyyy-?mm-?dd.7z In the second example, a substitution macro is used. |
|
folder_path/ |
Add tracks from a folder to the playlist. If path ends with "/" then tracks will be added in random order, otherwise tracks will be added in alphabetic order
Example: D:\Music or D:\Music\ - add tracks from D:\Music folder in an alphabetic order D:\Music/ - add tracks from D:\Music folder in random order |
Downloads a file from the URL and saves it as FILENAME •To trigger a specific URL (e.g. to send a notification), without saving any file, omit the FILENAME parameter. •If a podcast keyword is specified, the URL has to specify the podcast address and RadioBOSS will select the newest podcast from the feed and download it. •When downloading from FTP, RadioBOSS will use Passive mode if username and password are specified in the URL, otherwise Active mode is used.
Example: download http://www.example.com/file1.exe D:\savedfile.ext
Example: download podcast (will download the newest podcast from the feed) download podcast http://www.example.com/podcast.xml D:\podcast.mp3
Example: download file specifying username and password for authorization download http://USERNAME:PASSWORD@www.example.com/file1.exe D:\savedfile.ext
Example: call script at specified URL but do not save anything download http://www.example.com/thescript.php |
|
Fade out the playlist playback in time_ms milliseconds. Example: fadeout 500 |
|
clr com(1-9) (dtr|txd) |
Set/clear the value at the com-port out; out can be either dtr (pin 4) or txd (pin 3). For example: set com1 dtr — set high dtr com1 level; clr com2 txd — clear (set low level) at txd com2 out. Low com-port level corresponds to –12V and high level to +12V. |
Send string text to COM-port COMX. COMX - COM port name, e.g. COM1 text - text to send |
|
|
Enable/disable OPTION.
set OPTION on - enable (turn on) OPTION. set OPTION off - disable (turn off) OPTION.
Example: set shuffle on - enable shuffle mode; set shuffle off - disable shuffle
OPTION can be one of the following: shuffle - shuffle (random playback) repeat_track - repeat track option repeat_list - repeat playlist option break - stop after current track autoamp - automatic volume control (AutoAmp) http_request - HTTP request manual - scheduler Manual mode autointro - Auto Intro
The set command can also be used to set a variable value %showname: set %showname=TEXT
The variable value %showname can be used in the HTTP request. |
Change the sound source for broadcasting encoders.
Possible SRC values: 0 - Audio mix 1 - Input 1 2 - Input 2 3 - Input 3
For more information about encoder sources please refer to this page: Broadcasting Internet radio
Example: setencodersource 0 |
|
silencedetector off |
Turn on and turn off the silence detector silencedetector on – enable silencedetector off – disable
This command can also be used for changing these parameters: silencedetector timeout N - change silence detector timeout (in seconds) silencedetector playlist FILENAME - change the name of the playlist opened upon silence detection. |
This command adds one file from the specified folder to the playlist. It can select the oldest or newest file (by the adding date), or a random file. The command selects music files and playlist files.
Syntax: getfile C:\path_to_folder [/random|/newest|/oldest] [/delete]
If a folder path contains spaces, it must be surrounded by quotes.
/random - select a random track /newest - select newest track /oldest - select oldest track /delete - delete the file after playback
Example: Play one file from the ads folder, and then delete that file from disk: getfile C:\announcements /newest /delete
If you prefer to keep the file after playback, omit the delete parameter. |
|
playrequestedsong N |
To automatically play the requested songs, use the playrequestedsong command.
Optionally, you can specify a minimum time interval (in minutes) to delay song request playback: some music licensing authorities require a delay before the requested song can be played. Example: playrequestedsong 30 - delay requested song playback for at least 30 minutes. The scheduled event with the playrequestedsong command should be set up to repeat, e.g. every 10 minutes during the time period when you want to accept song requests.
See also: Remote Control API song request actions: songrequest, songrequestclear |
Update weather data: Automatic weather announcement
Example: weather New York, US |
|
Set DTMF detector source. 1 - Input 1 2 - Input 2 3 - Input 3 URL - specify network stream URL
Example: setdtmfsource http://example.com:8000 |
|
Stops all playing "overlay playback" events |
|
disablegroup GROUP |
Enable (enablegroup) or disable (disablegroup) a group of events.
GROUP - event group name to enable/disable. Multiple groups can be specified, comma separated, e.g. enablegroup Group 1, Group 2 |
disablevo |
Enable or disable Voiceovers. |
Enable or disable Auto Intro rules. Rules names are not case sensitive.
Example: disable rules Morning and Day autointro disable Morning, Day
Example: enable Artist rule autointro enable Artist |
|
Change equalizer preset.
Example: change current preset to "Rock" eqpreset Rock |
|
Change active playlist tab. When used inside "Multiple actions" in the scheduled event, this command is always executed first, regardless of its position in the actions list.
Example: change active playlist tab to tab named "Main" playlist Main |
|
Start relaying.
1 - Input 1 2 - Input 2 3 - Input 3 URL - specify network stream URL
Example: relay network stream relaystart http://example.com/stream
Example: relay line input 1 relaystart 1 |
|
Stop relaying. |
|
Reset the "played track" status for tracks in the playlist window. |
See also