Epiphan Pearl Mini Live Video Production System User Manual
Page 399
Pearl Mini User Guide
Controlling Pearl Mini using
HTTP/HTTPS commands
Specify your Pearl Mini’s IP address, password and the key(s) or value(s) you want to query using the following
syntax. Note that your system may require use of single quotes around the password to handle special
characters such as exclamation marks. You can substitute
https
for
http
in the urls.
get_param using wget:
wget --http-user=admin --http-passwd=<
password
> http://<
address
>/admin/channel<
N
>/get_
params.cgi?<
key
>[&<
key
>]
set_param using wget:
wget --http-user=admin --http-passwd=<
password
> http://<
address
>/admin/channel<
N
>/set_
params.cgi?<
key
>=<
value
>[&<
key
>=<
value
>]
Where <
address
> is the IP address of the Pearl Mini, channel<
N
> is the channel number (i.e.
channel2
for
channel number two),
key
is the configuration key for the item being checked or changed (see
Configuration keys for third party APIs
), and
value
is the value to set for the configuration item.
Global variable HTTP commands for custom layouts
Pearl Mini can create global variables using HTTP commands embedded in custom layout as responsive text
overlay elements. See
for information about adding a global variable into a custom layout.
You cannot substitute
https
for
http
in the global variable HTTP commands.
Important considerations for global custom layout variables
l
Each system variable must have its own unique name
l
System variable names and variable values are case sensitive
l
Each variable name must start with a letter or underscore sign and is followed by any combination of
letters, digits and underscore characters [A-Za-z_0-9]{0,32} to a limit of 32 total characters (note that
saving an empty string to a variable will clear the variable value)
l
There is a limit of 1024 total unique system variables per Pearl Mini system.
l
System variables can be used in text labels across any number of channels.
l
System variable commands can be issued at a frequency of 5 per second, and up to 6 variables may be
set in a single command (for example, variables "gpsvar1", "gpsvar2" and "gpsvar3" can be updated in a
single command, five times per second). After issuing a set command, all channels using the specified
variable(s) are updated. The frequency of commands issued is not influenced by the number of
388