Screens tab
Use the Screens tab to view and manage the devices connected to the platform.
The following options are available:
 | Click to display the Screen dialog. Use this dialog to connect a new device to the platform. |
 | Click to display the search field and two dropdown menus which enable you to control which items and columns are displayed in the list.In the top dropdown menu, you can select a specific group to restrict the list to displaying only screen items associated with that group.In the bottom dropdown menu, you can select which columns to display in the list. |
 | Click to refresh the list to reflect the latest changes. |
 | Click to filter the displayed items by specific values. You can filter by connectivity, warnings, or custom status. |
 | Click to download the data on the tab as a CSV file. All data will be downloaded, even if it is currently filtered from view. |
 | When you have one or more screen items selected, click this button to display the Multiple selection dialog. Use this dialog to set permissions, add items to a group, and control access to all selected items. |
Screen data
Advanced functionality can be configured by special variables added to screen data. Data variables are listed below:
| Name | Default | Example | Description |
|---|---|---|---|
showStatusIcon | false | true | Show a small status icon in the bottom right when downloading media or there are communications problems. |
blackCondition | false | time.between("18:00", "06:59") | When condition is true no images or videos will be displayed and the screen output will be black. CL |
standbyCondition | false | When condition is true the app will exit. Please note the device will not enter standby and turn off the screen until the sleep period configured in the Android OS. The app will restart after standbyPeriod and check the condition again. CL | |
standbyPeriod | 3600000 | The period to remain in standby. After this period the app will resume. | |
restartTime | 03:00 | The time the app should restart. Comma separated list supported. DS Loader version 12.3+ and Player version 10.7+ required. Ignored until app active for 1 minute to prevent restart loops. System clock and time zone must be correct. | |
exitTime | 19:00 | As above except app exits and does not restart. | |
rebootTime | 00:00 | As above except reboot command issued. Requires rooted device and support for reboot shell command. | |
background | #000000 | #FFFFFF | The background colour to display behind other content. Also sets a colour for the video blanker which masks black video when starting and stopping videos. |
videoBlankerPeriod | 250 | 100 | The period in milliseconds when a video starts and stops to display the video blanker. (requires background) |
internetBlobsCondition | true | time.hour() == 3 | When true images and videos will be downloaded from the Internet if not available on the local network. CL |
intranetBlobsCondition | true | When true images and videos will be downloaded from other devices on the local network. CL | |
blobstoreInternal | true | When true internal storage will be used to store images and videos. | |
blobstoreExternal | true | When true external storage will be used to store images and videos when the internal storage has less than 128MB available. Please note, on modern devices external storage is a second internal partition. To use an SD card or USB mass storage device you must specify the full path using blobstoreDir. | |
blobstoreDir | /mnt/external_sd | Additional paths suitable for storing blobs. This path will be used if internal and external locations are disabled or have less than 128MB available. It is recommended that you create a directory on the storage device and use the full path because the root may be limited to 512 files. Multiple additional paths can be specified using blobstoreDir_0, blobstoreDir_1 etc. | |
blobTransferRateMin | 10240 (10 KiB/s) | The minimum acceptable transfer rate for downloading. If the transfer rate drops below this value the download will be terminated and retried later. | |
blobTransferRateMax | 104857600 (100 MiB/s) | The maximum acceptable transfer rate for downloading. Some devices can not play HD video content at full frame rate while downloading at high speed. For these devices try reducing to 1 MiB/s (1048576). | |
widthOverride | 640 | The width of the desired output. (widthOverride and heightOverriderequired) | |
heightOverride | 480 | The height of the desired output. (widthOverride and heightOverriderequired) | |
xOverride | 100 | The x position of the desired top left of output. (widthOverride and heightOverriderequired) | |
yOverride | 100 | The y position of the desired top left of output. (widthOverride and heightOverriderequired) | |
collectedDataTarget | A server endpoint to POST collected data such as email addresses. | ||
webviewAllow | https://www.example.com/* | Only allow the webview to access websites matching this pattern. To add multiple, suffix with a number starting with _0. E.g. webviewAllow_0=... webviewAllow_1=.... This setting restricts main address and iframe addresses but not resources loaded by the page. | |
webviewReuse | 10 | The number of WebView components to cache and reuse. Speeds up rendering web pages that display more than once. Set to 0 to disable. | |
webviewReusePeriod | 600000 | The period in milliseconds a cached WebView should reuse content and avoid reloading the page. | |
maxBitmapCacheSize | 20000000 | The maximum RAM (in bytes) that will be used to cache bitmap images. Default is half memMax. | |
manageSystemUiVisibility | true | false | Attempt to hide the System UI. Disable this option if touch events are ignored. |
password | password | Adds a password field to the exit dialog. Password typed must match this password to exit. | |
encryptPlayerComms | true | Forces player communications to use an encrypted and digitally signed connection. |
CL = Conditional logic supported, for example time.between("18:00", "06:59") will automatically enable the setting between 6pm and 6:59am.
Screen data sent by players
Devices will periodically send the following data to the server. This data can be used in conditions to control if an item displays. For example the condition screenWidth > 1000 would ensure the item only displays if the width of the screen is greater than 1000 pixels.
| Name | Example | Description |
|---|---|---|
freeSpace_0 | 121321321 | The number of bytes of free space on the primary storage device. |
freeSpace_1 | 1584680960 | The number of bytes of free space on the secondary storage device. |
gpsAltitude | 22.299999237060547 | The GPS altitude of the device. |
gpsBearing | 0.0 | The GPS bearing of the device. |
gpsLatitude | 51.19537291 | The GPS latitude of the device. |
gpsLongitude | 0.27393845 | The GPS longitude of the device. |
gpsSpeed | 1.5206907 | The GPS speed of the device. |
hardware | mako | The hardware label assigned to the device. |
hardwareBoard | MAKO | The hardware board label assigned to the device. |
hardwareBootloader | MAKOZ30d | The hardware bootloader label assigned to the device. |
hardwareBrand | google | The hardware brand label assigned to the device. |
hardwareBuild | KTU84P | The hardware build label assigned to the device. |
hardwareDevice | mako | The hardware device label assigned to the device. |
hardwareId | KTU84P | The hardware ID assigned to the device. |
hardwareManufacturer | LGE | The hardware manufacturer label assigned to the device. |
hardwareModel | Nexus 4 | The hardware model label assigned to the device. |
hardwareProduct | occam | The hardware product label assigned to the device. |
hardwareSerial | 004efcdb18961386 | The hardware serial assigned to the device. |
hardwareTags | release-keys | The hardware tags assigned to the device. |
hardwareType | user | The hardware type label assigned to the device. |
hardwareVersionCodename | REL | The hardware version codename assigned to the device. |
loaderUdpPort | 44326 | The port used to communicate directly with this device using UDP. |
loaderVersion | 2.6 | The version of the loader codebase connecting this device to the server. |
memFree | 439568 | The number of bytes of free RAM in the active JVM the loader runs in. |
memMax | 201326592 | The maximum number of bytes available to the JVM for code execution. |
memTotal | 14163968 | The total number of bytes the JVM has allocated. |
requiredDataAvailable | 355141 | The number of bytes available locally to play the currently active sequence. |
requiredDataTotal | 355141 | The number of bytes required to play the currently active sequence. |
screenDpiX | 319.79 | The number pixels per inch vertically. (often inaccurate) |
screenDpiY | 318.745 | The number pixels per inch horizontally. (often inaccurate) |
screenHeight | 1184 | The number of pixels on the screen vertically. |
screenWidth | 768 | The number of pixels on the screen horizontally. |
totalData | 355141 | The number of bytes stored on the device for sequence playback. |
wifiSignalLevel | 90 | The strength of the WiFi signal. |
wifiSpeed | 65 | The speed in megabits of the active WiFi connection. |
wifiSsid | SKY56566 | The SSID of the access point WiFi is connected to. |
plugged | 2 | The power status. Returns a value greater than 0 if the device is plugged in to mains power. This data is useful in the standbyCondition. |
Scrolling text
Scrolling text can be added in the Screen dialog within the Display > Text tab. Further customisation can be added by entering the following options on the Data tab of the Screen dialog:
| Name | Default | Example | Description |
|---|---|---|---|
scrollingText | My Text | Set to scroll custom text on the screen. (Android only) | |
scrollingTextSpeed | 200 | Scrolling text speed in pixels per second. | |
scrollingTextGravity | bottom | Position the scrolling text should be rendered. | |
scrollingTextSize | 100 | Text size of the scrolling text in pixels. | |
scrollingTextColor | #FFFFFF | Color of the scrolling text. | |
scrollingTextBackgroundColor | #000000 | Color of the background behind the scrolling text. | |
scrollingTextPadding | 10 | Padding between scrolling text and edge of screen. | |
scrollingTextCondition | true | When true and scrollingText set, the scrolling text will be displayed. CL |
CL = Conditional logic supported, for example time.between("18:00", "06:59") will automatically enable the setting between 6pm and 6:59am.
Scrolling text can be added as data to the screen, sequence, or item.
If scrolling text is set on a screen it can be overridden by an item. For example, adding scrollingTextCondition=false to an item would hide the scrolling text while the item is displayed.
Digital clock
A clock can be displayed on the screen. The following values are used to set and style the clock and can be added on the Data tab of the Screen dialog.
| Name | Default | Example | Description |
|---|---|---|---|
timePattern | HH:mm:ss | Patten to define date/time formatting. Set to show time. (Android only) | |
timeGravity | top right | Position the date/time should be rendered. | |
timeTextSize | 100 | Text size of the date/time in pixels. | |
timeTextColor | #FFFFFF | Color of the text used for drawing date/time. | |
timePadding | 10 | Padding between date/time and edge of screen. | |
timeZoneOverride | Europe/London | Timezone used to display current time. This will override the devices configured time zone. |
Audio volume
The volume of audio playback can be controlled by setting volume to a value between 0 and 1. The volume setting can be added on the Data tab of the Screen, Sequence, or Stack item dialogs.
If the volume is set on a screen it can be overriden by an item. For example, adding volume=0 to a video item would mute the volume when it plays.
| Name | Example | Description |
|---|---|---|
volume | 0.5 | Set the volume of the audio. (Android only) |
Screen brightness
For devices that have full control of the screen (such as tablets and embedded devices) the backlight brightness can be controlled by setting screenBrightness to a value between 0 and 1. The brightness setting can be added on the Data tab of the Screen, Sequence, or Stack item dialogs.
If brightness is set on a screen it can be overridden by an item. For example, adding screenBrightness=1 to an image would set maximum brightness when it displays.
| Name | Example | Description |
|---|---|---|
screenBrightness | 0.5 | Set the brightness of the screen. (Android with built in screen only) |
Screen orientation
The screen orientation can be controlled by setting orientation to one of the values below. This option will override the internal orientation sensor. Please note most Android TV devices ignore this setting, so it is always best to configure orientation within Android settings.
| Name | Value | Description |
|---|---|---|
orientation | 6 | Set landscape orientation |
orientation | 8 | Set reverse landscape orientation |
orientation | 1 | Set portrait orientation |
orientation | 9 | Set reverse portrait orientation |
Note: Please see Android Documentation for more orientation settings
Barcodes and Near Field Communication (NFC)
Scanning Barcodes
Barcodes are automatically read when a USB barcode reader is connected (keyboard emulation). If an event is configured with a matching barcode trigger, the action will be performed.
Scanning NFC tags
NFC tags are automatically read when placed near the device. If an event is configured with a matching NFC trigger, the action will be performed.
Examples:
- Display an image, video, or sequence when a specific barcode or NFC tag is scanned.
- Display a web page from by a 3rd party service related to the scanned barcode or NFC tag.
- Automatically add data to the screen to control volume, standby, brightness or advanced stack item conditions with custom barcodes and NFC tags.
To display a dynamic web page for many barcodes, add ~barcode in the address for the web page action. This will be replaced with the barcode. For example http://www.example.com/shopping.php?barcode=~barcode would display the web page http://www.example.com/shopping.php?barcode=123456789 if the barcode 123456789 was scanned. Use ~nfcTagText for NFC tags.
Send phone to a custom web address
A phone or tablet with NFC support can also be placed near a digital signage player to open a web browser and load a web page. To configure the destination web page address, set nfcUrl to the address of a web page. The nfcUrl setting can be added as data to the screen, sequence or item.
To complete the NFC transfer, the digital signage screen must be touched.
| Name | Example | Description |
|---|---|---|
nfcUrl | http://www.example.com | Send a phone or tablet near to the screen to a web address. |
Note: NFC does not function when the digital signage player runs above the Android screen lock.
Beacons
Bluetooth low energy (BLE) beacons and the physical web
Screens running Android 5.1+ and supported BLE hardware can broadcast a beacon. The beacon can be received by nearby devices to perform actions on the screen.
See Physical Web for more information. UPDATE 2020, Most devices no longer listen for BLE.
| Name | Example | Description |
|---|---|---|
beaconConfig | blepw | Enable the default BLE Physical Web implementation. |
beaconConfig | http://example.com | Override the default implementation and direct user to custom address. Note: Eddystone URL Spec restricts this to 17 characters. |