Skip to main content

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.

 

Settings for Audience Analytics

Name Default Description
cameraId 3 The ID of the camera to use. When using a device with a single camera, set this to 0.
cameraWidth 640 The width in pixels the camera should capture.
cameraHeight 480 The height in pixels the camera should capture.
cameraOrientation 0 Camera orientation (0: original, 1: +90 degrees, 2: -90 degrees, 3: 180 degrees)
analyticsUseClient true Enable Analytics reporting. (required)
analyticsServerHost 188.138.26.160 IP address or host name of Analytics reporting server.
analyticsServerPort 20001 Port of Analytics reporting server.
analyticsReconnectInterval 5 Period in seconds to send reporting data.
analyticsDeviceKey   The API key required for Analytics. (automatically generated)
analyticsDeviceId   The device ID for this screen. (automatically generated)
analyticsPreview false Show Analytics processing image. (default bottom right)
analyticsPreviewX   Preview position in pixels from left of screen.
analyticsPreviewY   Preview position in pixels from left of screen.
analyticsPreviewWidth 640 Preview width in pixels.
analyticsPreviewHeight 480 Preview height in pixels.

 

Audience Analytics debugging information

Name Example Description
analyticsError   Set if error detected performing audience analytics.
analyticsIsConnected true Is screen connected to Analytics servers.
analyticsIsConfigOk true Is the Analytics configuration OK.
analyticsKeyStatus OK The status of the Analytics licence key.

 

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.

 

Screen data added by audience analytics

Name Example Description
males 3 The number of males detected looking at the camera.
females 2 The number of females detected looking at the camera.
kids 1 The number of children detected looking at the camera.
young 1 The number of young adults detected looking at the camera.
adults 2 The number of adults detected looking at the camera.
seniors 1 The number of seniors detected looking at the camera.
kidMales 1 The number of male children detected looking at the camera.
kidFemales 2 The number of female children detected looking at the camera.
youngMales 3 The number of young males detected looking at the camera.
youngFemales 4 The number of young females detected looking at the camera.
adultMales 5 The number of adult males detected looking at the camera.
adultFemales 6 The number of adult females detected looking at the camera.
seniorMales 7 The number of senior males detected looking at the camera.
seniorFemales 8 The number of senior females detected looking at the camera.
emotionHappy 1 The number of smiling faces detected looking at the camera.
emotionNeutral 2 The number of neutral faces detected looking at the camera.
emotionAngry 3 The number of angry faces detected looking at the camera.
emotionSurprised 4 The number of surprised faces detected looking at the camera.