SpinetiX HMP series Guide

HMP Configuration
API
SpinetiX Technical Documentation
Document version: 3.1
Related firmware: 4.2

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 2 of 58
www.spinetix.com
Revision history
Revision
number
Revision
date
Author
Summary of changes
1.0
Apr 22, 2011
Julien Reichel
Original “HMP Configuration Backup” document.
1.1
Jan 23, 2012
Julien Reichel
Changes related to 2.2.4 firmware release.
1.2
Sep 07, 2012
Julien Reichel
Changes related to 2.2.5 firmware release.
1.3
Apr 19, 2013
Julien Reichel
Changes related to 3.0.0 firmware release.
1.4
Jan 15, 2014
Julien Reichel
Changes related to 3.0.3 firmware release.
1.5
Oct 10, 2014
Julien Reichel
Changes related to 3.1.0 firmware release.
1.6
Dec 03, 2014
Julien Reichel
Changes related to 3.1.1 firmware release.
2.0
Mar 06, 2015
Nicusor Cheles
Document renamed to “HMP Configuration API”.
Formatting changes.
2.1
Aug 06, 2015
Julien Reichel
Changes related to 3.2.0 firmware release.
3.0
Jan 07, 2016
Julien Reichel
Changes related to 4.0.0 firmware release
3.1
Mar 27, 2017
Julien Reichel
Changes related to 4.2.0 firmware

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 3 of 58
Disclaimer
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT
TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS
MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY
PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT
ARE SET FORTH IN THE INFORMATION PACKET THAT IS SHIPPED WITH THE PRODUCT AND ARE
INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR SPINETIX REPRESENTATIVE FOR A COPY.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF
THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. SPINETIX DISCLAIMS ALL WARRANTIES,
EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING,
USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL SPINETIX OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL,
CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR
LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF
SPINETIX OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
"SpinetiX" and “HMP Hyper Media Player” are registered trademarks, and all logo and graphic designs
are trademarks of SpinetiX SA Other product and company names appearing in SpinetiX SA products
and materials are used for identification purposes only and may be trademarks or registered
trademarks of their respective companies. Registered and unregistered trademarks used in any
SpinetiX SA products and materials are the exclusive property of their respective owners

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 4 of 58
Table of Contents
Introduction........................................................................................................................................8
XML configuration string.....................................................................................................................8
Structure ........................................................................................................................................8
Order of execution..........................................................................................................................9
Encryption ....................................................................................................................................11
Configuration commands..................................................................................................................12
Encryption ....................................................................................................................................13
<passphrase> ...........................................................................................................................13
<regenerate-secret-key> ..........................................................................................................13
Display settings.............................................................................................................................13
<display-video-mode> ..............................................................................................................13
<display-custom-video-mode>..................................................................................................14
<screen-aspect-ratio>...............................................................................................................15
<display-orientation> ...............................................................................................................16
<display-power-save>...............................................................................................................16
<display-power-schedule>........................................................................................................16
<underscan-supported> ...........................................................................................................17
<vga-power-mode> ..................................................................................................................17
<vga-dc-offset> ........................................................................................................................17
<overscan-percentage> ............................................................................................................18
<hdmi-link-type> ......................................................................................................................18
<enable-audio> ........................................................................................................................18
<audio-power-save>.................................................................................................................19
<splash> ...................................................................................................................................19
Network settings ..........................................................................................................................21
<ethernet-dhcp> ......................................................................................................................21
<ethernet-static>......................................................................................................................21
<modem-3g-simple>.................................................................................................................22
<modem-3g-advanced>............................................................................................................23
<device-name>.........................................................................................................................24
<network-watchdog> ...............................................................................................................24
<proxy> ....................................................................................................................................25

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 5 of 58
<https-validate-certificates>.....................................................................................................26
<certificate> .............................................................................................................................26
<certificates-reset>...................................................................................................................27
<server-certificate> ..................................................................................................................27
<server-certificates-reset>........................................................................................................28
<active-certificate>...................................................................................................................29
<http-server-security-access>...................................................................................................29
<ssdp-upnp-enabled>...............................................................................................................29
<disable-secondary-network-port>...........................................................................................30
SNMP settings ..............................................................................................................................31
<snmp-local>............................................................................................................................31
<snmp-limited> ........................................................................................................................31
<snmp-all>................................................................................................................................31
<snmp-rocommunity> ..............................................................................................................32
Credentials ...................................................................................................................................32
<credential-reset> ....................................................................................................................32
<credential> .............................................................................................................................32
Network API .................................................................................................................................34
<network-api-enabled> ............................................................................................................34
<network-api-port> ..................................................................................................................34
Interactivity settings .....................................................................................................................35
<accepts-events>......................................................................................................................35
<maximum-latency>.................................................................................................................35
<reduce-interactive-latency>....................................................................................................35
<touchscreen>..........................................................................................................................36
Date / time settings ......................................................................................................................37
<timezone> ..............................................................................................................................37
<time-manual>.........................................................................................................................37
<time-ntp-restore>...................................................................................................................37
<time-ntp> ...............................................................................................................................38
Security settings ...........................................................................................................................40
<user> ......................................................................................................................................40
<user-reset>.............................................................................................................................41
<secure-admin>........................................................................................................................41
<secure-content> .....................................................................................................................42

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 6 of 58
<secure-monitoring> ................................................................................................................42
<rpc-api-key> ...........................................................................................................................43
Content ........................................................................................................................................44
<scheduled-download-reset> ...................................................................................................44
<scheduled-download-add> .....................................................................................................44
<live-source-reset>...................................................................................................................44
<live-source-add>.....................................................................................................................45
Pull Mode.....................................................................................................................................46
<pull-mode-disabled>...............................................................................................................46
<pull-mode-static> ...................................................................................................................46
<pull-mode-file>.......................................................................................................................47
<pull-mode-remote> ................................................................................................................48
<pullmode-logs-level> ..............................................................................................................49
Firmware Update..........................................................................................................................49
<firmware-update-uri>.............................................................................................................49
<firmware-update-auto> ..........................................................................................................49
I/O Automation ............................................................................................................................51
<protocol-disabled>..................................................................................................................51
<protocol-system>....................................................................................................................51
<protocol-file-reset>.................................................................................................................51
<protocol-file>..........................................................................................................................52
<com-port-settings> .................................................................................................................52
Others ..........................................................................................................................................54
<screen-id>...............................................................................................................................54
<reboot> ..................................................................................................................................54
<shutdown-temperature> ........................................................................................................54
<cockpit>..................................................................................................................................55
<cockpit-disabled>....................................................................................................................55
Firmware release notes.....................................................................................................................56
Firmware 2.2 ................................................................................................................................56
Firmware 3.0 ................................................................................................................................56
Firmware 3.1 ................................................................................................................................57
Firmware 3.2 ................................................................................................................................57
Firmware 3.4 ................................................................................................................................57
Firmware 4.0 ................................................................................................................................57

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 7 of 58
Firmware 4.1 ................................................................................................................................58
Firmware 4.2 ................................................................................................................................58

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 8 of 58
Introduction
The HMP Configuration API defines the XML format and all the configuration commands that can be
used to modify different settings on the HMP devices.
The HMP Configuration API is available since 2.2.1 firmware release, when the configuration backup &
restore feature was introduced in HMP Control Center, and extended in 2.2.3 release to be used
through RPC calls. Further changes and improvements of the HMP configuration API were regularly
done in subsequent firmware releases.
There are two methods to send configuration commands to an HMP for execution:
Via a configuration backup - within the config.xml.
Via RPC - within the xmlconfig string provided to the set_config() command.
XML configuration string
Structure
The HMP Configuration API uses an XML-based format, where one or more configuration commands
are encapsulated within a <configuration> element.
The XML configuration string must have the following structure:
<?xml version="1.0"?>
<configuration version="2.1">
<command-1>...</command-1>
...
<command-n>...</command-n>
</configuration>
Configuration version
The <configuration> element has a "version" attribute. The version depends on the HMP firmware.
"1.0": Initial version
"1.1": firmware 3.0.0 and above. (Syntax change of two existing configuration commands).
"1.2": firmware 3.2.0 (Additions of 2 new commands).
"2.0": firmware 4.0.0 (for HMP350, HMP300 and DiVA)
"2.1": firmware 4.2 (addition of the passphrase)
Note that version 1.1 and 1.2 are fully compatible, but that version 2.0 and 1.2 are not compatible.

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 9 of 58
Notes
The XML configuration string can reflect a full configuration of the HMP device (as it is the
case for when the configuration backup is generated from HMP Control Center), or it can
update only a limited number of settings (in this case, the settings not found in the
configuration string will keep their current value).
The XML configuration string can be used either as the content of the config.xml file (which
gets included into a configuration backup) or as the value of the xmlconfig parameter of the
set_config() RPC command (in this case make sure to properly encode the XML string).
A configuration command is an XML element in the XML configuration string. It may be single
XML element, an XML element containing some text content parameters, or a more complex
XML structure to modify more than one parameter with a single command. The next chapter
describes in detail all the available configuration commands.
Compatibility
Some configuration may be compatible both with version 1.2 and 2.0 has they only use command
present in both version and based on the same syntax. In this case it is possible to indicate to a device
based on version 2.0 that it should also accept the configuration. This can be done using the
compatible attribute.
<?xml version="1.0"?>
<configuration version="1.2" compatible="2.0">
<command-1>...</command-1>
...
<command-n>...</command-n>
</configuration>
Example
The XML configuration string below sets the aspect ratio of the screen to 16:9 and its orientation to
horizontal. Finally, it forces a reboot of the HMP to apply the changes. No other parameters are
modified.
As the configuration is compatible with both version 1.2 and 2.0, the compatible attribute is used.
<?xml version="1.0"?>
<configuration version="1.2" compatible="2.0">
<screeen-aspect-ratio>16:9</screeen-aspect-ratio>
<display-orientation>horizontal</display-orientation>
<reboot/>
</configuration>
Order of execution
The configuration commands are executed in the order provided within the XML configuration string.
Since different configuration commands can control the same HMP feature, the order in which they
are provided influences the end result.

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 10 of 58
For instance, the <ethernet-dhcp/> command sets the player to DHCP, whereas the <ethernet-
static> command sets it to use a fixed IP address. If both commands are present in the XML
configuration string, the last one will be taken into consideration.
The only exception is the <reboot/> command which can appear anywhere in the XML configuration
string, but will only be applied once all commands have been executed.
Example #1
After applying the following XML configuration string, the HMP will use a DHCP assigned IP address.
<?xml version="1.0"?>
<configuration version="2.1">
<ethernet-static>
<address>192.168.1.10</address>
<netmask>255.255.255.0</netmask>
</ethernet-static>
<ethernet-dhcp/>
</configuration>
After applying the following XML configuration string, the HMP will use a fixed IP address.
<?xml version="1.0"?>
<configuration version="2.1">
<ethernet-dhcp/>
<ethernet-static>
<address>192.168.1.10</address>
<netmask>255.255.255.0</netmask>
</ethernet-static>
</configuration>
Example #2
The <credential-reset/> configuration command removes all credentials previously configured on
the HMP device, whereas the <credential> configuration command adds a new one.
<?xml version="1.0"?>
<configuration version="2.1">
<credential-reset/>
<credential>
<server>http://demo.spinetix.com/</server>
<password>spinetix</password>
<username>spinetix</username>
<realm>demo</realm>
</credential>
</configuration>
If the two configuration commands are provided in a reversed order, all credentials are removed from
the HMP device.

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 11 of 58
<?xml version="1.0"?>
<configuration version="2.1">
<credential>
<server>http://demo.spinetix.com/</server>
<password>spinetix</password>
<username>spinetix</username>
<realm>demo</realm>
</credential>
<credential-reset/>
</configuration>
Encryption
Starting with version 2.1 of the backup (firmware 4.2) the passwords and other secret information
retrieved in the backup are encrypted using either a configured passphrase or a secret key only valid
on the player where the backup has been generated.
To use the same backup on multiple player, the same passphrase must be configured on all the player.
The passphrase needs to be configured only once. This can be done using Control Center or using a
backup file. In this later case the <passphrase/> command can be used.
When the player is generating a backup file, the <passphrase/> command in never stored in the
backup by the player, it must be manually added by the user.
If no passphrase is configured on the player, the secret information will be encoded using an internal
secret key. In this case the backup can only be applied on this player. The backup can however be
installed on the player even after factory reset or firmware re-install.
Example: setting a passphrase
The following backup file can be used to set the same passphrase on multiple HMP. Once done all they
backup will be compatible.
<?xml version="1.0"?>
<configuration version="2.1">
<passphrase>Some user defined passphrase</passphrase>
</configuration>

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 12 of 58
Configuration commands
This section describes the structure and the parameters of the configuration commands that can be
sent to an HMP for execution.
A configuration command is represented within the XML configuration string through an XML element,
direct descendant of the <configuration> element.
In case the configuration command requires one parameter, it is usually provided within the
text content of the element.
If it requires more parameters, these are usually provided as inner XML elements.
For instance, to configure the HMP to use DHCP, a simple XML element is used:
<ethernet-dhcp/>
To change the time zone setting, the time zone name is specified within the text content of the
element:
<timezone>Europe/Zurich</timezone>
To set the HMP device to use a fixed IP address, several parameters are needed, each being provided
as a separate XML element under the main command:
<ethernet-static>
<address>192.168.1.10</address>
<netmask>255.255.255.0</netmask>
<gateway>192.168.1.1</gateway>
<dns>192.168.1.1</dns>
</ethernet-static>

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 13 of 58
Encryption
This section describes all the parameters related to the encryption of the secret information present in
the backup file.
<passphrase>
Added in 4.2 firmware release.
Set the passphrase to be used to encode the passwords and other secrets present in the backup. This
command can be used to set or to clear the passphrase.
For instance, to clear the passphrase, use:
<passphrase/>
For instance, to set the passphrase, use:
<passphrase>My secret passphrase</passphrase>
<regenerate-secret-key>
Added in 4.2 firmware release.
Force the player to re-generate a new secret key and clear all previously set passphrase.
Warning: When using this command all previously generated backup will no longer be compatible with
this player.
For instance, to generate a new secret key and clear the passphrase, use:
<regenerate-secret-key/>
Display settings
This section describes all the parameters related to the configuration of the display.
<display-video-mode>
Control the video mode used by the display. This command is composed of 4 parameters:
<resolution>
Resolution to be used. The list of supported resolution depends on the screen and the
player. Typical values are 640x480, 1280x720, 1920x1080 etc.
<vertical-freq>
Refresh rate of the display. Possible values are 24, 25, 39, 50, and 60.
<force-std-mode>

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 14 of 58
Force the player to use only modes supported by its internal standards database.
Those mode are the most common modes supported by most displays. Possible values
are yes or no. If no is selected, then the player is allowed to use modes not in the
internal database, but reported to any screen attached to the player through the DDC
signal.
<restrict-type>
Restrict the type of signal to one of the following: hdmi, vesa, gtf. Any value can be
used, including combinations such as "hdmi,vesa". An empty value remove all
restrictions and is equivalent to "hdmi,vesa,gtf".
Not all the combinations of parameters are possible. When applying the configuration, the HMP will
test for the validity of the parameters combination, and report an error if not supported.
Note: this parameter will override settings done using <display-custom-video-mode>.
Note: Device must be rebooted for this parameter to be applied.
For instance, to set up the display to use 720p@60Hz video mode, use:
<display-video-mode>
<resolution>1280x720</resolution>
<vertical-freq>60</vertical-freq>
<force-std-mode>yes</force-std-mode>
<restrict-type>hdmi</restrict-type>
</display-video-mode>
<display-custom-video-mode>
HMP350 only
Control the video mode used by the display. The custom video mode can be expressed either as a CVT
mode or a full custom fixed mode specified by the user.
This setting can be used to drive screens with aspect ratio not in the internal database of the HMP or
with a custom video mode. Be aware that the HMP can only check the validity of the string entered,
but it cannot test if the screen will be able to display the signal it is sending.
Note: this parameter will override settings done using <display-video-mode>.
Note: Device must be rebooted for this parameter to be applied
CVT modes
CVT stands for VESA Coordinated Video Timings. The syntax in this case is the following:
<display-custom-video-mode>width height refresh type interlace
aspect_ratio</display-custom-video-mode>
Fields explanations:

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 15 of 58
type, use one of the following:
o"cvt-R" for CVT with "reduced blanking", normally OK with LCD or plasma.
o"cvt" for the CVT compatible with CRT tech we need a longer blanking.
o"cvt-Rom" is like "cvt-R" but with margins and more around the active part of the
image, to try if "cvt-R" does not work well.
o"m-cvt" is like "cvt" but with margins more.
interlace attribute should always be "p".
aspect_ratio should be one of the following: "16:9", "4:3", "4:10" or "0:0" or blank for auto
/ unknown.
For example: "1024 768 60 cvt-R p 0:0" would select 1024x768 @ 60 Hz for LCD panels with automatic
aspect ratio.
Fixed mode
Fixed modes are fully specified by the user using:
<display-custom-video-mode>width height refresh LM RM UM BM HS VS HP VP
interlace aspect_ratio</display-custom-video-mode>
The additional fields are thus:
LM - Left-margin, number of pixel clocks between the horizontal sync end & the first active
pixel, decimal integer; In VESA standard this is known as the horizontal back porch.
RM - Right-margin, number of pixel clocks between the last active pixel and the end of the video
line; decimal integer; In VESA standard this is known as the horizontal front porch.
UM - Upper-margin, number of video lines between the vertical sync end & the first active line;
decimal integer; In VESA standard this is known as the vertical back porch.
BM - Lower-margin, number of video lines between the last active line and the end of the video
frame; decimal integer; In VESA standard this is known as the vertical front porch.
HS - Horizontal sync duration in pixel clocks.
VS - Vertical sync duration in video lines.
HP - Horizontal sync polarity, either the + or - character (i.e. high or low active, respectively).
VP - Vertical sync polarity, either the + or - character (i.e. high or low active, respectively).
So, for the standard VGA 640x480, the string is: "640 480 60 48 16 33 10 96 2 -- p 4:3" (note, there is
no space between the + or - characters used for the sync).
For instance, to set up the display to use 480p custom video mode, use:
<display-custom-video-mode>720 480 60 60 16 30 9 62 6 –p 16:9 </display-
custom-video-mode>
<screen-aspect-ratio>
HMP300 and HMP350 only

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 16 of 58
Select the aspect ratio of the screen. The HMP can update the rendered content to match the aspect
ratio of the screen, regardless of the signal actually sent to the display. For instance, if you use a
640x480 signal, you can force the aspect ratio to 16:9 so that your content is displayed correctly in
your screen. An empty value will use the default aspect ratio matching the screen resolution.
The possible values are: 4:3, 16:9, 16:10.
Note: Device must be rebooted for this parameter to be applied.
For instance, to set up the aspect ratio of the screen to 16:9, use:
<screen-aspect-ratio>16:9</screen-aspect-ratio>
<display-orientation>
Controls the orientation of the display attached to the player.
The possible values are: horizontal, rotateRight, rotateLeft, rotate180, flipVert, flipHor.
For instance, to set the display orientation to horizontal, use:
<display-orientation>horizontal</display-orientation>
<display-power-save>
Allows the HMP to send power save information using the VGA or DVI signal to turn off attached
screen. When this feature is enabled, it is possible either to use fixed scheduling to control the status
of the screen or to include PowerON or PowerOFF commands in the hypermedia content for a finer
tuning of the parameters of the screen.
The possible values are: yes, no.
Note: Device must be rebooted for this parameter to be applied.
For instance, to enable power save using VGA or DVI signal, use:
<display-power-save>yes</display-power-save>
<display-power-schedule>
Controls a fixed scheduling for turning on and off screen, independent from the content. This
command can be used to set, or to clear the scheduling depending on its content. If the command is
sent without parameters, it will clear any previous schedule. Otherwise, the following parameters must
be set:
<on-time>
Time at which the screen must be turned on. The format expected is HH:MM, where
HH is the time express in 24 hour format. If omitted the value of 00:00 will be used.

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 17 of 58
<off-time>
Time at which the screen must be turned off. The format expected is HH:MM, where
HH is the time express in 24 hour format. If omitted the value of 24:00 will be used. A
value of 24:00 is equivalent to the value 00:00.
For instance, to clear a fixed scheduling previously set, use:
<display-power-schedule/>
To setting the fixed scheduling to turn on screen at 1 AM and switching it back off at 11 PM, use:
<display-power-schedule>
<on-time>01:00</on-time>
<off-time>23:00</off-time>
</display-power-schedule>
<underscan-supported>
Indicates that the player can trust the information returned by the TV screen concerning underscan.
This information will be used only when connected to the screen using HDMI.
The possible values are: yes, no.
Note: Device must be rebooted for this parameter to be applied.
For instance, to enable the underscan video mode (if supported by the screen), use:
<underscan-supported>yes</underscan-supported>
<vga-power-mode>
Controls if the VGA connector is powered or not. If this is set to auto, the VGA will be powered only if
a screen connected to the HMP using a VGA cable provides some DDC feedback. If a VGA screen is
connected to the player but stays black, then this setting should be set to on.
The possible values are: auto, on, off.
For instance, to set the power mode for VGA to automatic detection of connected screen, use:
<vga-power-mode>auto</vga-power-mode>
<vga-dc-offset>
Added in 2.2.4 firmware release.
Indicates that the VGA display connected to the player supports a DC voltage offset in the RGB signals.
This is normally supported by all VGA displays, but can be disabled in case of compatibility issue.

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 18 of 58
The possible values are: yes, no.
Note: Device must be rebooted for this parameter to be applied.
For instance, to disable the DC offset on the VGA output, use:
<vga-dc-offset>no</vga-dc-offset>
<overscan-percentage>
Controls the percentage of overscan done by the screen attached to the player. The player will
automatically add some black border around the content to compensate the overscan done by the
screen. This setting will be used either when the screen connected through HDMI reports that it does
not support underscan, or the <underscan-supported> has been set to no.
The possible values are: 0, 1, 2, 3, 4, and 5.
For instance, to set the overscan percentage to 3%, use:
<overscan-percentage>3</overscan-percentage>
<hdmi-link-type>
Added in 3.0.3 firmware release.
Controls the type of signal sent in the HMDI connector. By default the player automatically detects the
type of device attached to the HDMI cable (HDMI or DVI). This settings can be used to override the
automatic detection. This setting will only be used when connected through HDMI.
The possible values are: auto, HDMI, DVI.
For instance, to set the HDMI link to DVI, use:
<hdmi-link-type>DVI</hdmi-link-type>
<enable-audio>
Controls whether the player shall output audio or not. If set to no, no audio will be decoded or output
trough the analog or digital (inside the HDMI) output of the player. This setting is disabled by default
on all players.
The possible values are: yes, no.
Note: Device must be rebooted for this parameter to be applied.
For instance, to disable audio output on the device, use:

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 19 of 58
<enable-audio>no</enable-audio>
<audio-power-save>
Added in 3.1.0 firmware release.
Controls whether the player shall output audio or not when the screen is in power save. If set to yes,
no audio will be decoded when the screen is power off using RS232 or the power save feature of the
device. This setting is disabled by default on all players.
The possible values are: yes, no.
For instance, to disable audio output when the screen is in power save, use:
<audio-power-save>yes</enable-audio>
<splash>
Added in 3.0.0 firmware release.
Controls the splash image used by the device when booting, restarting or updating the firmware. This
commands can be used to set new images or the reset the images to the default values. If new images
are set, then they must be provided as part of the restored backup.
This command takes two parameters:
<name>
Name of the splash image to update. Possible values are 'boot', 'shutdown' or
'firmware.
<file>
Name of the file to be used as splash screen. This file must be present in the
compressed backup. If this parameters is omitted or the file is not found, the default
splash screen image will be used.
Note that it is not possible to set new splash screen images using RPC. It is however possible to reset
the default splash images using RPC.
For instance, to reset the shutdown image to the default file, use:
<splash>
<name>shutdown</name>
</splash>
For instance, to set the boot image to a jpeg image called 'splah.jpg' present in the configuration
backup file, use:

HMP Configuration API - SpinetiX Technical Documentation v3.1
© SpinetiX SA All rights reserved. Page 20 of 58
<splash>
<name>boot</name>
<file>splash.jpg</file>
</splash>