You can control many parts of your signage playback by using external commands. These can be sent to individual Players or entire sync groups.
All commands need to be sent to a running Presenter Player (also Player for iOS except Overlay) via TCP/ IP on port 27182 that has external control enabled. This option can be found in the Network section of the Displays tab in Player Settings.
Using Commands / Syntax (versions before 3.3.0 and on iOS device)
- <command> value:"<string>" id:"<string>" group:"<string>"
<command> is mandatory and may need a value.
id:"<string>" and group:"<string>" are optional to constrict the command to a specific group and / or Player.
All values need to be enclosed in quotation marks.
- start_playlist or start_overlay These commands will start a playlist, or overlay a playlist, respectively. The playlist must be available in current project and it must be published to the Players. Please note that if optimized publishing is active, playlists not marked for external control are not published to the system and will not be useable with the external control.
- stop_playlist or stop_overlay These stop a playlist, or overlay a playlist that has been invoked by the start commands, respectively.
start_playlist value:"Special" group:"Lobby"
This starts the playlist “Special” on all Players in the group “Lobby”.
start_overlay value:"Emergency Message"
This overlays the playlist “Emergency Message” on all Players in the network.
start_overlay value:"Sale" id:"Center" group:"Videowall1"
This overlays the playlist “Sale” on the Player “Center” in the group “Videowall1”.
This stops all overlay playlists on all Players in the network.
This stops all playlists on all Players in the group “Entrance” and continues their day schedule or default content (if they have any).
Using Commands / Syntax (versions 3.3.0 and higher)
If you are using a version 3.3.0 or later, you can to use the following commands. Please note that any commands for iPad need to use the previous format described above.
Semicolon separated commands:
In order to make sure several commands are attempted to be executed at the same time, you can separate the commands with a ';' semicolon in one line.
Example: start playlist -n "Playlist 1"; start playlist -o -n "Overlay 1"
Here's a list of some general commands.
Starts a regular playlist or other type of playlist defined by the play type:
start playtype [play_type_and_arguments ...] [-g group_name] [-p player_id]
Stops a regular playlist or other type of playlist defined by the play type:
stop playtype [play_type_and_arguments ...] [-g group_name] [-p player_id]
Important: The stop command will ignore playlist names for overlay playlists. Stopping a playlist in overlay mode requires the option -o
Refers to regular playlist:
playlist -n playlist_name | -i playlist_id [-o] [-b]
Starts a playlist or arrangement with the given name:
start playlist -n "Playlist 1"
Starts a playlist or arrangement with the given name. This will interrupt the playlist, which was playing before.
Important: The name must be quoted if it contains spaces.
All long options can be used synonymously for the short options. Short options and long options can even be mixed.
The name of the playlist. If the name has spaces, use quotation marks:
-n, -playlistname playlist_name
Example: start playlist -n "My new playlist"
Example shell command: echo 'start playlist -n "My new playlist"' | nc YourPlayerIP 27182
If this option is used, the playlist or arrangement will be played as overlay:
Starts the playlist on an overlay with the default name "Overlay":
start playlist -o -n "My Playlist"
Filter. Only if group name matches the player's group name, the command will be executed:
-g, -group group_name
Filter. Only if display_name matches the player's display name, the command will be executed:
Same as -p, -playerid:
-dy, -display display_name
Sets the fade in time in seconds:
Fade in with 1 sec:
start playlist -n "playlist" -fi 1
Sets the fade out time in seconds:
Fade out with 1 sec:
stop playlist -n "playlist" -fo 1
Fade in and Fade out of 1 sec (at the end of the playlist it will automatically fade out):
start playlist -n "playlist" -fi 1 -fo 1
Or as overlay:
start playlist -n "playlist" -o -fi 1 -fo 1
Sets a playlist to an infinite loop:
Presenter Player can also be controlled via a small Web Interface with the help of HTTP Get commands. A sample can be found here
Creating button on webpage for a Sedna network trigger command.
The main functions can be found in the main.js. With the help of this interface you can easily start Playlists using commands like this in your web browser: