Custom device properties are used to configure devices for specific behaviors for any Appspace supported device in the Appspace console. This article lists the device properties available, including their functions, default values, and value range (where applicable), as well as the supported devices.

Appspace App Device Properties

A list of device properties used in all Appspace App supported devices.

Alert Card

Direction to building exit point

• Property: card.alert.exitdirection
• Default Value: –
• Value Range: right / left / down / up / upright / downright / upleft / downleft / elevatorup / elevatordown / escalatorup / escalatordown / stairsup / stairsdown
• Value Format: Alphanumeric
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Android Device Properties

Enable in-app browser

• Property: player.media.webengine
• Default Value: inappbrowser
• Value Format: Alphanumeric
• Supported Device: All Appspace App Android based devices in device mode. Not applicable to Android TVs.
• Availability: Appspace App 2.19.2

BrightSign Device Properties

Enable UDP on BrightSign devices

• Property: remote.BrightSign.forceudp
• Default Value: –
• Value Range: true or false
• Value Format: Boolean
• Supported Device: BrightSign
• Availability: Appspace 7.0.x

Closed caption or subtitles for video

• Property: custom.media.video.cc
• Default Value: –
• Value Range: true or false
• Value Format: Boolean
• Supported Device: BrightSign
• Availability: Appspace 6.0.x

Closed caption or subtitles for Live Channels

Requires the custom.media.video.cc device property above to work.

• Property: custom.media.video.cc.BrightSign
• Value: pid=2, type=C608;;
• Value Format: Alphanumeric
• Supported Device: BrightSign
• Availability: Appspace 8.x

Enable video stretching when in interactive (channel browsing) mode

• Property: player.play.video.aspectratio
• Default Value: uniform
• Value Range:
  • stretch – video may appear stretched.
  • uniform – video may appear scaled to fit the window.
  • uniform fill – video may appear cropped.
• Supported Devices: BrightSign
• Availability: Appspace App

Output audio in both HDMI and analog output

• Property: player.BrightSign.forceac3
• Default Value: –
• Value Range: true or false
• Value Format: Boolean
• Supported Device: BrightSign devices
• Availability: Appspace App

Video overlay in advanced channel Media Zone widget

• Property: custom.media.video.layerindex
• Default Value: –
• Value Range:
  • -1: Places the video behind all graphics.
  • 0: Disables “hwz” mode completely. Widget overlays on top of the video.
  • 1: Places the video in front of all graphics (the default setting). Video is shown, but other widgets will be hidden.
  • 2: Places the video in front of all graphics, as well as a second video element. The first video is shown, but the second video and other widgets will be hidden.
• Supported Device: BrightSign
• Availability: Appspace 6.0.x

iOS Device Properties

Enable Kiosk Mode

• Property: player.ios.asam.enabled
• Default Value: –
• Value Range: true or false
• Value Format: Boolean
• Supported Device: iOS Devices
• Availability: Appspace App 2.26

Enable Kiosk Mode Option in Device Menu

• Property: player.ios.asam.allowed
• Default Value: –
• Value Range: true or false
• Value Format: Boolean
• Supported Device: iOS Devices
• Availability: Appspace App 2.26

Improve Device Menu Touch Pattern Sequence

Overrides the current touch pattern sequence used to access the Device Menu when in kiosk mode

• Property: player.devicemenu.invokepattern
• Default Value: –
• Value Range: top-left or top-right or bottom-left or bottom-right
• Value Format: Alphanumeric
• Supported Device: iOS Devices
• Availability: Appspace App 2.26

Enables Hotspot Areas to Appear as the Top Layer

Allows the next hot spot of the touch pattern sequence to appear as the top layer when the touch pattern sequence is initiated. This is particularly useful when cards or web content is displayed.

• Property: player.devicemenu.hotarea.enable
• Default Value: –
• Value Range: true or false
• Value Format: Boolean
• Supported Device: iOS Devices
• Availability: Appspace App 2.26

Customize Hotspot Area CSS Stylings

• Property: player.devicemenu.hotarea.style
• Default Value: –
• Value Range: background:<value> or border:<value>
• Value Example: player.devicemenu.hotarea.style = border: 2px solid red; background: white
• Supported Device: iOS Devices
• Availability: Appspace App 2.26

Samsung Tizen Device Properties

Enable in-app browser

• Property: player.media.webengine
• Default Value: inappbrowser
• Value Format: Alphanumeric
• Supported Device: All Appspace App Samsung Tizen based devices in device mode.
• Availability: Appspace App 2.22.3

Channel Browsing Display Settings

Change channel title text color

• Property: player.play.themesettings.home.channel.title.color
• Default Value: –
• Value Range: RGB Hex code (#FFFFFF), or RGBA (255,0,0,0.5)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Change channel group title text color

• Property: player.play.themesettings.home.channelgroup.title.color
• Default Value: –
• Value Range: RGB Hex code (#FFFFFF), or RGBA (255,0,0,0.5)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Change channel background color

• Property: player.play.themesettings.home.background.color
• Default Value: –
• Value Range: RGB Hex code (#FFFFFF), or RGBA (255,0,0,0.5)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Download content locally

• Property: play.cache
• Default Value: –
• Value Range: videos or all
• Value Format:
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Enable persistent back button for channels in full screen

• Property: player.play.themesettings.channel.fullscreen.back 
• Default Value: false
• Value Range: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Set placement of persistant back button for channels in full screen

• Property: player.play.themesettings.channel.fullscreen.back.placement
• Value Range:
  • topleft
  • topright
  • bottomright
  • bottomleft
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Hide channel group title on Home, Recently Added, and Channel Group screens

• Property: player.play.themesettings.home.channelgroup.title.enable
• Default Value: true
• Value Range: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Hide Cursor

• Property: player.cursor.visibility
• Default Value: hidden / auto / visible
• Value Range: String
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Hide Search icon

• Property: player.play.themesettings.home.search.enable
• Default Value: true
• Value Range: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Hide Sidebar

• Property: player.play.themesettings.home.sidebar.enable
• Default Value: true
• Value Range: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Customize sidebar text color

• Property: player.play.themesettings.home.sidebar.color
• Default Value: –
• Value Range: RGB Hex code (#FFFFFF), or RGBA (255,0,0,0.5)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Customize sidebar background color

• Property: player.play.themesettings.home.sidebar.backgroundcolor
• Default Value: –
• Value Range: RGB Hex code (#FFFFFF), or RGBA (255,0,0,0.5)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Customize sidebar highlight and accent color

• Property: player.play.themesettings.colors.accent
• Default Value: –
• Value Range: RGB Hex code (#FFFFFF), or RGBA (255,0,0,0.5)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Enable background scroll

• Property: player.play.themesettings.home.background.scroll
• Default Value: –
• Value Range: scroll, blur, or none
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Customize background scroll behaviour

• Property: player.play.themesettings.home.background.behavior
• Default Value: true
• Value Range: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Enable Logo

• Property: player.play.themesettings.home.logo.enable
• Default Value: true
• Value Format: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Enable Clock

• Property: player.play.themesettings.home.clock.enable
• Default Value: true
• Value Format: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Customize Clock color

• Property: player.play.themesettings.home.clock.color
• Default Value: –
• Value Range: RGB Hex code (#FFFFFF), or RGBA (255,0,0,0.5)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Customize Clock format

• Property: player.play.themesettings.home.clock.format
• Default Value: –
• Value Format: HH:mmA (clock will display as 14:29PM)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Set content to play entire playlist once, before returning to main menu

• Property: player.play.themesettings.playlist.endofplaylistbehaviour
• Default Value: –
• Value Range: “goback”
• Supported Devices: All Appspace App based devices
• Availability: Appspace App 1.24

Play single/default content during idle time – Behaviour

Important

For idle behaviour to work correctly, both the player.play.idle.behaviour and player.play.idle.duration device properties must be added to the device.

• Property: player.play.idle.behaviour
• Default Value: –
• Value Format:
  • lastused
  • live=<channel_number>
  • sign=<sign_ID>
  • channel=/<Channel Group Name>/<Channel Name>
  • channel=/channels/<Channel Name>
  • channel=live video streams/<Live Channel Name>
• Supported Devices: All Appspace App based devices
• Availability: Appspace App 1.31

Note

For live video streams, you may use the virtual group name ‘Live Video Streams/<Live channel name>’, as a replacement to using the live channel number. eg: [channel=/Live Video Streams/FTV]

Play single/default content during idle time – Duration

• Property: player.play.idle.duration
• Default Value: –
• Value Format: <idle timeout in seconds>
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Display the recent Channels or Content on the Home screen

• Property: player.play.themesettings.home.channelgroup.summary
• Default Value: –
• Value Range:
  • channel
  • content
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Sort live channels in the Home and Channel Group screens

• Property: player.play.themesettings.home.livechannels.sortby
• Default Value: name
• Value Range:
  • name
  • number
  • code
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Enable Recently Added channels

• Property: Player.play.themesettings.home.recent.enable
• Default Value: True
• Value Format: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Configure channel rows

• Property: player.play.themesettings.home.channelrows.count
• Default Value: –
• Value Range: any number (integer)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Configure channel columns

• Property: player.play.themesettings.home.channelcolumns.count
• Default Value: –
• Value Range: any number (integer)
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Configure on-screen engagement

• Property: player.social.qrcode.enable
• Default Value: True
• Value Range: Boolean
• Supported Devices: All Appspace App based devices
• Availability: Appspace App

Device Publishing

Display Exclusive Playlist Chanel

• Property: player.play.exclusive.channel
• Default Value: <Playlist Channel ID> or <Playlist Channel Name>
• Supported Device: All Appspace App 2.x based devices
• Availability: Appspace 8.0.x

Device Display Settings

App display rotation on the player

• Property: display.rotation
• Default Value: –
• Value Range: -90, 0, 90, 180, 270 (degrees)
• Supported Device: All Appspace App based devices
• Availability: Appspace 6.0.x

App display automatically reloads to fit the size or orientation

• Property: display.responsive
• Default Value: true
• Value Range: Boolean
• Supported Device: All Appspace App based devices
• Availability: Appspace 6.0.x

Reload App display on resize

• Property: display.onresize.reload
• Default Value: false
• Value Range: Boolean
• Supported Device: All Appspace App based devices
• Availability: Appspace 8.0.x

Room Schedule and Schedule Board Cards

Note

For information on Room Schedule card, refer to Single-Room Scheduling.

Display “You Are Here” icon for Maps

The below device property uses the Point Of Interest ID to determine the device location.

• Property: card.schedule.map.locationid
• Default Value: <POI ID>
• Value Range: –
• Value Format: Alphanumeric
• Supported Device: All Appspace App based devices
• Availability: Appspace App

The below device property uses the Point Of Interest coordinates to determine the device location.

• Property: card.schedule.map.location
• Default Value: “coordinates”:[###,###],”floorNumber”:#}
• Value Range: –
• Value Format: Numeric
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Note

Please refer to the Configure You Are Here Indicator article for configuration instructions, or how to retrieve the Point of Interest ID or coordinates from Maps.

Display meeting room capacity

• Property: card.room.capacity
• Default Value: –
• Value Range: –
• Value Format: Numeric
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Note

The Room Schedule card will display the room capacity from 1 to 100, anything more than 100 would be displayed as >100.

Display meeting room facilities

• Property: card.room.facilities
• Default Value: –
• Value Range:
  • Ethernet
  • Phone
  • Projector
  • VideoConference
  • Whiteboard
  • Wifi
  • Screen Share
• Value Format: <facility 1>,<facility 2>, <facility 3>
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Display meeting room label

• Property: card.room.label.room
• Default Value: –
• Value Format: Alphanumeric
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Display meeting room Resource ID

• Property: card.room.roomid
• Default Value: –
• Value Range: –
• Value Format:
  • resource e-mail <address@outlook.com> : If Microsoft Outlook Calendar is used.
  • resource id <numeric id> : If Google Calendar is used.
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Display meeting room name

• Property: card.room.roomname 
• Default Value: –
• Value Range: –
• Value Format: Alphanumeric
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Display meeting room notes

• Property: card.roon.roomnotes 
• Default Value: –
• Value Range: –
• Value Format: Alphanumeric
• Supported Device: All Appspace App based devices
• Availability: Appspace App

Video Wall/Synchronized Playback

Assign tile ID in numeric to device, to form a video wall

• Property: player.videowall.tileid
• Default Value: –
• Value Format: Numeric
• Supported Devices: All Appspace App-based devices supporting synchronized playback/video walls
• Availability: Appspace App 1.50

Define pre-load time in seconds for content

• Property: player.content.preloadtime
• Default Value: –
• Unit: sec
• Value Format: <x seconds>
• Supported Device: All Appspace App-based devices supporting synchronized playback/video walls
• Availability: Appspace App 1.50

Note

This will help to adjust content playback on devices that take a longer time to load and play, i.e. low powered devices, so it will play in a synchronized manner.

Recommended preload time:

LG WebOS: 3.5 seconds, Chrome: 1.5 seconds, UWP: at least 2 seconds

Enable/disable overlay on debug information screen

• Property: player.clocksync.debug
• Default Value: –
• Value Range: true or false
• Value Format: Boolean
• Supported Device: All Appspace App-based devices supporting synchronized playback/video walls
• Availability: Appspace App 1.50

Enable synchronized playback at layout level

• Property: player.scheduling.mode
• Default Value: –
• Value Format: synchronized
• Supported Devices: All Appspace App-based devices supporting synchronized playback/video walls
• Availability: Appspace App 1.50

Set controller device IP used by worker device to synchronize clock

• Property: player.clocksync.controller.ip
• Default Value: –
• Value Format: IP address <xxx.xxx.xxx.xxx>
• Supported Device: All Appspace App-based devices supporting synchronized playback/video walls
• Availability: Appspace App 1.50

Set device as a controller or worker

• Property: player.clocksync.mode
• Default Value: –
• Value Format: controller or worker
• Supported Device: All Appspace App-based devices supporting synchronized playback/video walls
• Availability: Appspace App 1.50

Split canvas into grid of tiles to match number of displays

• Property: player.videowall.tilematrix
• Default Value: –
• Value Format: x,y (x is horizontal number of screens, y is vertical number of screens)
• Supported Devices: All Appspace App-based devices supporting synchronized playback/video walls
• Availability: Appspace App 1.50