Custom Settings for Premium & Lite
- 15 Oct 2024
- 5 Minutes to read
- Print
Custom Settings for Premium & Lite
- Updated on 15 Oct 2024
- 5 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Add a Custom Setting
- Navigate to the 'Players' module:
🔎︎- This can also be done via the 'Displays' module by selecting a display and clicking on the player name:
🔎︎
- This can also be done via the 'Displays' module by selecting a display and clicking on the player name:
- Select the relevant player.
- Select 'Add new' under custom settings:
🔎︎ - Enter details of the relevant setting from the table below:
🔎︎
🔎︎
🔎︎Audio settings
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| AudioMute | Bool | Whether to mute all audio on the player (global). This custom setting is available directly in the Audio setting. | Premium, Lite | False | True |
| AudioVolume | Number | Set the player's audio volume, 100 equals 100% in Windows. This custom setting is available directly in the Audio setting. | Premium, Lite | System volume | 50 |
| AudioVolumeSchedule | String | Comma separated list of 24 volumes over a 24 hour period (starts at 00.00) | Premium | System volume | 0,50,75,80,... |
| Audio.VolumeSchedule. Monday | String | Same as above, but for each day of the week. Multiple different days can be added, specify the weekday in the setting name | Premium | AudioVolumeSchedule | 0,25,75,80,... |
Download
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| ContentCachePath | String | Force use of alternative path for downloaded content. If the setting doesn't exist DISE will default to the best suitable drive. | Premium | No default | E:\MyContent |
| DownloadSchedule | String | Time of day when player is allowed to download content. Options: AlwaysOn (00:00 to 00:00), outsideBusinessHours (22:00 to 06:00), atNight (00:00 to 04:00). | Premium, Lite | No default | outsideBusinessHours |
Graphics
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| Interlaced | Bool | If active, playback will use Interlaced mode in Direct3D. | Premium | False | True |
| UseDirect3D9Ex | Bool | Change Direct3D9 Extended usage. Will change behavior of graphic card memory sharing and screen change detection (default is defined in DISEGlobal.settings, usually 1/true) | Premium | True | False |
Log
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| LogLevel | Number | Log level to use. Emergency = 0, Alert = 1, Critical = 2, Error = 3, Warning = 4, Notice = 5, Info = 6, Debug = 7. | Premium, Lite | No default | 7 |
Network
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| Network.Multicast.Enabled | Bool | Enables multicast (1 = enabled) | Premium | False | True |
| Network.UDP.Enabled | Bool | Enables UDP (1 = enabled) | Premium | False | True |
| Network.UDP.Port | Number | Assign port for UDP | Premium | No default | 1515 |
| RemoteControlEnabled | Bool | Enable remote control. | Premium | False | True |
| WebServerEnabled | Bool | Enable HTTP REST API in Replay. | Premium | No default | False |
| WebServerPort | Number | Port for HTTP REST API | Premium | No default | 8080 |
Playback
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| Debug | Bool | Show the output in windowed mode and without Always on top. | Premium, Lite | No default | True |
| DirectMovieScene ScheduleChange | Bool | Apply schedule changes as directly as possible without finishing the currently playing cache. | Premium | No default | False |
| DisablePlaybackStatistics | Bool | Disable sending statistics to server. | Premium | False | True |
| DisplayScheme | String | Force use of alternative display scheme (with extension .display scheme). If no path is included in the filename it will look in the default download directory. | Premium | 1 | Player2. display scheme |
| ExclusivePlayback | Bool | If active, playback will be done in Exclusive Direct3D mode. | Premium | True | False |
| KeepImageVideoLoaded | Bool | Never remove images/video from cache. | Premium | False | True |
| KeepWebPagesLoaded | Bool | Never remove web pages from cache. | Premium | False | True |
| LedMode | Bool | Run in windowed mode, always on top. Combine with ScreenWidth/ScreenHeight and ScreenX/ScreenY settings (see below). | Premium | No default | False |
| ScreenX | Number | The custom X position of the output window (in Windows desktop coordinates). | Premium | No default | 100 |
| ScreenY | Number | The custom Y position of the output window (in Windows desktop coordinates). | Premium | No default | 1600 |
| ScreenWidth | Number | The custom width of the output window. | Premium | No default | 320 |
| ScreenHeight | Number | The custom height of the output window. | Premium | No default | 280 |
| Playback.DateOverride | String | Used to test scheduling, write the date you wish to lock scheduling to. In the format YYYY-MM-DD HH:MM:SS. | Premium | No value = off | 2019-04- 24 09:44:00 |
| Playback.DestroyDataWaitSeconds | Number | Number to seconds to keep resources loaded in the cache before unloading. For content low in size this value can be high and for large content it should be kept low to avoid running out of system or graphic memory. | Premium | 30 | 30 |
| Playback.Resources.KeepLoaded | Bool | Never remove resources from cache. | Premium | False | True |
| PlaybackSpeed | Number | Speed up the playback for debug purposes | Premium | No default | 5 |
| PreloadCacheDepth | Number | Set number of scenes to preload in Replay | Premium | 3 | 10 |
| RestartPlaybackOnDisplayChange | Bool | If active, playback will be restarted if a change of display is detected. | Premium | False | True |
| ScreensaverMode | Bool | If the playback should only be active when the computer is idle. | Premium | False | True |
| ScreensaverDelay | Number | The amount of idle time in seconds to wait before activating the playback. | Premium | No default | 30 |
| Playback.Screensaver.TriggerName | String | If the trigger name is assigned to a channel, that channel will be defined as a screensaver, which means clicking or tapping on this channel will make this channel to be hidden | Lite | No default | trigger |
| Playback.Screensaver.Delay | Number or String | The delay of seconds before displaying screensaver. Can be set to "manual" for manual start of screensaver. | Premium | 30 | 60 |
| TestScreen | Bool | Show test screen. Default is false. | Premium | False | True |
| Viewer | String | Determines what viewer version to use for playback.Available values are - replay or presentationviewer. Replay is the legacy viewer | Premium | Presentation Viewer | replay |
| Playback.Web.Endless | Bool | Stop refresh for web page | Lite | No default | True |
| Playback.Delay | Number | Delay playback start in seconds | Premium | 0 | 15 |
| Playback.ExtractTemplateMedia | Bool | If true, the player will extract the media files from the template, then the player can achieve gapless video playback. Only works if all media is fullscreen. | Premium | False | True |
Screen
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| ForceScreenState | Number | Force power state of screen. 0 = auto, 1 = on, 2 = off. | Premium | 0 | 1 |
| Screen.AdditionalURIs | String | Comma separated list of URIs for additional screens connected using TCP or RS-232. For each entry a new screen service will be created. The following URI formats are supported- tcp://ip:port, rs232://comport:screenid. These additional screens will use the same settings as the main screen. | Premium | No default | tcp://1.2.3.4:1234, tcp://2.3.4.5:5678, rs232://com1:2, rs232://com2:3 |
| ScreenAdapter | Number | Index of screen to show on. | Premium | 0 (first screen) | 1 |
| ScreenBrightness | Number | Percentage brightness on screen (0-100). Not supported on all models. | Premium, WebOS, SSSP | Screen default | 50 |
| ScreenBacklight | Number | Percentage backlight on screen (0-100). Not supported on all models. | SSSP | Screen default | 85 |
| ScreenContrast | Number | Percentage contrast on screen (0-100). Not supported on all models. | Premium, WebOS, SSSP | Screen default | 50 |
| ScreenColor | Number | Percentage color on screen (0-100). Not supported on all models. | Premium, WebOS | Screen default | 50 |
| ScreenId | Number | ID of screen to control from player. | Premium | No default | 2 |
| ScreenInput | String | Input to use of screen. Not supported on all models. | Premium | Selected input | HDMI1 |
| ScreenMAC | String | To allow Wake On Lan for Screen. MAC Address of screen. | Premium | No default | 00-14-22-01- 23-45 |
| ScreenRotation | Number | Way of rotating the output screen content (0=No rotate, 1=90 deg. left, 2=180 deg, 3= 90 deg. right (270 deg)) | Premium | 0 | 3 |
| Screen.Script | String | A Base64-encoded script which is run every minute to query and report the screen status. | Premium | Use normal RS232/TCP screen control. | |
| ScreenSharpness | Number | Percentage sharpness on screen (0-100). Not supported on all models. | Premium, WebOS, SSSP4+ | Screen default | 50 |
| ShowMouseCursor | Bool | Show the mouse cursor | Premium, Lite | False | True |
| SimulateScreen Control | Bool | Simulate the communication with the screen, for debug. | Premium | False | True |
| WOLBroadcast | String | To allow WOL (Wake On Lan) for screen. WOL Broadcast IP. | Premium | No default | 192.168.0.255 |
Sync
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| SyncMode | String | Master or Slave. This will enable synchronization through multicast so it is important that players in sync are on the same subnet. | Premium | No default | Master |
| Network.Multicast.IP | String | The multicast IP to use for synchronization. | Premium | No default | 224.1.1.124 |
| Network.Multicast.Port | Number | The multicast IP port to use for synchronization. | Premium | No default | 4001 |
| Sync.Enabled | Bool | Enable sync mode for video display on SSSP4+ devices | SSSP4+ | False | True |
| Sync.GroupId | Number | Only screens with the same groupId will be synced if Sync.Enabled is set to true. | SSSP4+ | 5 | 23 |
System
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| RebootComputerAt | Number | Reboot the computer at specified hour every day (1 = 1 AM, 13 = 1 PM) | Premium | No default | 4 |
| RestartReplayAt | Number | Restart Replay at specified hour (24 hour-based, all days). -1 to disable. Will use the time zone locally on the player. | Premium, Lite | Premium - disabled, Lite - 4. | 6 |
| SimulateHardwareControl | Bool | Simulate the communication with hardware, for debug. | Premium | False | True |
| TimeZoneOffset | Number | Time zone offset in minutes from UTC | Premium | No default | 560 |
Variable
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| Var-X | String | Set a variable by the name "X" to the value denoted by value. | Premium, Lite | No default | CustomVariable |
| VariableDefaultScope | String | Set default Variable scope. If set to "local" to force all variable reads to try local (movie context) source first. If set to "global" local will not be tried unless specified. | Premium | local | global |
Video
| Setting | Type | Description | Compatibility | Default Value | Example Value |
|---|---|---|---|---|---|
| UseInternalRenderer | Bool | Default is "VMR9", enable to use "Internal" instead. | Premium | False (VMR9) | True |
| Video.UseAVPlay | Bool | Enable to use the SSSP AVplayer instead of the video Tag. | SSSP4+ | False | True |
| Video.UseCordovaPlayer | Bool | Enable to use the cordova plugin video player instead of the video Tag | Android | False | True |
| GaplessVideo | Bool | Select gapless video playback on Lite players | SSSP4+ | False | True |
Was this article helpful?
