tvONE CORIOmatrix Commands

tvONE CORIOmatrix Commands
tvONE CORIOmatrix Commands
Command-line Options
Document version 1.6.1
System API version 3.1.4222
Firmware version M306
Table of Contents
Table of Contents ............................................................................................................................................................................................................................. 1
Constraints ....................................................................................................................................................................................................................................... 3
Legend .............................................................................................................................................................................................................................................. 3
Top level Commands........................................................................................................................................................................................................................ 4
CORIOmatrix Routing Commands .................................................................................................................................................................................................... 6
CORIOmax Commands ..................................................................................................................................................................................................................... 7
System Commands........................................................................................................................................................................................................................... 9
System Communications Commands ........................................................................................................................................................................................ 13
System Security Commands ....................................................................................................................................................................................................... 17
Resources Commands .................................................................................................................................................................................................................... 24
Resources Configuration Commands ......................................................................................................................................................................................... 26
Resources EDID Commands ....................................................................................................................................................................................................... 29
Resources Test Pattern Commands ........................................................................................................................................................................................... 32
Resources Resolutions Commands ............................................................................................................................................................................................ 33
Aliases Commands ......................................................................................................................................................................................................................... 35
Slots Commands............................................................................................................................................................................................................................. 36
DVI Input Module ....................................................................................................................................................................................................................... 37
SDI Input Module ....................................................................................................................................................................................................................... 43
DVI Output Module .................................................................................................................................................................................................................... 48
HDBaseT Output Module ........................................................................................................................................................................................................... 57
Audio Module ............................................................................................................................................................................................................................ 68
Table of Contents
1
Routing Commands ........................................................................................................................................................................................................................ 70
MonitorViews Commands ......................................................................................................................................................................................................... 71
Preset Commands ...................................................................................................................................................................................................................... 73
Custom Types ................................................................................................................................................................................................................................. 75
Table of Contents
2
Constraints
Note that although the tvONE system supports connections via both serial (RS-232) and Ethernet protocols, at no point does it support both connections
CONCURRENTLY. The unit must be connected to just one controlling PC at any given time.
Legend
Property Name
Name
Syntax
Command
Name
Command
Type
Type
Example
Example
Description
Description.
Used for commands that are common
across all CORIOmax products.
Not used.
This command is not currently used.
The table fields contain the following information:
Property Name
Syntax
Type
Example
Description
Constraints
the name of the command.
the full syntax structure of the command.
the type of the value for use with this command. Note that where the options are complex the possible values are described in
the Error! Reference source not found. section Error! Bookmark not defined. Error! Reference source not found..
is an example of the command in use.
a brief description of the command.
3
Top level Commands
Methods
Command
Login
Syntax
Login(<username>,<password>)
Type
Void
Example
login(admin,adminpw)
!Info : User admin Logged In
Description
Log on to the device with the supplied
username and password.
For more information on the usernames
and passwords see the section System
Security Commands on page 17 below.
Command
Logout
Syntax
Logout
Type
Void
Description
Log out the current user.
StartBatch
StartBatch
Void
Example
!Info : User system.security.Admin_Username
Logged Out
// logout
!Done StartBatch
EndBatch
EndBatch
Void
!Done EndBatch
Namespaces
Namespaces
List
Aliases
Slots
Routing.Canvases
Routing.Windows
Routing.Layouts
Routing.MonitorViews
Resources
// Namespaces
Properties
Top level Commands
4
Group a number of write commands
together so that they will be operated
on at the same time.
The effect of the commands will not be
processed until the EndBatch command
is received.
Note that read commands will always be
processed immediately.
Execute the commands entered since
the last StartBatch command.
List the commands that may be omitted
and the sub-command used directly.
For example you may use either
Slots.Slot1 or just Slot1.
Root
Top level Commands
Root
List
root
CORIOmax
System
Test
Aliases
Resources
Slots
Routing
!Done root
5
List the root-level of commands. Each of
these is the basis of a further group of
commands, described in this document.
CORIOmatrix Routing Commands
It is possible to use S<n>I<n> and S<n>O<n> in place of Slot<n>.In<n> and Slot<n>.Out<n>.
Properties
Command
Input > Output
Syntax
S<n>I<n> > S<n>O<n>
CORIOmatrix Routing Commands
Type
Void
Example
S3I1 > S14O1
!Done S3I1 > S14O1
6
Description
Set an input to go to an output.
Audio routing depends upon the audio
configuration.
CORIOmax Commands
Properties
Property Name
CORIOmax
Syntax
CORIOmax
Type
List
Model_Name
CORIOmax.Model_Name
String
Model_Number
CORIOmax.Model_Number
String
CORIOmax.Model_Number = C3-340
!Done CORIOmax.Model_Number
Serial_Number
CORIOmax.Serial_Number
Integer
Backplane_Number
CORIOmax.Backplane_Number
Integer
Software_Name
CORIOmax.Software_Name
String
CORIOmax.Serial_Number = 2218031005149
!Done CORIOmax.Serial_Number
CORIOmax.Backplane_Number =
0000000000000
!Done CORIOmax.Backplane_Number
CORIOmax.Software_Name = CORIOmatrix
!Done CORIOmax.Software_Name
Backplane_Type
Software_Version
CORIOmax.BackPlane_Type
CORIOmax.Software_Version
String
CORIOmax Commands
Example
CORIOmax.Model_Name = CORIOmatrix
CORIOmax.Model_Number = C3-340
CORIOmax.Serial_Number = 2218031005149
CORIOmax.Backplane_Number =
0000000000000
CORIOmax.Software_Name = CORIOmatrix
CORIOmax.Software_Version = V1.30600.P4
Scaling Matrix
CORIOmax.RebootToMatrix()
CORIOmax.Software_Date = Feb 24 2015
14:21:17
CORIOmax.Software_Update()
CORIOmax.Backplane_Type = 1
!Done CORIOmax
CORIOmax.Model_Name = CORIOmatrix
!Done CORIOmax.Model_Name
CORIOmax.Software_Version = V1.30600.P4
Scaling Matrix
!Done CORIOmax.Software_Version
7
Description
List all of the CORIOmax commands and
display the values of the properties.
Read-only.
Get the model name for the device.
e.g. CORIOmatrix or CORIOmatrix mini
Read-only.
Get the model number for the device.
e.g. C3-510 or C3-310
Read-only.
Get the serial number for the device
Read-only.
Get the serial number for the Backplane
Read-only.
Get the name of the current firmware.
e.g. CORIOmaster or CORIOmatrix
Not used.
Read-only.
Get the version of the current firmware
Property Name
Software_Date
Syntax
CORIOmax.Software_Date
Type
String
Example
CORIOmax.Software_Date = Feb 24 2015
14:21:17
!Done CORIOmax.Software_Date
Description
Read-only.
Shows the date the software was
compiled.
Syntax
CORIOmax.RebootToMatrix()
CORIOmax.Software_Update()
Type
Example
Void
Software_Update()
!Done Software_Update
Description
Not used.
Initiate the firmware update process.
This command assumes that the new
firmware package has been copied to
the SD Card first.
Methods
Method Name
RebootToMatrix
Software_Update
CORIOmax Commands
8
System Commands
Properties
Command
System
Syntax
System
Type
List
Comms
System.Comms
List
Constraints
Temperature_Cont
rol
System.Constraints
System.Temperature_Control
System Commands
Example
System.Comms = <...>
System.Constraints = <...>
System.Temperature_Control = <No Value>
System.Security = <...>
System.Menus = <...>
System.Reset()
System.SaveAllSettings()
System.RestoreAll()
System.ClearSavedSettings()
System.ConfigName = NULL
System.BackupToSDCard()
System.RestoreBackup()
System.HDCPPrintTable()
System.WPrstSeqNum = 0
System.HDCPClearKeyFile()
System.HDCP_Status = R
System.HDCP_Debug = Off
System.Status = Serving
System.API_Version = 3.1.4222
System.Unit_Description = "My CORIOmatrix"
System.GUI_Control = <...>
System.Synclock_Inhibit = Off
!Done System
System.Comms.RS232 = <…>
System.Comms.Ethernet = <…>
System.Comms.USB = <…>
!Done System.Comms
Description
List all of the System commands and
display the values of the properties
List all of the communication properties.
See System Communications Commands
on page 13 below.
Not used.
Not used.
9
Command
Security
Syntax
System.Security
Menus
System.Menus
System Commands
Type
List
Example
System.Security.Guest_Username = guest
System.Security.Guest_Password<Restricted>
System.Security.Guest_Timeout = 300
System.Security.Guest_Role = Guest
System.Security.User1_Username = user1
System.Security.User1_Password<Restricted>
System.Security.User1_Timeout = 300
System.Security.User1_Role = PowerUser
System.Security.User2_Username = user2
System.Security.User2_Password<Restricted>
System.Security.User2_Timeout = 300
System.Security.User2_Role = User
System.Security.User3_Username = user3
System.Security.User3_Password<Restricted>
System.Security.User3_Timeout = 300
System.Security.User3_Role = User
System.Security.User4_Username = user4
System.Security.User4_Password<Restricted>
System.Security.User4_Timeout = 300
System.Security.User4_Role = User
System.Security.Admin_Username = admin
System.Security.Admin_Password<Restricted>
System.Security.Admin_Timeout = 0
System.Security.Admin_Role = Administrator
System.Security.Test_Username = test
System.Security.Test_Password<Restricted>
System.Security.Test_Timeout = 14400
System.Security.Test_Role = Test
!Done System.Security
Description
List all of the security settings of the
device.
See System Security Commands on page
17 below.0 below
Not used.
10
Command
ConfigName
Syntax
System.ConfigName
Type
String
Example
System.ConfigName = Groucho
!Done System.ConfigName = Groucho
WPrstSeqNum
System.WPrstSeqNum
Integer
System.WPrstSeqNum = 0
!Done System.WPrstSeqNum
HDCP_Status
HDCP_Debug
System.HDCP_Status
System.HDCP_Debug
Boolean
System.HDCP_Debug = Off
!Done System.HDCP_Debug
Status
System.Status
API_Version
System.API_Version
SystemStatu
s
String
Unit_Description
System.Unit_Description
String
System.Status = Serving
!Done System.Status
System.API_Version = 3.1.4222
!Done System.API_Version
System.Unit_Description = "My CORIOmatrix"
!Done System.Unit_Description
GUI_Control
GUI_Control.First_
Boot
Synclock_Inhibit
System.GUI_Control
System.GUI_Control.First_Boot
System Commands
system.Synclock_Inhibit
Boolean
System.Synclock_Inhibit = Off
!Done System.Synclock_Inhibit = Off
11
Description
Get or set the configuration name of the
live system (the configuration name is a
string of up to 32 characters currently
without spaces).
See Resources Configuration Commands
on page 26 below.
Read only.
Number of
Routing.Preset.RestoreRead()
commands executed since power on.
Not used.
Enable the diagnostics for the HDCP
system.
The output is to be captured and
submitted to Tech Support for diagnosis.
Read only.
Get the status of the device.
Read only.
The version number of this API.
Get or set the Device Name.
The device name may be no more than
32 characters in length but may contain
any ASCII Extended characters including
spaces (as long as string is in quotes).
The value is always returned in quotes.
It may be set empty by providing no
characters after the “=”.
Not used.
Not used.
Disables the Synclock automatic display
synchronisation.
Methods
Method Name
Reset
Syntax
System.Reset()
Type
Void
Example
!Info: Rebooting…
Description
Reboot the device.
SaveAllSettings
System.SaveAllSettings()
Void
Save the current configuration to
persistent memory. The device will keep
these settings after a reboot.
RestoreAll
System.RestoreAll()
Void
//Saving settings
…
//Settings saved
!Done System.SaveAllSettings()
//Loading settings
…
//Settings loaded
!Done System.RestoreAll()
ClearSavedSettings
System.ClearSavedSettings()
Void
!Done System.ClearSavedSettings()
BackupToSDCard
System.BackupToSDCard()
Void
RestoreBackup
System.RestoreBackup()
Void
HDCPPrintTable
System.HDCPPrintTable()
Table
HDCPClearKeyFile
System.HDCPClearKeyFile()
Void
//Backup: File delete: ….
….
//Backup: File copy:…
…
//Backup: Complete
!Done System.backupToSDCard()
// Restore: File delete: …
…
// Restore: File copy: …
…
//Restore: Complete
!Done System.RestoreBackup()
system.HDCPPrintTable()
[nn] Bksv | cn| sl | ch | age| dp | ip flags
[00]89 38 AE 0D ED | Y | 0F | 01 | 01 | 00
|00000000 00000000 00000000 00000000
!Done system.HDCPPrintTable()
!Done System.HDCPClearKeyFile()
Clear all saved settings
Note that this command is only available
from the Administrator account.
Backup settings (including presets) to SD
card.
System Commands
12
Restore all settings
Note that this command is only available
from Administrator account.
Restore settings from SD card
Note that this command is only available
from the Administrator account.
For diagnostic use.
Prints the internal cache of HDCP keys.
Clears the internal cache of HDCP keys.
System Communications Commands
Properties
Command
Comms
Syntax
System.Comms
Type
List
RS232
System.Comms.RS232
List
RS232.Baudrate
System.Comms.RS232.Baudrate
Integer
RS232.RS422_Mod
e
Ethernet
System.Comms.RS232.RS422_
Mode
System.Comms.Ethernet
Boolean
System Commands
List
Example
System.Comms.RS232 = <…>
System.Comms.Ethernet = <…>
System.Comms.USB = <…>
!Done System.Comms
System.Comms.RS232.Baudrate = 115200
System.Comms.RS232.RS422_Mode = Off
!Done System.Comms.RS232
System.Comms.RS232.Baudrate = 115200
!Done System.Comms.RS232.Baudrate
System.Comms.RS232.RS422_Mode = Off
!Done System.Comms.RS232.RS422_Mode
System.Comms.Ethernet.Enabled = On
System.Comms.Ethernet.MAC_Address =
00:16:9e:d7:00:10
System.Comms.Ethernet.DHCP = <...>
System.Comms.Ethernet.IP_Address =
172.16.1.100
System.Comms.Ethernet.IP_Subnet_Mask =
255.255.255.0
System.Comms.Ethernet.IP_Gateway =
172.16.0.1
System.Comms.Ethernet.Command_Port =
10001
System.Comms.Ethernet.RestartEthernet()
System.Comms.Ethernet.Webserver_Enabled =
On
!Done System.Comms.Ethernet
13
Description
List all of the communication properties
List the current RS232 settings
Get or set the baud rate to use.
Warning changing this setting may result
in loss of communication to the device!
Get or set RS422 mode.
List the current Ethernet settings.
Note that any changes will not take
effect until the Ethernet is restarted
(either with the command
System.Comms.Ethernet.RestartEtherne
t() or by saving the settings and
restarting the device.
Warning: changing the settings may
result in a loss of communication with
the device.
Command
Ethernet.Enabled
Syntax
System.Comms.Ethernet.Enable
d
Type
Boolean
Example
System.Comms.Ethernet.Enabled = On
!Done System.Comms.Ethernet.Enabled
Ethernet.MAC_Add
ress
System.Comms.Ethernet.MAC_
Address
String
Ethernet.DHCP
System.Comms.Ethernet.DHCP
List
Ethernet.DHCP.Ena
bled
System.Comms.Ethernet.DHCP.
Enabled
Boolean
System.Comms.Ethernet.MAC_Address =
00:16:9e:d7:00:10
!Done System.Comms.Ethernet.MAC_Address
System.Comms.Ethernet.DHCP.Enabled = On
System.Comms.Ethernet.DHCP.IP_Address =
172.16.1.100
System.Comms.Ethernet.DHCP.IP_Subnet_Mas
k = 255.255.255.0
System.Comms.Ethernet.DHCP.IP_Gateway =
172.16.0.1
System.Comms.Ethernet.DHCP.Enabled = On
!Done System.Comms.Ethernet.DHCP.Enabled
Ethernet.DHCP.IP_
Address
System.Comms.Ethernet.DHCP.I
P_Address
String
Ethernet.DHCP.IP_S
ubnet_Mask
System.Comms.Ethernet.DHCP.I
P_Subnet_Mask
String
System Commands
System.Comms.Ethernet.DHCP.IP_Address
System.Comms.Ethernet.DHCP.IP_Address =
172.16.1.100
System.Comms.Ethernet.DHCP.IP_Subnet_Mas
k = 255.255.255.0
!Done
System.Comms.Ethernet.DHCP.IP_Subnet_Mas
k
14
Description
Get or set if Ethernet communications
are enabled.
This setting will only take effect after
restarting the Ethernet or saving the
settings and rebooting.
Warning: turning the Ethernet Off when
connected via the Ethernet will result in
a loss of communication with the
device!
Read-only.
Get the current Ethernet MAC address.
List the current Ethernet DHCP settings.
Get or set if DHCP mode is to be used for
the Ethernet settings.
Note that when enabled the settings in
System.Comms.Ethernet.IP_Address,
System.Comms.Ethernet.IP_Subnet_Ma
sk and
System.Comms.Ethernet.IP_Gateway
are ignored.
Read only.
Get the current Ethernet Address.
Read only.
Get the current Subnet mask.
Command
Ethernet.DHCP.IP_
Gateway
Syntax
System.Comms.Ethernet.DHCP.I
P_Gateway
Type
String
Ethernet.IP_Addres
s
System.Comms.Ethernet.IP_Ad
dress
String
Ethernet.IP_Subnet
_Mask
System.Comms.Ethernet.IP_Sub
net_Mask
String
System.Comms.Ethernet.IP_Subnet_Mask =
255.255.255.0
!Done
System.Comms.Ethernet.IP_Subnet_Mask
Ethernet.IP_Gatew
ay
System.Comms.Ethernet.IP_Gat
eway
String
System.Comms.Ethernet.IP_Gateway =
172.16.0.1
!Done System.Comms.Ethernet.IP_Gateway
Ethernet.Command
_Port
System.Comms.Ethernet.Comm
and_Port
Integer
System.Comms.Ethernet.Command_Port =
10001
!Done System.Comms.Ethernet.Command_Port
System Commands
Example
System.Comms.Ethernet.DHCP.IP_Gateway =
172.16.0.1
!Done
System.Comms.Ethernet.DHCP.IP_Gateway
System.Comms.Ethernet.IP_Address =
172.16.1.100
!Done System.Comms.Ethernet.IP_Address
15
Description
Read only.
Get the current Ethernet gateway.
Get or set the current Ethernet address.
This setting will only take effect after
restarting the Ethernet or saving the
settings and rebooting.
Note that if DHCP is enabled this is
overridden by the settings in
System.Comms.Ethernet.DHCP.
Warning changing this setting may result
in a loss of communication with the
device.
Get or set the current Subnet mask.
This setting will only take effect after
restarting the Ethernet or saving the
settings and rebooting.
Note that if DHCP is enabled this is
overridden by the settings in
System.Comms.Ethernet.DHCP.
Warning changing this setting may result
in a loss of communication with the
device.
Get or set the current Ethernet gateway.
This setting will only take effect after
restarting the Ethernet or saving the
settings and rebooting.
Note that if DHCP is enabled this is
overridden by the settings in
System.Comms.Ethernet.DHCP.
Get or set the current Ethernet port.
This setting will only take effect after
restarting the Ethernet or saving the
settings and rebooting.
Command
Ethernet.Webserve
r_Enabled
Syntax
System.Comms.Ethernet.Webs
erver_Enabled
Type
Boolean
Example
System.Comms.Ethernet.Webserver_Enabled =
On
!Done
System.Comms.Ethernet.Webserver_Enabled
USB
System.Comms.USB
List
USB.MSD_Enabled
System.Comms.USB.MSD_Enabl
ed
Boolean
System.Comms.USB.MSD_Enabled = On
!Done System.Comms.USB
System.Comms.USB.MSD_Enabled = On
!Done System.Comms.USB.MSD_Enabled
Syntax
System.Comms.Ethernet.Restar
tEthernet()
Type
Void
Description
Get or set if the Web UI is enabled.
This setting will only take effect after
restarting the Ethernet or saving the
settings and rebooting.
Warning: turning the Web Server Off is
not recommended as it will result in the
Web UI being disabled!
Returns current USB settings
Get or set if the USB Mass Storage
Device is enabled.
The USB MSD is used when a PC
connects to the device with a USB cable.
This setting will only take effect after
saving the settings and rebooting.
Methods
Method Name
Ethernet.RestartEth
ernet
System Commands
Example
System.Comms.Ethernet.RestartEthernet()
!Done
System.Comms.Ethernet.RestartEthernet()
16
Description
Updates the Ethernet to use the current
settings.
Warning: changing the Ethernet settings
may result in a loss of communication
with the device!
System Security Commands
Properties
Command
Guest_Username
Syntax
System.Security.Guest_Userna
me
Type
String
Example
System.Security.Guest_Username = guest
!Done System.Security.Guest_Username
Guest_Password
System.Security.Guest_Passwor
d
Void
System.Security.Guest_Password<Restricted>
!Done System.Security.Guest_Password
Guest_Timeout
System.Security.Guest_Timeout
Integer
System.Security.Guest_Timeout = 300
!Done System.Security.Guest_Timeout
Guest_Role
System.Security.Guest_Role
Role
System.Security.Guest_Role = Guest
!Done System.Security.Guest_Role
User1_Username
System.Security.User1_Userna
me
String
System.Security.User1_Username = user1
!Done System.Security.User1_Username
User1_Password
System.Security.User1_Passwor
d
String
System.Security.User1_Password = user1pw
System.Security.User1_Password<Restricted>
!Done System.Security.User1_Password =
user1pw
System Commands
17
Description
Read only.
Get the guest account username.
Note that this is fixed to “guest”.
Restricted.
It is not possible to read or set the guest
password.
Note that this is fixed to “guestpw”
Read only.
Get the timeout period for the guest
account in seconds.
Note that this is fixed to 300.
Read only.
Get the guest account role.
Note that this is fixed to “Guest”
Get or set the account username.
The default is “user1”.
Note that a PowerUser may change their
own account Username while an
Administrator may change other
account Usernames.
Write only.
Set the account password.
The default is “user1pw”.
Note that a PowerUser may change their
own account password while an
Administrator may change the
passwords for other accounts.
Command
User1_Timeout
Syntax
System.Security.User1_Timeout
Type
Integer
Example
System.Security.User1_Timeout = 300
!Done System.Security.User1_Timeout
User1_Role
System.Security.User1_Role
Role
System.Security.User1_Role = PowerUser
!Done System.Security.User1_Role
User2_Username
System.Security.User2_Userna
me
String
System.Security.User2_Username = user2
!Done System.Security.User2_Username
User2_Password
System.Security.User2_Passwor
d
String
System.Security.User2_Password = user2pw
System.Security.User2_Password<Restricted>
!Done System.Security.User2_Password =
user2pw
System Commands
18
Description
Get or set the account timeout in
seconds.
The account will be automatically logged
out when the timeout expires.
The default is 300 (5 minutes).
Setting the timeout to 0 disables the
timeout (infinite).
Warning it is possible to set the timeout
value so low that the system is unusable,
it is recommended that values between
1 and 300 are not used.
Get or set the account role.
The default is “PowerUser”.
Note that the role may only be changed
by an Administrator.
Get or set the account username.
The default is “User”.
Note that a PowerUser may change their
own account Username while an
Administrator may change other
account Usernames.
Write only.
Set the account password.
The default password is “user2pw”.
Note that a PowerUser may change their
own account password while an
Administrator may change the
passwords for other accounts.
Command
User2_Timeout
Syntax
System.Security.User2_Timeout
Type
Integer
Example
System.Security.User2_Timeout = 300
!Done System.Security.User2_Timeout
User2_Role
System.Security.User2_Role
Role
System.Security.User2_Role = User
!Done System.Security.User2_Role
User3_Username
System.Security.User3_Userna
me
String
System.Security.User3_Username = user3
!Done System.Security.User3_Username
User3_Password
System.Security.User3_Passwor
d
String
System.Security.User3_Password = user3pw
System.Security.User3_Password<Restricted>
!Done System.Security.User3_Password =
user3pw
System Commands
19
Description
Get or set the account timeout in
seconds.
The account will be automatically logged
out when the timeout expires.
The default timeout is 300 seconds (5
minutes).
Setting the timeout to 0 disables the
timeout (infinite).
Warning it is possible to set the timeout
value so low that the system is unusable,
it is recommended that values between
1 and 300 are not used.
Get or set the account role.
The default role is “User”.
Note that the role may only be changed
by an Administrator.
Get or set the account username.
The default is “User”.
Note that a PowerUser may change their
own account Username while an
Administrator may change other
account Usernames.
Write only.
Set the account password.
The default password is “user3pw”.
Note that a PowerUser may change their
own account password while an
Administrator may change the
passwords for other accounts.
Command
User3_Timeout
Syntax
System.Security.User3_Timeout
Type
Integer
Example
System.Security.User3_Timeout = 300
!Done System.Security.User3_Timeout
User3_Role
System.Security.User3_Role
Role
System.Security.User3_Role = User
!Done System.Security.User3_Role
User4_Username
System.Security.User4_Userna
me
String
System.Security.User4_Username = user4
!Done System.Security.User4_Username
User4_Password
System.Security.User4_Passwor
d
String
System.Security.User4_Password = user4pw
System.Security.User4_Password<Restricted>
!Done System.Security.User4_Password =
user3pw
System Commands
20
Description
Get or set the account timeout in
seconds.
The account will be automatically logged
out when the timeout expires.
The default timeout is 300 seconds (5
minutes).
Setting the timeout to 0 disables the
timeout (infinite).
Warning it is possible to set the timeout
value so low that the system is unusable,
it is recommended that values between
1 and 300 are not used.
Get or set the account role.
The default role is “User”.
Note that the role may only be changed
by an Administrator.
Get or set the account username.
The default is “User”.
Note that a PowerUser may change their
own account Username while an
Administrator may change other
account Usernames.
Write only.
Set the account password.
The default password is “user4pw”.
Note that a PowerUser may change their
own account password while an
Administrator may change the
passwords for other accounts.
Command
User4_Timeout
Syntax
System.Security.User4_Timeout
Type
Integer
Example
System.Security.User3_Timeout = 300
!Done System.Security.User3_Timeout
User4_Role
System.Security.User4_Role
Role
System.Security.User3_Role = User
!Done System.Security.User3_Role
Admin_Username
System.Security.Admin_Userna
me
String
System.Security.Admin_Username = admin
!Done System.Security.Admin_Username
Admin_Password
System.Security.Admin_Passwo
rd
String
System.Security.Admin_Password = adminpw
System.Security.Admin_Password<Restricted>
!Done System.Security.Admin_Password =
adminpw
System Commands
21
Description
Get or set the account timeout in
seconds.
The account will be automatically logged
out when the timeout expires.
The default timeout is 300 seconds (5
minutes).
Setting the timeout to 0 disables the
timeout (infinite).
Warning it is possible to set the timeout
value so low that the system is unusable,
it is recommended that values between
1 and 300 are not used.
Get or set the account role.
The default role is “User”.
Note that the role may only be changed
by an Administrator.
Get or set the account username.
The default is “admin”.
Note that a PowerUser may change their
own account Username while an
Administrator may change other
account Usernames.
Write only.
Set the account password.
The default password is “adminpw”.
Note that a PowerUser may change their
own account password while an
Administrator may change the
passwords for other accounts.
Command
Admin_Timeout
Syntax
System.Security.Admin_Timeou
t
Type
Integer
Example
System.Security.Admin_Timeout = 300
!Done System.Security.Admin_Timeout
Admin_Role
System.Security.Admin_Role
Role
System.Security.Admin_Role = Administrator
!Done System.Security.Admin_Role
Test_Username
System.Security.Test_Usernam
e
String
System.Security.Test_Username = test
!Done System.Security.Test_Username
Test_Password
System.Security.Test_Password
String
System.Security.Test_Password = testpw
System.Security.Test_Password<Restricted>
!Done System.Security.Test_Password = testpw
System Commands
22
Description
Get or set the account timeout in
seconds.
The account will be automatically logged
out when the timeout expires.
The default timeout is 300 seconds (5
minutes).
Setting the timeout to 0 disables the
timeout (infinite).
Warning it is possible to set the timeout
value so low that the system is unusable,
it is recommended that values between
1 and 300 are not used.
Get or set the account role.
The default role is “Administrator”.
Note that the role may only be changed
by an Administrator.
Get or set the account username.
The default is “test”.
Note that a PowerUser may change their
own account Username while an
Administrator may change other
account Usernames.
Write only.
Set the account password.
The default password is “testpw”.
Note that a PowerUser may change their
own account password while an
Administrator may change the
passwords for other accounts.
Command
Test_Timeout
Syntax
System.Security.Test_Timeout
Type
Integer
Example
System.Security.Test_Timeout = 14400
!Done System.Security.Test_Timeout
Test_Role
System.Security.Test_Role
Role
System.Security.Test_Role = Test
!Done System.Security.Test_Role
System Commands
23
Description
Get or set the account timeout in
seconds.
The account will be automatically logged
out when the timeout expires.
The default timeout is 14400 seconds (4
hours).
Setting the timeout to 0 disables the
timeout (infinite).
Warning it is possible to set the timeout
value so low that the system is unusable,
it is recommended that values between
1 and 300 are not used.
Get or set the account role.
The default role is “Test”.
Note that the role may only be changed
by an Administrator.
Resources Commands
Properties
Command
Resources
Syntax
Resources
Type
List
Configs
Resources.Configs
List
EDID
Resources.EDID
List
Resources Commands
Example
Resources.ConfigList()
Resources.Configs = <...>
Resources.EDID = <...>
Resources.TPG = <...>
Resources.LOGO = <No Value>
Resources.STILL = <No Value>
Resources.WARP = <No Value>
Resources.Resolutions = <...>
!Done Resources
Resources.Configs.Config1 = <...>
Resources.Configs.Config2 = <...>
…
Resources.Configs.Config19 = <...>
Resources.Configs.Config20 = <...>
!Done Resources.Configs
Resources.EDID.S10I1 = <...>
Resources.EDID.S10I2 = <...>
Resources.EDID.S10O1 = <...>
Resources.EDID.S10O2 = <...>
…
Resources.EDID.S16I1 = <...>
Resources.EDID.S16I2 = <...>
Resources.EDID.S16O1 = <...>
Resources.EDID.S16O2 = <...>
Resources.EDID.S1I2 = <...>
Resources.EDID.S1O2 = <...>
…
Resources.EDID.S9I1 = <...>
Resources.EDID.S9I2 = <...>
Resources.EDID.S9O1 = <...>
Resources.EDID.S9O2 = <...>
!Done Resources.EDID
24
Description
List all of the Resources commands and
display the values of the properties
List all of the configuration slots
(currently 1-20).
See Resources Configuration Commands
on page 26 below.
List every EDID for every potential input
and output.
Note that the order of the output starts
at Slot 10 and works through to Slot 16
then starts again at Slot 1 and goes
through to Slot 9.
For more information see Resources
EDID Commands on page 29 below.
Command
TPG
Syntax
Resources.TPG
Type
List
Example
Resources.TPG.TPG1 = <...>
!Done Resources.TPG
LOGO
LOGO
WARP
Resolutions
Resources.LOGO
Resources.STILL
Resources.WARP
Resources.Resolutions
List
Resolutions.Resolution1 = <...>
Resolutions.Resolution2 = <...>
…
Resolutions.Resolution1000 = <...>
Resolutions.Resolution1001 = <...>
…
Resolutions.Resolution1008 = <...>
Resolutions.Resolution1009 = <...>
!Done Resolutions
Syntax
Resources.ConfigList()
Type
List
Example
Resources.ConfigList[2]=Chico
Resources.ConfigList[9]=Groucho
Resources.ConfigList[13]=Harpo
!Done Resources.ConfigList()
Description
List the test pattern generator
attributes.
For more information see Resources
Test Pattern Commands below.
Note that there is only one test pattern
generator (TPG1).
Not used.
Not used.
Not used.
List of all the supported video
resolutions, including the user
configurable custom resolutions.
For more information see Resources
Resolutions Commands on page 33
below.
Methods
Command
ConfigList
Resources Commands
25
Description
List the saved configurations by name
Resources Configuration Commands
Properties
Command
Configs
Syntax
Resources.Configs
Type
List
Config<number>
Resources.Configs.Config1
List
Directory
Resources.Configs.Config1.Dire
ctory
String
Resources Commands
Example
Resources.Configs.Config1 = <...>
Resources.Configs.Config2 = <...>
…
Resources.Configs.Config19 = <...>
Resources.Configs.Config20 = <...>
!Done Resources.Configs
Resources.Configs.Config1.Directory =
mmc:\TVONE\CONFIGS\C1
Resources.Configs.Config1.Backup()
Resources.Configs.Config1.Restore()
Resources.Configs.Config1.Remove()
!Done Resources.Configs.Config1
Resources.Configs.Config1.Directory =
mmc:\TVONE\CONFIGS\C1
!Done Resources.Configs.Config1.Directory
26
Description
List all 20 of the configurations.
List all of the commands and display the
values of the properties for the specified
configuration.
Read only.
Get the name and path of the
configuration file for this configuration.
Methods
Command
Backup
Syntax
Resources.Configs.Config1.Back
up()
Type
Void
Restore
Resources.Configs.Config1.Rest
ore()
Void
Resources Commands
Example
// Backup: File delete:
mmc:\TVONE\CONFIGS\C1\SETTINGS\SETUP_
M.TXT
…
// Backup: File delete:
mmc:\TVONE\CONFIGS\C1\EDID\DEFAULTS\W
UXGA.EDD
// Backup: File copy:
nand:\TVONE\SETTINGS\SETUP_M.TXT
…
// Backup: File copy:
nand:\TVONE\EDID\DEFAULTS\WUXGA.EDD
// Backup: Dir made:
mmc:\TVONE\CONFIGS\C1\PRESETS\U_D1000
// Backup: Complete
!Done Resources.Configs.Config1.Backup()
// Restore: File delete:
nand:\TVONE\SETTINGS\SETUP_M.TXT
...
// Restore: File delete:
nand:\TVONE\EDID\DEFAULTS\WUXGA.EDD
// Restore: File copy:
mmc:\TVONE\CONFIGS\C1\SETTINGS\SETUP_
M.TXT
...
// Restore: File copy:
mmc:\TVONE\CONFIGS\C1\EDID\DEFAULTS\W
UXGA.EDD
// Restore: Complete
!Done Resources.Configs.Config1.Restore()
27
Description
Backup the specified configuration from
NAND to SD card.
This is similar to
“System.BackupToSDCard()” but for this
configuration only.
Restore the specified configuration from
SD card to NAND
This is similar to
“System.RestoreBackup()” but for this
configuration only.
Command
Remove
Syntax
Resources.Configs.Config1.Rem
ove()
Resources Commands
Type
Void
Example
// Remove: File delete:
mmc:\TVONE\CONFIGS\C1\SETTINGS\SETUP_
M.TXT
...
// Remove: File delete:
mmc:\TVONE\CONFIGS\C1\EDID\DEFAULTS\W
UXGA.EDD
// Remove: Complete
!Done Resources.Configs.Config1.Remove()
28
Description
Remove the specified configuration from
the SD card.
Resources EDID Commands
EDID methods for each possible connection in the device are accessed by slot number and input or output number.
It is possible to use EDID.S<n>I<n> in place of Resources.EDID.S<n>I<n> and EDID.S<n>O<n> in place of Resources.EDID.S<n>O<n>.
Where:
EDID.S<n>I<n>
EDID.S<n>O<n>
EDID.S<n><X><n>
is an input connection of the form EDID.S1I1.
is an output connection of the form EDID.S1O1.
is an input or an output of the form EDID.S<n>I<n> or EDID.S<n>O<n>.
Properties
Command
EDID.S<n><X><n>
Syntax
EDID.S<n><X><n>
Type
List
Filename
EDID.S<n><X><n>.Filename
String
EDIDVersion
EDID.S<n><X><n>.EDIDVersion
String
Manufacturer
EDID.S<n><X><n>.Manufacture
r
EDID.S<n><X><n>.Name
String
Name
Resources Commands
String
Example
EDID.S3I1.Filename =
nand:\TVONE\EDID\S3I1.EDD
EDID.S3I1.EDIDVersion = 1.3
EDID.S3I1.Manufacturer = TVO
EDID.S3I1.Name = TVOneCORIOmax
EDID.S3I1.SerialNumber = 0
EDID.S3I1.ManufactureDate = 201310
EDID.S3I1.Width_mm = 600
EDID.S3I1.Height_mm = 450
EDID.S3I1.HorizBdr_pix = 0
EDID.S3I1.VertBdr_pix = 0
EDID.S3I1.Extensions = 1
EDID.S3I1.Resolutions()
EDID.S3I1.Remove_File()
!Done EDID.S3I1
EDID.S3I1.Filename =
nand:\TVONE\EDID\S3I1.EDD
!Done EDID.S3I1.Filename
EDID.S3I1.EDIDVersion = 1.3
!Done EDID.S3I1.EDIDVersion
EDID.S3I1.Manufacturer = TVO
!Done EDID.S3I1.Manufacturer
EDID.S3I1.Name = TVOneCORIOmax
!Done EDID.S3I1.Name
29
Description
Read only.
List all of the EDID properties for the
specified input on the specified slot.
An input will always show the EDID
information from the file specified in the
Filename attribute.
Read only.
Get the path and filename of the EDID
file currently used for this connection.
Read only.
Get the EDID software version
Read only.
Get the manufacturer.
Read only.
Get the name
Command
SerialNumber
Syntax
EDID.S<n><X><n>.SerialNumber
Type
Integer
ManufactureDate
EDID.S<n><X><n>.Manufacture
Date
String
Width_mm
EDID.S<n><X><n>.Width_mm
Integer
EDID.S3I1.Width_mm = 600
!Done EDID.S3I1.Width_mm
Height_mm
EDID.S<n><X><n>.Height_mm
Integer
EDID.S3I1.Height_mm = 450
!Done EDID.S3I1.Height_mm
HorizBdr_pix
EDID.S<n><X><n>.HorizBdr_pix
Integer
EDID.S3I1.HorizBdr_pix = 0
!Done EDID.S3I1.HorizBdr_pix
VertBdr_pix
EDID.S<n><X><n>.VertBdr_pix
Integer
EDID.S3I1.VertBdr_pix = 0
!Done EDID.S3I1.VertBdr_pix
Extensions
EDID.S<n><X><n>.Extensions
Integer
EDID.S3I1.Extensions = 1
!Done EDID.S3I1.Extensions
Resources Commands
Example
EDID.S3I1.SerialNumber = 0
!Done EDID.S3I1.SerialNumber
EDID.S3I1.ManufactureDate = 201310
!Done EDID.S3I1.ManufactureDate
30
Description
Read only.
Get the serial number.
Read only.
Get the manufacture date in the form
YYYYWW, where YYYY is the year and
WW is the week.
Read only.
Get the addressable video image size of
attached display, in millimetres
Read only.
Get the addressable video image size of
attached display, in millimetres
Read only.
Get the image border size of attached
display, in pixels
Read only.
Get the image border size of attached
display, in pixels
Read only.
Get the number of 128-byte extension
blocks included in EDID.
Methods
Command
Resolutions
Syntax
EDID.S<n><X><n>.Resolutions()
Type
List
Remove_File
EDID.S<n><X><n>.Remove_File(
)
Void
Resources Commands
Example
// EDID.S3I1.Resolutions()
720x400p70
640x480p60
640x480p72
800x600p56
1280x960p60
1280x1024p60
1280x800p60
1920x1080p60
1600x1000p60
1600x1200p60
1680x1050p60
1920x1200p60
1920x1200p60
1280x720p60
!Done EDID.S3I1.Resolutions()
EDID.S3I1.Remove_File()
!Done EDID.S3I1.Remove_File()
31
Description
Read only.
List the resolutions available for the
specified connection.
Removes the corresponding EDID file.
Warning this removes the connection
from the EDID list.
Resources Test Pattern Commands
Note that only one test pattern generator (TPG1) is supported.
Properties
Command
TPG
Syntax
Resources.TPG
Type
List
TPG1
Resources.TPG.TPG1
List
TPG1.Resolution
Resources.TPG.TPG1.Resolution
Resolution
Resources.TPG.TPG1.Resolution =
1280x720p60
!Done Resources.TPG.TPG1.Resolution =
1280x720p60
TPG1.Pattern
Resources.TPG.TPG1.Pattern
TestPattern
TPG1.Moving_Bar
Resources.TPG.TPG1.Moving_B
ar
Boolean
Resources.TPG.TPG1.Pattern = RGB_100
!Done Resources.TPG.TPG1.Pattern
Resources.TPG.TPG1.Moving_Bar = Off
!Done Resources.TPG.TPG1.Moving_Bar
Resources Commands
Example
Resources.TPG.TPG1 = <...>
!Done Resources.TPG
Resources.TPG.TPG1
Resources.TPG.TPG1.Resolution =
1280x720p60
Resources.TPG.TPG1.Pattern = RGB_100
Resources.TPG.TPG1.Moving_Bar = Off
!Done Resources.TPG.TPG1
32
Description
List the test pattern generators.
List the test pattern attributes
Resolution is 1280x720p60 but can be
modified to any of the supported output
resolutions.
Pattern is “RGB_100” by default but can
also be “Black”, “8x8_Grid”, “Dot”, or
“8x8_ChqBrd”.
Moving Bar is either “Off” or “On”, with
default value of “Off”.
Get or set the resolution for the Test
Pattern Generator.
The resolution is set by name, see the
name property in Resources Resolutions
Commands on page 33on page 33
below.
Get or set the test pattern.
The default value is “RGB_100”
Get or set if the moving bar is enabled.
The default value is Off
Resources Resolutions Commands
List of all the supported video resolutions, including the user defined Custom Resolutions.
The system resolutions are read only and numbered from 1.
The custom resolutions can be modified and are numbered from 1000.
For more information on programming Custom Resolutions see the Resolution Editor Programming Guide.
It is possible to use Resolutions in place of Resources.Resolutions.
Properties for the System (built-in) resolutions are all Read Only.
Properties for the Custom Resolutions (Resolution1000 onwards) are Read/Write except where marked as Read only.
Properties
Command
Resolutions
Syntax
Resolutions
Type
List
Resolutions.Resolut
ion<n>
Resolutions.Resolution<n>
List
Resources Commands
Example
Resolutions.Resolution1 = <...>
Resolutions.Resolution2 = <...>
…
Resolutions.Resolution1000 = <...>
Resolutions.Resolution1001 = <...>
…
Resolutions.Resolution1008 = <...>
Resolutions.Resolution1009 = <...>
!Done Resolutions
Resolutions.Resolution1.Name = 640x480p60
Resolutions.Resolution1.Aspect = 4:3
Resolutions.Resolution1.CanFramelock = No
Resolutions.Resolution1.PixelClock = 25175000
Resolutions.Resolution1.ScanType = p
Resolutions.Resolution1.HActive = 640
Resolutions.Resolution1.HFrontPorch = 16
Resolutions.Resolution1.HSyncPulse = 96
Resolutions.Resolution1.HBackPorch = 48
Resolutions.Resolution1.VActive = 480
Resolutions.Resolution1.VFrontPorch = 10
Resolutions.Resolution1.VSyncPulse = 2
Resolutions.Resolution1.VBackPorch = 33
Resolutions.Resolution1.HSyncPolarity = N
Resolutions.Resolution1.VSyncPolarity = N
33
Description
List of all the supported video
resolutions, including the user
configurable custom resolutions.
List the properties of the specified
resolution.
Command
Syntax
Type
Name
Resolutions.Resolution<n>.Nam
e
Resolutions.Resolution<n>.Aspe
ct
String
Aspect
CanFramelock
PixelClock
ScanType
HActive
HFrontPorch
HSyncPulse
HBackPorch
VActive
VFrontPorch
VSyncPulse
Resolutions.Resolution<n>.CanF
ramelock
Resolutions.Resolution<n>.Pixel
Clock
Resolutions.Resolution<n>.Scan
Type
AspectRatio
Integer
ScanMode
Resolutions.Resolution<n>.HAct
ive
Resolutions.Resolution<n>.HFro
ntPorch
Integer
Resolutions.Resolution<n>.HSy
ncPulse
Resolutions.Resolution<n>.HBa
ckPorch
Integer
Resolutions.Resolution<n>.VAct
ive
Resolutions.Resolution<n>.VFro
ntPorch
Resolutions.Resolution<n>.VSyn
cPulse
Integer
Resources Commands
Integer
Integer
Integer
Integer
Example
Resolutions.Resolution1.CEAID = 1
Resolutions.Resolution1.Origin = tvONE
!Done Resolutions.Resolution1
Resolutions.Resolution1.Name = 640x480p60
!Done Resolutions.Resolution1.Name
Resolutions.Resolution1.Aspect = 4:3
!Done Resolutions.Resolution1.Aspect
Description
Resolutions.Resolution1.PixelClock = 25175000
!Done Resolutions.Resolution1.PixelClock
Resolutions.Resolution1.ScanType = p
!Done Resolutions.Resolution1.ScanType
Get or set the speed of the Pixel Clock in
pixels per second for this resolution.
Get or set the scan type for this
Resolution:
p Progressive.
i Interlaced scan mode.
Get or set the length of the Horizontal
Active Video for this resolution
Get or set the timing interval for the
Horizontal Front Porch for this
resolution.
Get or set the length of the Horizontal
Sync Pulse for this resolution.
Get or set the timing interval for the
Horizontal Back Porch for this
resolution.
Get or set the length of the Vertical
Active Video for this resolution
Get or set the timing interval for the
Vertical Front Porch for this resolution.
Get or set the length of the Vertical Sync
Pulse for this resolution.
Resolutions.Resolution1.HActive = 640
!Done Resolutions.Resolution1.HActive
Resolutions.Resolution1.HFrontPorch = 16
!Done Resolutions.Resolution1.HFrontPorch
Resolutions.Resolution1.HSyncPulse = 96
!Done Resolutions.Resolution1.HSyncPulse
Resolutions.Resolution1.HBackPorch = 48
!Done Resolutions.Resolution1.HBackPorch
Resolutions.Resolution1.VActive = 480
!Done Resolutions.Resolution1.VActive
Resolutions.Resolution1.VFrontPorch = 10
!Done Resolutions.Resolution1.VFrontPorch
Resolutions.Resolution1.VSyncPulse
Resolutions.Resolution1.VSyncPulse = 2
34
Get or set the name of this resolution.
Get or set the aspect ratio of this
resolution
Used assist in the signal conversion
when an input and the output have
different aspect ratio.
Not used.
Command
VBackPorch
Syntax
Resolutions.Resolution<n>.
VBackPorch
Resolutions.Resolution<n>.HSy
ncPolarity
Type
Integer
VSyncPolarity
Resolutions.Resolution<n>.VSyn
cPolarity
Polarity
Resolutions.Resolution1.VSyncPolarity = N
!Done Resolutions.Resolution1.VSyncPolarity
CEAID
Resolutions.Resolution<n>.CEAI
D
Integer
Resolutions.Resolution1.CEAID = 1
!Done Resolutions.Resolution1.CEAID
Origin
Resolutions.Resolution<n>.Origi
n
String
Resolutions.Resolution1.Origin = tvONE
!Done Resolutions.Resolution1.Origin
Type
List
Example
Aliases.Preset = Routing.Preset
Aliases.Windows = Routing.Windows
Aliases.Canvases = Routing.Canvases
Aliases.Layouts = Routing.Layouts
Aliases.MonitorViews = Routing.Monitorviews
Aliases.s1i1 = Slots.Slot1.In1
…
Aliases.s16o2 = Slots.Slot16.Out2
!Done Aliases
HSyncPolarity
Polarity
Example
Resolutions.Resolution1.VBackPorch = 33
!Done Resolutions.Resolution1.VBackPorch
Resolutions.Resolution1.HSyncPolarity = N
!Done Resolutions.Resolution1.HSyncPolarity
Description
Get or set the timing interval for the
Vertical Back Porch for this resolution.
Get or set the Horizontal Sync Polarity.
N = Negative
P = Positive
Get or set the Vertical Sync Polarity.
N = Negative
P = Positive
Get or set the Consumer Electronics
Association Digital Television Profile as
defined in CEA-861-D
Get or set the origin of the Custom
Resolution.
Aliases Commands
Properties
Command
Aliases
Aliases Commands
Syntax
Aliases
35
Description
Displays defined aliases. Syntax:
aliases.<alias> = <command>
For example, “Preset” is an alias for
“Routing.Preset” and typing “s1i1” is the
same as typing “Slots.Slot1.In1”.
Slots Commands
It is possible to use Slot<n> in place of Slots.Slot<n>.
Properties
Command
Slots
Slots Commands
Syntax
Slots
Type
List
Example
Slots.Slot1 = <...>
Slots.Slot2 = <...>
Slots.Slot3 = <...>
Slots.Slot4 = NO CARD
Slots.Slot5 = NO CARD
Slots.Slot6 = NO CARD
Slots.Slot7 = NO CARD
Slots.Slot8 = NO CARD
Slots.Slot9 = NO CARD
Slots.Slot10 = NO CARD
Slots.Slot11 = NO CARD
Slots.Slot12 = NO CARD
Slots.Slot13 = NO CARD
Slots.Slot14 = <...>
Slots.Slot15 = <...>
Slots.Slot16 = <...>
!Done Slots
36
Description
List all of the slots and report either the
slot properties if there is a card or NO
CARD if not.
DVI Input Module
It is possible to use Slot<n>.In<n> and S<n>I<n> in place of Slots.Slot<n>.In<n>.
Properties
Property Name
Slot<n>
Syntax
Slot<n>
Type
List
Cardtype
Slot<n>.Cardtype
CardTypeEn
um
CardData
In<n>
Slot<n>.Carddata
Slot<n>.In<n>
Slots Commands
List
Example
Slot3.Cardtype = DVI_U 2-in
Slot3.Carddata = <No Value>
Slot3.In1 = <...>
Slot3.In2 = <...>
Slot3.PhaseRetrain()
Slot3.Module_Resolutions()
!Done Slot3
Slot3.Cardtype = DVI_U 2-in
!Done Slot3.Cardtype
Slot3.In1.FullName = In1
Slot3.In1.Status = OK
Slot3.In1.Alias = s3i1
Slot3.In1.WindowList = Window1,Window2
Slot3.In1.TypeChoice = DVI
Slot3.In1.AspectChoice = 4:3
Slot3.In1.Brightness = 0
Slot3.In1.Contrast = 100
Slot3.In1.ColourScale = Auto
Slot3.In1.TPG = Off
Slot3.In1.Set_Resolution = 640x480p60
Slot3.In1.Measured_Resolution = 640x480p60
Slot3.In1.Measured_Width = 640
Slot3.In1.Measured_Height = 480
Slot3.In1.Measured_Field_Rate = 60
Slot3.In1.Measured_VTotal = 525
Slot3.In1.Measured_Frame_ip = p
Slot3.In1.EDID_Filename = s3i1.edd
Slot3.In1.ForceLinkRefresh()
Slot3.In1.LeftCrop = 0
Slot3.In1.RightCrop = 0
37
Description
List all of the properties of the card in
this slot or “NO CARD” if the slot is
empty.
Read-only.
Get the type of the card in this slot
Not used.
List the properties for an Input on the
given Slot.
Where In<n> is the input on the card.
Property Name
Syntax
Type
FullName
Slot<n>.In<n>.FullName
String
Status
Slot<n>.In<n>.Status
StatusEnum
Alias
Slot<n>.In<n>.Alias
String
WindowList
Slot<n>.In<n>.WindowList
String
Slots Commands
Example
Slot3.In1.TopCrop = 0
Slot3.In1.BottomCrop = 0
Slot3.In1.AnH_Offset = 0
Slot3.In1.AnV_Offset = 0
Slot3.In1.OnSrcLossColour = Blue
Slot3.In1.HDCP_Enabled = Supported
Slot3.In1.HDCP_Required = Off
Slot3.In1.HDMI = Found
Slot3.In1.Audio = Found
Slot3.In1.AudInA = NULL
Slot3.In1.AudInB = NULL
Slot3.In1.AudInC = NULL
Slot3.In1.AudInD = NULL
Slot3.In1.AFVChoiceA = Slot3.In1.AudInA
Slot3.In1.AFVChoiceB = Slot3.In1.AudInB
Slot3.In1.AFVChoiceC = Slot3.In1.AudInC
Slot3.In1.AFVChoiceD = Slot3.In1.AudInD
Slot3.In1.View = MonitorViews.View2
Slot3.In1.ViewPosCode = 17
Slot3.In1.AudioBars = 4
Slot3.In1.PreviewVideoType = 0
Slot3.In1.Equipment =
Slot3.In1.CanFramelockTo = No
Slot3.In1.dll = 16
Slot3.In1.imm = Yes
!Done Slot3.In1
Slot3.In1.FullName = In1
!Done Slot3.In1.FullName
Slot3.In1.Status = OK
!Done Slot3.In1.Status
Slot3.In1.Alias = s3i1
!Done Slot3.In1.Alias
Slot3.In1.WindowList = Window1
!Done Slot3.In1.WindowList
38
Description
Read-only.
Get the full name of the Window
Read-only.
Get the status of the input.
Get or set the Alias name for this input.
Read only.
Get the window that the slot is routed
to.
Property Name
TypeChoice
Syntax
Slot<n>.In<n>.TypeChoice
Type
TypeChoice
AspectChoice
Slot<n>.In<n>.AspectChoice
AspectRatio
Brightness
Slot<n>.In<n>.Brightness
Integer
Contrast
Slot<n>.In<n>.Contrast
Percentage
Slot3.In1.Contrast = 100
!Done Slot3.In1.Contrast
ColourScale
Slot<n>.In<n>.ColourScale
ColourScale
TPG
Slot<n>.In<n>.TPG
Boolean
Slot3.In1.ColourScale = Auto
!Done Slot3.In1.ColourScale
Slot3.In1.TPG = TPG1
!Done Slot3.In1.TPG = TPG1
Set_Resolution
Slot<n>.In<n>.Set_Resolution
Resolution
Slot3.In1.Set_Resolution = 640x480p60
!Done Slot3.In1.Set_Resolution
Measured_Resoluti
on
Slot<n>.In<n>.Measured_Resol
ution
Resolution
Slot3.In1.Measured_Resolution = 640x480p60
!Done Slot3.In1.Measured_Resolution
Measured_Width
Slot<n>.In<n>.Measured_Width
Integer
Slot3.In1.Measured_Width = 640
!Done Slot3.In1.Measured_Width
Measured_Height
Slot<n>.In<n>.Measured_Heigh
t
Integer
Slot3.In1.Measured_Height = 480
!Done Slot3.In1.Measured_Height
Measured_Field_Ra
te
Slot<n>.In<n>.Measured_Field_
Rate
Integer
Slot3.In1.Measured_Field_Rate = 60
!Done Slot3.In1.Measured_Field_Rate
Measured_VTotal
Slot<n>.In<n>.Measured_VTota
l
Integer
Slot3.In1.Measured_VTotal = 525
!Done Slot3.In1.Measured_VTotal
Slots Commands
Example
Slot3.In1.TypeChoice = DVI
!Done Slot3.In1.TypeChoice = DVI
Slot3.In1.AspectChoice = 4:3
!Done Slot3.In1.AspectChoice = 4:3
Slot3.In1.Brightness = 0
!Done Slot3.In1.Brightness
39
Description
Get or set the type of signal encoding on
the input.
Get or set the aspect ratio for this input.
Get or set the brightness adjustment for
this input.
Valid range is from -30 to 30
Get or set the contrast adjustment for
the Input.
Valid range is from 30% to 130%
Get or set the colour scale for this input.
Get or set to use the internal Test
Pattern Generator (TPG1) for this input.
Options are “Off” or “TPG1”.
Read-only.
Get the current resolution set for this
input.
Read-only.
Get the resolution being read from this
Input.
Read-only.
Get the width of the resolution being
read from this input.
Read-only.
Get the measured height of the
resolution being read from this input.
Read-only.
Get the measured field rate of the
resolution being read from this input.
Read-only.
Get the measured total vertical lines of
the resolution being read from this
input.
Property Name
Measure_Frame_ip
Syntax
Slot<n>.In<n>.Measure_Frame_
ip
Type
FrameType
Example
Slot3.In1.Measured_Frame_ip = p
!Done Slot3.In1.Measured_Frame_ip
EDID_Filename
Slot<n>.In<n>.EDID_Filename
String
LeftCrop
Slot<n>.In<n>.LeftCrop
Integer
RightCrop
Slot<n>.In<n>.RightCrop
Integer
TopCrop
Slot<n>.In<n>.TopCrop
Integer
BottomCrop
Slot<n>.In<n>.BottomCrop
Integer
AnH_Offset
Slot<n>.In<n>.AnH_Offset
Integer
Slot3.In1.EDID_Filename = s3i1.edd
!Done Slot3.In1.EDID_Filename
Slot3.In1.LeftCrop = 0
!Done Slot3.In1.LeftCrop
Slot3.In1.RightCrop = 0
!Done Slot3.In1.RightCrop
Slot3.In1.TopCrop = 0
!Done Slot3.In1.TopCrop
Slot3.In1.BottomCrop = 0
!Done Slot3.In1.BottomCrop
Slot3.In1.AnH_Offset = 0
!Done Slot3.In1.AnH_Offset
AnV_Offset
Slot<n>.In<n>.AnV_Offset
Integer
Slot6.In1.AnV_Offset = 0
!Done Slot6.In1.AnV_Offset
OnSrcLossColor
Slot<n>.In<n>.OnSrcLossColor
SrcLossColor
HDCP_Enabled
Slot<n>.In<n>.HDCP_Enabled
HDCPSup
Slot6.In1.OnSrcLossColor = Blue
!Done Slot6.In1.OnSrcLossColor
Slot3.In1.HDCP_Enabled = Supported
!Done Slot3.In1.HDCP_Enabled
HDCP_Required
Slot<n>.In<n>.HDCP_Required
HDCPReq
Slot3.In1.HDCP_Required = Off
!Done Slot3.In1.HDCP_Required
HDMI
Slot<n>.In<n>.HDMI
FoundNot
Slot3.In1.HDMI = Found
!Done Slot3.In1.HDMI
Slots Commands
40
Description
Read-only.
Get the measured frame type of the
resolution being read from this input.
Get or set the EDID file currently being
used for this input.
Get or set the amount of left crop to be
applied to this input.
Get or set the amount of right crop to be
applied to this input.
Get or set the amount of top crop to be
applied to this input.
Get or set the amount of bottom crop to
be applied to this input.
Not applicable to SDI cards.
Adjust the horizontal position of
component analog input, measured in
lines.
Range from -100 to 100.
Not applicable to SDI cards.
Adjust the vertical position of
component analog input, measured in
lines.
Range from -100 to 100.
Get or set the colour to be displayed
when the input source is lost.
Not applicable to SDI cards.
Get or set if HDCP is enabled for this
source
Not applicable to SDI cards.
Read-only.
Get the HDCP capability of the input
source.
Read-only.
Get the detected HDMI status.
Property Name
Audio
Syntax
Slot<n>.In<n>.Audio
Type
FoundOff
AudInA
Slot<n>.In<n>.AudInA
String
AudInB
Slot<n>.In<n>.AudInB
String
AudInC
Slot<n>.In<n>.AudInC
String
AudInD
Slot<n>.In<n>.AudInD
String
AFVChoiceA
Slot<n>.In<n>.AFVChoiceA
AudioInput
AFVChoiceB
Slot<n>.In<n>.AFVChoiceB
AudioInput
AFVChoiceC
Slot<n>.In<n>.AFVChoiceC
AudioInput
AFVChoiceD
Slot<n>.In<n>.AFVChoiceD
AudioInput
View
Slot<n>.Out<n>.View
String
ViewPosCode
Slot<n>.Out<n>.ViewPosCode
Integer
Slot3.In1.View = MonitorViews.View2
!Done Slot3.In1.View = MonitorViews.View2
AudioBars
Slot<n>.In<n>.AudioBars
Integer
Slot3.In1.AudioBars = 4
!Done Slot3.In1.AudioBars
PreviewVideoType
Slot<n>.In<n>.PreviewVideoTyp
e
Slot<n>.In<n>.Equipment
Equipment
Slots Commands
Example
Slot3.in1.Audio = Found
!Done Slot3.in1.Audio
Slot3.In1.AudInA = NULL
!Done Slot3.In1.AudInA
Slot3.In1.AudInB = NULL
!Done Slot3.In1.AudInB
Slot3.In1.AudInC = NULL
!Done Slot3.In1.AudInC
Slot3.In1.AudInD = NULL
!Done Slot3.In1.AudInD
Slot3.In1.AFVChoiceA = Slot3.In1.AudInA
!Done Slot3.In1.AFVChoiceA
Slot3.In1.AFVChoiceB = Slot3.In1.AudInB
!Done Slot3.In1.AFVChoiceB
Slot3.In1.AFVChoiceC = Slot3.In1.AudInC
!Done Slot3.In1.AFVChoiceC
Slot3.In1.AFVChoiceD = Slot3.In1.AudInD
!Done Slot3.In1.AFVChoiceD
Slot3.In1.View = MonitorViews.View2
!Done Slot3.In1.View
Description
Read only.
Get if audio is available for this input.
Read only.
Defines the audio channel input for
channel A
Defines the audio channel input for
channel B
Defines the audio channel input for
channel C
Defines the audio channel input for
channel D
Get or set the audio source channel to
use in Audio Follow Video mode
Get or set the audio source channel to
use in Audio Follow Video mode
Get or set the audio source channel to
use in Audio Follow Video mode
Get or set the audio source channel to
use in Audio Follow Video mode
This attribute will only show when there
is a Monitor Card in the system.
Get or set the view to show on the
Monitor Card.
This attribute will only show when there
is a Monitor Card in the system.
Get or set the view position for this
output on the Monitor Card.
Get or set the number of audio bars to
show on the monitorcard screen for this
input.
The range is 0 to the number of audio
channels.
Not used.
Not used.
41
Property Name
CanFramelockTo
Syntax
Slot<n>.In<n>.CanFramelockTo
Type
Example
Description
Not used.
Command
PhaseRetrain
Syntax
Slot<n>.PhaseRetrain()
Type
void
Description
Initiate a Phase retrain for this slot
Module_Resolution
s
Slot<n>.Module_Resolutions()
List
ForceLinkRefresh
Slot<n>.In<n>.ForceLinkRefresh
()
Void
Example
// Module 3 phase :::::::::::-------------------L:,
centres at 4, 5 (5).
!Done Slot3.PhaseRetrain()
Slot3.Module_Resolutions()
640x480p60;4:3;
640x480p72;4:3;
…
Empty1000;4:3;
Empty1001;4:3;
Empty1002;4:3;
Empty1003;4:3;
Empty1004;4:3;
Empty1005;4:3;
Empty1006;4:3;
Empty1007;4:3;
Empty1008;4:3;
Empty1009;4:3;
!Done Slot3.Module_Resolutions()
Slot3.In1.ForceLinkRefresh()
!Done Slot3.In1.ForceLinkRefresh()
Methods
Slots Commands
42
List all of the supported resolutions for
this slot.
Custom resolutions will appear at the
end of the list.
The list is semicolon separated.
Reset the connection to the source.
SDI Input Module
It is possible to use Slot<n>.In<n> and S<n>I<n> in place of Slots.Slot<n>.In<n>.
Properties
Property Name
Slot<n>
Syntax
Slot<n>
Type
List
Cardtype
Slot<n>.Cardtype
CardTypeEn
um
CardData
In<n>
Slot<n>.Carddata
Slot<n>.In<n>
Slots Commands
List
Example
Slot2.Cardtype = SDI_3G 2-in
Slot2.Carddata = <No Value>
Slot2.In1 = <...>
Slot2.In2 = <...>
Slot2.PhaseRetrain()
Slot2.Module_Resolutions()
!Done Slot2
Slot2.Cardtype = SDI_3G 2-in
!Done Slot2.Cardtype
Slot2.In1.FullName = In1
Slot2.In1.Status = OK
Slot2.In1.Alias = s2i1
Slot2.In1.WindowList = Window1
Slot2.In1.TypeChoice = SDI
Slot2.In1.AspectChoice = 4:3
Slot2.In1.Brightness = 0
Slot2.In1.Contrast = 100
Slot2.In1.ColourScale = Auto
Slot2.In1.TPG = Off
Slot2.In1.Set_Resolution = 1920x1080p30
Slot2.In1.Measured_Resolution =
1920x1080p30
Slot2.In1.Measured_Width = 1920
Slot2.In1.Measured_Height = 1080
Slot2.In1.Measured_Field_Rate = 30
Slot2.In1.Measured_VTotal = 1125
Slot2.In1.Measured_Frame_ip = p
Slot2.In1.LeftCrop = 0
Slot2.In1.RightCrop = 0
Slot2.In1.TopCrop = 0
43
Description
List the properties of the card in this slot
or “NO CARD” if the slot is empty.
Read-only.
Get the type of the card in this slot
Not used.
List the properties for an Input on the
given Slot.
Where <n> is the number of the input
on the card.
Property Name
Syntax
Type
FullName
Slot<n>.In<n>.FullName
String
Status
Slot<n>.In<n>.Status
StatusEnum
Alias
Slot<n>.In<n>.Alias
String
WindowList
Slot<n>.In<n>.WindowList
String
TypeChoice
Slot<n>.In<n>.TypeChoice
TypeChoice
AspectChoice
Slot<n>.In<n>.AspectChoice
AspectRatio
Brightness
Slot<n>.In<n>.Brightness
Integer
Slots Commands
Example
Slot2.In1.BottomCrop = 0
Slot2.In1.OnSrcLossColour = Blue
Slot2.In1.HDMI = Not_Found
Slot2.In1.Audio = Off
Slot2.In1.AudInA = NULL
Slot2.In1.AudInB = NULL
Slot2.In1.AudInC = NULL
Slot2.In1.AudInD = NULL
Slot2.In1.AFVChoiceA = Slot2.In1.AudInA
Slot2.In1.AFVChoiceB = Slot2.In1.AudInB
Slot2.In1.AFVChoiceC = Slot2.In1.AudInC
Slot2.In1.AFVChoiceD = Slot2.In1.AudInD
Slot2.In1.AudioBars = 4
Slot2.In1.PreviewVideoType = 0
Slot2.In1.Equipment =
Slot2.In1.CanFramelockTo = Yes
!Done Slot2.In1
Slot2.In1.FullName = In1
!Done Slot2.In1.FullName
Slot2.In1.Status = OK
!Done Slot2.In1.Status
Slot2.In1.Alias = s2i1
!Done Slot2.In1.Alias
Slot2.In1.WindowList = Window1
!Done Slot2.In1.WindowList
Slot2.In1.TypeChoice = SDI
!Done Slot2.In1.TypeChoice
Slot2.In1.AspectChoice = 4:3
!Done Slot2.In1.AspectChoice
Slot2.In1.Brightness = 0
!Done Slot2.In1.Brightness
44
Description
Read-only.
Get the full name of the Window
Read-only.
Get the status of the input.
Get or set the Alias name for this input.
Read only.
Get the window that the slot is routed
to.
Read only.
Selects the type of input.
Get or set the aspect ratio for this input
Get or set the brightness adjustment for
this input.
Valid range is from -30 to 30
Property Name
Contrast
Syntax
Slot<n>.In<n>.Contrast
Type
Percentage
Example
Slot2.In1.Contrast = 100
!Done Slot2.In1.Contrast
ColourScale
Slot<n>.In<n>.ColourScale
ColourScale
TPG
Slot<n>.In<n>.TPG
Boolean
Slot2.In1.ColourScale = Auto
!Done Slot2.In1.ColourScale
Slot2.In1.TPG = Off
!Done Slot2.In1.TPG
Set_Resolution
Slot<n>.In<n>.Set_Resolution
Resolution
Slot2.In1.Set_Resolution = 1920x1080p30
!Done Slot2.In1.Set_Resolution
Measured_Resoluti
on
Slot<n>.In<n>.Measured_Resol
ution
Resolution
Measured_Width
Slot<n>.In<n>.Measured_Width
Integer
Slot2.In1.Measured_Resolution =
1920x1080p30
!Done Slot2.In1.Measured_Resolution
Slot2.In1.Measured_Width = 1920
!Done Slot2.In1.Measured_Width
Measured_Height
Slot<n>.In<n>.Measured_Heigh
t
Integer
Slot2.In1.Measured_Height = 1080
!Done Slot2.In1.Measured_Height
Measured_Field_Ra
te
Slot<n>.In<n>.Measured_Field_
Rate
Integer
Slot2.In1.Measured_Field_Rate = 30
!Done Slot2.In1.Measured_Field_Rate
Measured_VTotal
Slot<n>.In<n>.Measured_VTota
l
Integer
Slot2.In1.Measured_VTotal = 1125
!Done Slot2.In1.Measured_VTotal
Measure_Frame_ip
Slot<n>.In<n>.Measure_Frame_
ip
FrameType
Slot2.In1.Measured_Frame_ip = p
!Done Slot2.In1.Measured_Frame_ip
LeftCrop
Slot<n>.In<n>.LeftCrop
Integer
RightCrop
Slot<n>.In<n>.RightCrop
Integer
Slot2.In1.LeftCrop = 0
!Done Slot2.In1.LeftCrop
Slot2.In1.RightCrop = 0
!Done Slot2.In1.RightCrop
Slots Commands
45
Description
Get or set the contrast adjustment for
the Input.
Valid range is from 30% to 130%
Get or set the colour scale for this input.
Get or set to use the internal Test
Pattern Generator (TPG1) for this input.
Options are “Off” or “TPG1”.
Read-only.
Get the current resolution set for this
input.
Read-only.
Get the resolution being read from this
Input.
Read-only.
Get the width of the resolution being
read from this input.
Read-only.
Get the measured height of the
resolution being read from this input.
Read-only.
Get the measured field rate of the
resolution being read from this input.
Read-only.
Get the measured total vertical lines of
the resolution being read from this
input.
Read-only.
Get the measured frame type of the
resolution being read from this input.
Get or set the amount of left crop to be
applied to this input.
Get or set the amount of right crop to be
applied to this input.
Property Name
TopCrop
Syntax
Slot<n>.In<n>.TopCrop
Type
Integer
BottomCrop
Slot<n>.In<n>.BottomCrop
Integer
HDMI
Slot<n>.In<n>.HDMI
FoundNot
Audio
Slot<n>.In<n>.Audio
FoundOff
AudInA
Slot<n>.In<n>.AudInA
String
AudInB
Slot<n>.In<n>.AudInB
String
AudInC
Slot<n>.In<n>.AudInC
String
AudInD
Slot<n>.In<n>.AudInD
String
AFVChoiceA
Slot<n>.In<n>.AFVChoiceA
AudioInput
AFVChoiceB
Slot<n>.In<n>.AFVChoiceB
AudioInput
AFVChoiceC
Slot<n>.In<n>.AFVChoiceC
AudioInput
AFVChoiceD
Slot<n>.In<n>.AFVChoiceD
AudioInput
AudioBars
Slot<n>.In<n>.AudioBars
Integer
PreviewVideoType
Slot<n>.In<n>.PreviewVideoTyp
e
Slot<n>.In<n>.Equipment
Slot<n>.In<n>.CanFramelockTo
Equipment
CanFramelockTo
Slots Commands
Example
Slot2.In1.TopCrop = 0
!Done Slot2.In1.TopCrop
Slot2.In1.BottomCrop = 0
!Done Slot2.In1.BottomCrop
Slot2.In1.HDMI = Not_Found
!Done Slot2.In1.HDMI
Slot2.In1.Audio = Off
!Done Slot2.In1.Audio
Slot2.In1.AudInA = NULL
!Done Slot2.In1.AudInA
Slot2.In1.AudInB = NULL
!Done Slot2.In1.AudInB
Slot2.In1.AudInC = NULL
!Done Slot2.In1.AudInC
Slot2.In1.AudInD = NULL
!Done Slot2.In1.AudInD
Slot2.In1.AFVChoiceA = Slot2.In1.AudInA
!Done Slot2.In1.AFVChoiceA
Slot2.In1.AFVChoiceB = Slot2.In1.AudInB
!Done Slot2.In1.AFVChoiceB
Slot2.In1.AFVChoiceC = Slot2.In1.AudInC
!Done Slot2.In1.AFVChoiceC
Slot2.In1.AFVChoiceD = Slot2.In1.AudInD
!Done Slot2.In1.AFVChoiceD
Slot2.In1.AudioBars = 4
!Done Slot2.In1.AudioBars
Description
Get or set the amount of top crop to be
applied to this input.
Get or set the amount of bottom crop to
be applied to this input.
Read-only.
Get the detected HDMI status.
Read only.
Get if audio is available for this input.
Read only.
Defines the audio channel input for
channel A
Defines the audio channel input for
channel B
Defines the audio channel input for
channel C
Defines the audio channel input for
channel D
Get or set the audio source channel to
use in Audio Follow Video mode
Get or set the audio source channel to
use in Audio Follow Video mode
Get or set the audio source channel to
use in Audio Follow Video mode
Get or set the audio source channel to
use in Audio Follow Video mode
Get or set the number of audio bars to
show on the monitorcard screen for this
input.
The range is 0 to the number of audio
channels.
Not used.
Not used.
Not used.
46
Methods
Command
PhaseRetrain
Syntax
Slot<n>.PhaseRetrain()
Type
void
Module_Resolution
s
Slot<n>.Module_Resolutions()
List
Slots Commands
Example
// Module 2 phase ---------L:::::::::::-----------,
centres at 15, 15 (15).
!Done Slot2.PhaseRetrain()
720x487i59.94;4:3;
720x576i50;4:3;
1280x720p23.98;16:9;
1280x720p24;16:9;
1280x720p25;16:9;
1280x720p29.97;16:9;
1280x720p30;16:9;
1280x720p50;16:9;
1280x720p59.94;16:9;
1280x720p60;16:9;
1920x1080i50;16:9;
1920x1080i59.94;16:9;
1920x1080i60;16:9;
1920x1080p23.98;16:9;
1920x1080p24;16:9;
1920x1080p25;16:9;
1920x1080p29.97;16:9;
1920x1080p30;16:9;
1920x1080p50;16:9;
1920x1080p59.94;16:9;
1920x1080p60;16:9;
!Done Slot2.Module_Resolutions()
47
Description
Initiate a Phase retrain for this slot
List all of the supported resolutions for
this slot.
The list is semicolon separated.
Note that custom resolutions may not
be used and will not appear.
DVI Output Module
It is possible to use Slot<n>.Out<n> and S<n>O<n> in place of Slots.Slot<n>.Out<n>.
Properties
Property Name
Slot<n>
Syntax
Slot<n>
Type
List
Cardtype
Slot<n>.Cardtype
CardTypeEn
um
CardData
Out<n>
Slot<n>.Carddata
Slot<n>.Out<n>
Slots Commands
List
Example
Slot14.Cardtype = DVI_U 2-out
Slot14.Carddata = <No Value>
Slot14.Out1 = <...>
Slot14.Out2 = <...>
Slot14.PhaseRetrain()
Slot14.Module_Resolutions()
Slot14.Resolutions = <...>
!Done Slot14
Slot14.Cardtype = DVI_U 2-out
!Done Slot14.Cardtype
Slot14.Out1.FullName = Out1
Slot14.Out1.Status = UNKNOWN
Slot14.Out1.Alias = s14o1
Slot14.Out1.AspectChoice = 4:3
Slot14.Out1.DisplayType = Monitor
Slot14.Out1.Resolution = 1280x720p60
Slot14.Out1.DefaultLoRes = 720x576i50
Slot14.Out1.Width = 1280
Slot14.Out1.Height = 720
Slot14.Out1.Field_Rate = 60.00
Slot14.Out1.Frame_ip = p
Slot14.Out1.AnalogType = RGBHV
Slot14.Out1.ColourScale = Auto
Slot14.Out1.GenlockSource = NULL
Slot14.Out1.Genlock = Off
Slot14.Out1.RawMatrixSwitch = Off
Slot14.Out1.Audio = Off
Slot14.Out1.AudOutA = NULL
Slot14.Out1.AudOutB = NULL
Slot14.Out1.AudOutC = NULL
48
Description
List the properties of the card in this slot
or “NO CARD” if the slot is empty.
Read-only.
Get the type of the card in this slot
Not used.
List the properties for an Output on the
given Slot.
Where Out<n> is the output on the card.
Property Name
Slots Commands
Syntax
Type
Example
Slot14.Out1.AudOutD = NULL
Slot14.Out1.ForceLinkRefresh()
Slot14.Out1.HDCP_Active = Off
Slot14.Out1.HDCP_Downstream = HoldOn
Slot14.Out1.HDMI = Not_Found
Slot14.Out1.Layout = Layout3
Slot14.Out1.WidthInLayout = 1024
Slot14.Out1.HeightInLayout = 768
Slot14.Out1.LayoutXCentre = 0
Slot14.Out1.LayoutYCentre = 0
Slot14.Out1.RotateOutDeg = 0
Slot14.Out1.HFlip = Off
Slot14.Out1.VFlip = Off
Slot14.Out1.GammaRed = 1
Slot14.Out1.GammaGreen = 1
Slot14.Out1.GammaBlue = 1
Slot14.Out1.SCurve = 1
Slot14.Out1.EdgeBlend_Mode = Off
Slot14.Out1.OuterGrid = Off
Slot14.Out1.InnerGrid = Off
Slot14.Out1.LeftOverlap = 80
Slot14.Out1.RightOverlap = 80
Slot14.Out1.TopOverlap = 80
Slot14.Out1.BottomOverlap = 80
Slot14.Out1.LeftEBPos = -511
Slot14.Out1.RightEBPos = 511
Slot14.Out1.TopEBPos = -383
Slot14.Out1.BottomEBPos = 383
Slot14.Out1.Centre_BB = 0
Slot14.Out1.Left_BB = 0
Slot14.Out1.Right_BB = 0
Slot14.Out1.Top_BB = 0
Slot14.Out1.Bottom_BB = 0
Slot14.Out1.ProjectorWidthDeg = 30
Slot14.Out1.ProjectorHeightDeg = 30
49
Description
Property Name
Syntax
Type
FullName
Slot<n>.Out<n>.FullName
String
Status
Slot<n>.Out<n>.Status
StatusEnum
Alias
Slot<n>.Out<n>.Alias
String
AspectChoice
Slot<n>.Out<n>.AspectChoice
AspectRatio
DisplayType
Slot<n>.Out<n>.DisplayType
DisplayType
Slots Commands
Example
Slot14.Out1.KeystoneXDeg = 0
Slot14.Out1.KeystoneYDeg = 0
Slot14.Out1.WarpTable_Filename =
Slot14.Out1.WarpTable = 0
Slot14.Out1.EDID_Filename =
Slot14.Out1.View = MonitorViews.View4
Slot14.Out1.ViewPosCode = 17
Slot14.Out1.AudioBars = 4
Slot14.Out1.Equipment =
Slot14.Out1.PhysicalCenterX = 0
Slot14.Out1.PhysicalCenterY = 0
Slot14.Out1.PhysicalWidth = 0
Slot14.Out1.PhysicalHeight = 0
Slot14.Out1.PhysicalPixelWidth = 0
Slot14.Out1.PhysicalPixelHeight = 0
Slot14.Out1.PhysicalBezelTop = 0
Slot14.Out1.PhysicalBezelBottom = 0
Slot14.Out1.PhysicalBezelLeft = 0
Slot14.Out1.PhysicalBezelRight = 0
Slot14.Out1.InsList = Slot3.In1
Slot14.Out1.CutToBlack = Off
!Done Slot14.Out1
Slot14.Out2.FullName = Out2
!Done Slot14.Out2.FullName
Slot14.Out2.Status = UNKNOWN
!Done Slot14.Out2.Status
Slot14.Out2.Alias = s14o2
!Done Slot14.Out2.Alias
Slot14.Out2.AspectChoice = 4:3
!Done Slot14.Out2.AspectChoice = 4:3
Slot14.Out2.DisplayType = Monitor
!Done Slot14.Out2.DisplayType
50
Description
Read-only.
Get the full name of the Window.
Read-only.
Get the status of the output.
Get or set the Alias name for this output.
Get or set the aspect ratio for this
output.
Get or set the type of display connected
to this output.
Property Name
Resolution
Syntax
Slot<n>.Out<n>.Resolution
Type
Resolution
Example
Slot14.Out2.Resolution = 1280x720p60
!Done Slot14.Out2.Resolution
DefaultLoRes
Slot<n>.Out<n>.DefaultLoRes
Resolution
Slot14.Out2.Resolution = 1280x720p60
!Done Slot14.Out2.Resolution
Width
Slot<n>.Out<n>.Width
Integer
Slot14.Out2.Width = 1280
!Done Slot14.Out2.Width
Height
Slot<n>.Out<n>.Height
Integer
Slot14.Out2.Height
Slot14.Out2.Height = 720
Field_Rate
Slot<n>.Out<n>.Field_Rate
String
Slot14.Out2.Field_Rate
Slot14.Out2.Field_Rate = 60.00
Frame_ip
Slot<n>.Out<n>.Frame_ip
FrameType
Slot14.Out2.Frame_ip = p
!Done Slot14.Out2.Frame_ip
AnalogType
Slot<n>.Out<n>.AnalogType
AnalogType
ColourScale
Slot<n>.Out<n>.ColourScale
ColourScale
GenlockSource
Slot<n>.Out<n>.GenlockSource
Input
Slot14.Out2.AnalogType = RGBHV
!Done Slot14.Out2.AnalogType
Slot14.Out2.ColourScale = Auto
!Done Slot14.Out2.ColourScale
Slot14.Out2.GenlockSource = NULL
!Done Slot14.Out2.GenlockSource
Genlock
Slot<n>.Out<n>.Genlock
GenlockStat
us
Slots Commands
Slot14.Out2.Genlock = Off
!Done Slot14.Out2.Genlock
51
Description
Get or set the resolution to use on this
output.
This must be the name of a valid
resolution. See Resources Resolutions
on page 33 above.
Get or set the resolution to use on this
output when HDCP is requested by the
source but the display failed HDCP
negotiation.
This must be the name of a valid
resolution. See Resources Resolutions
on page 33 above.
Read-only.
Get the width of this output based on
the select resolution.
Read-only.
Get the height of this output based on
the select resolution.
Read-only.
Get the field rate for this output based
on the select resolution.
Read-only.
Get the frame type for this output based
on the select resolution.
Get or set the type of analog signal to
use on this output.
Get or set the color scale to use on this
output..
Get or set the Input to be used as the
genlock source for the Output.
If no Genlock is to be use then the value
is to be NULL.
Read-only.
Get the status of genlock for this output.
Property Name
RawMatrixSwitch
Syntax
Slot<n>.Out<n>.RawMatrixSwit
ch
Type
Boolean
Example
Slot14.Out2.RawMatrixSwitch = Off
!Done Slot14.Out2.RawMatrixSwitch
Audio
Slot<n>.Out<n>.Audio
FoundOff
AudOutA
Slot<n>.Out<n>.AudOutA
String
Slot14.Out2.Audio = Off
!Done Slot14.Out2.Audio
Slot14.Out2.AudOutA = NULL
!Done Slot14.Out2.AudOutA
AudOutB
Slot<n>.Out<n>.AudOutB
String
AudOutC
Slot<n>.Out<n>.AudOutC
String
AudOutD
Slot<n>.Out<n>.AudOutD
String
HDCP_Active
Slot<n>.Out<n>.HDCP_Active
Boolean
HDCP_Downstream
HDMI
Slot<n>.Out<n>.HDCP_Downstr
eam
Slot<n>.Out<n>.HDMI
HDCPDowns
tream
FoundNot
Layout
WidthInLayout
HeightInLayout
LayoutXCentre
LayoutYCentre
RotateOutDeg
HFlip
VFlip
GammaRed
Slot<n>.Out<n>.Layout
Slot<n>.Out<n>.WidthInLayout
Slot<n>.Out<n>.HeightInLayout
Slot<n>.Out<n>.LayoutXCentre
Slot<n>.Out<n>.LayoutYCentre
Slot<n>.Out<n>.RotateOutDeg
Slot<n>.Out<n>.HFlip
Slot<n>.Out<n>.VFlip
Slot<n>.Out<n>.GammaRed
Number
Slot14.Out1.GammaRed = 1
!Done Slot14.Out1.GammaRed
GammaGreen
Slot<n>.Out<n>.GammaGreen
Number
Slot14.Out1.GammaGreen = 1
!Done Slot14.Out1.GammaGreen
Slots Commands
Slot14.Out2.AudOutB = NULL
!Done Slot14.Out2.AudOutB
Slot14.Out2.AudOutC = NULL
!Done Slot14.Out2.AudOutC
Slot14.Out2.AudOutD = NULL
!Done Slot14.Out2.AudOutD
Slot14.Out2.HDCP_Active = Active
!Done Slot14.Out2.HDCP_Active
Slot14.Out2.HDCP_Downstream = HoldOn
!Done Slot14.Out2.HDCP_Downstream
Slot14.Out2.HDMI = Found
!Done Slot14.Out2.HDMI
52
Description
Get or set the input switching mode:
Off = fade though black
On = freeze and cut
Read only.
Get if audio is available for this input.
Read only.
Defines the audio channel output for
channel A
Defines the audio channel output for
channel B
Defines the audio channel output for
channel C
Defines the audio channel output for
channel D
Read only.
Get the HDCP status of this output.
Get or set the downstream HDCP mode.
Read-only.
Get the detected HDMI status.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Get or set the red gamma value for this
output
Range: 0.30 to 2.00
Get or set the green gamma value for
this output
Range: 0.30 to 2.00
Property Name
GammaBlue
Syntax
Slot<n>.Out<n>.GammaBlue
Type
Number
Example
Slot14.Out1.GammaBlue = 1
!Done Slot14.Out1.GammaBlue
SCurve
Slot<n>.Out<n>.SCurve
Number
Slot14.Out1.SCurve = 1
!Done Slot14.Out1.SCurve
EdgeBlend_Mode
Slot<n>.Out<n>.EdgeBlend_Mo
de
Slot<n>.Out<n>.OuterGrid
Slot<n>.Out<n>.InnerGrid
Slot<n>.Out<n>.LeftOverlap
Slot<n>.Out<n>.RightOverlap
Slot<n>.Out<n>.TopOverlap
Slot<n>.Out<n>.BottomOverlap
Slot<n>.Out<n>.LeftEBPos
Slot<n>.Out<n>.RightEBPos
Slot<n>.Out<n>.TopEBPos
Slot<n>.Out<n>.BottomEBPos
Slot<n>.Out<n>.Centre_BB
Slot<n>.Out<n>.Left_BB
Slot<n>.Out<n>.Right_BB
Slot<n>.Out<n>.Top_BB
Slot<n>.Out<n>.Bottom_BB
Slot<n>.Out<n>.ProjectorWidth
Deg
Slot<n>.Out<n>.ProjectorHeight
Deg
Slot<n>.Out<n>.KeystoneXDeg
Slot<n>.Out<n>.KeystoneYDeg
Slot<n>.Out<n>.WarpTable_File
name
Slot<n>.Out<n>.WarpTable
Slot<n>.Out<n>.EDID_Filename
OuterGrid
InnerGrid
LeftOverlap
RightOverlap
TopOverlap
BottomOverlap
LeftEBPos
RightEBPos
TopEBPos
BottomEBPos
Centre_BB
Left_BB
Right_BB
Top_BB
Bottom_BB
ProjectorWidthDeg
ProjectorHeightDeg
KeystoneXDeg
KeystoneYDeg
WarpTable_Filena
me
WarpTable
EDID_Filename
Slots Commands
Description
Get or set the blue gamma value for this
output
Range: 0.30 to 2.00
Get or set the SCurve value for this
output. (brightness curve)
Range: 0.30 to 2.00
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
String
Slot14.Out1.EDID_Filename =
!Done Slot14.Out1.EDID_Filename
53
Not used.
Get or set the EDID file in any currently
being used for this output.
Property Name
View
Syntax
Slot<n>.Out<n>.View
Type
String
Example
Slot14.Out1.View = MonitorViews.View4
!Done Slot14.Out1.View = MonitorViews.View4
ViewPosCode
Slot<n>.Out<n>.ViewPosCode
Integer
Slot14.Out1.ViewPosCode = 17
!Done Slot14.Out1.ViewPosCode
AudioBars
Slot<n>.Out<n>.AudioBars
Integer
Slot14.Out1.AudioBars = 4
!Done Slot14.Out1.AudioBars
Equipment
PhysicalCenterX
Slot<n>.Out<n>.Equipment
Slot<n>.Out<n>.PhysicalCenter
X
Slot<n>.Out<n>.PhysicalCenterY
Slot<n>.Out<n>.PhysicalWidth
Slot<n>.Out<n>.PhysicalHeight
Slot<n>.Out<n>.PhysicalPixelWi
dth
Slot<n>.Out<n>.PhysicalPixelHe
ight
Slot<n>.Out<n>.PhysicalBezelTo
p
Slot<n>.Out<n>.PhysicalBezelBo
ttom
Slot<n>.Out<n>.PhysicalBezelLe
ft
Slot<n>.Out<n>.PhysicalBezelRi
ght
Slot<n>.Out<n>.InsList
PhysicalCenterY
PhysicalWidth
PhysicalHeight
PhysicalPixelWidth
PhysicalPixelHeight
PhysicalBezelTop
PhysicalBezelBotto
m
PhysicalBezelLeft
PhysicalBezelRight
InsList
Slots Commands
Description
Get or set the view to show on the
Monitor Card.
This attribute will only show when there
is a Monitor Card in the system.
Get or set the view position for this
output on the Monitor Card.
This attribute will only show when there
is a Monitor Card in the system.
Get or set the number of audio bars to
show for this output on the Monitor
Card.
The range is 0 to the number of audio
channels.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
List
Slot14.Out1.InsList = NULL
!Done Slot14.Out1.InsList
54
Read only.
Get or set the list of inputs routed to this
output.
Property Name
CutToBlack
Syntax
Slot<n>.Out<n>.CutToBlack
Type
Boolean
Example
Slot14.Out1.CutToBlack = Off
!Done Slot14.Out1.CutToBlack
Resolutions
Slot<n>
List
Resolution<n>
Slot<n>.Resolutions.Resolution
<n>
List
Name
Slot<n>.Resolutions.Resolution
<n>.Name
String
Aspect
Slot<n>.Resolutions.Resolution
<n>.Aspect
AspectRatio
Slot14.Resolutions.Resolution1 = <...>
Slot14.Resolutions.Resolution2 = <...>
…
Slot14.Resolutions.Resolution1000 = <...>
Slot14.Resolutions.Resolution1001 = <...>
Slot14.Resolutions.Resolution1002 = <...>
Slot14.Resolutions.Resolution1003 = <...>
Slot14.Resolutions.Resolution1004 = <...>
Slot14.Resolutions.Resolution1005 = <...>
Slot14.Resolutions.Resolution1006 = <...>
Slot14.Resolutions.Resolution1007 = <...>
Slot14.Resolutions.Resolution1008 = <...>
Slot14.Resolutions.Resolution1009 = <...>
!Done Slot14.Resolutions
Slot14.Resolutions.Resolution1.Name =
640x480p60
Slot14.Resolutions.Resolution1.Aspect = 4:3
Slot14.Resolutions.Resolution1.CanFramelock =
No
!Done Slot14.Resolutions.Resolution1
Slot14.Resolutions.Resolution1.Name =
640x480p60
!Done Slot14.Resolutions.Resolution1.Name
Slot14.Resolutions.Resolution1.Aspect = 4:3
!Done Slot14.Resolutions.Resolution1.Aspect
CanFramelock
Slot<n>.Resolutions.Resolution
<n>.CanFramelock
Slots Commands
55
Description
Get or set the output to black.
When setting multiple outputs to black it
is recommended to surround them with
startbatch() endbatch() to synchronise
output blanking
List the properties for a Resolution
where <n> is the number of the
Resolution.
Note that Resolution1000 to
Resolution1009 are Custom Resolutions.
List the properties of the selected
resolution.
Read only.
Get the name of this resolution.
Read only.
Get the aspect ratio of this resolution.
Used assist to in the signal conversion
when an input and the output have
different aspect ratios.
Not used.
Methods
Command
PhaseRetrain
Syntax
Slot<n>.PhaseRetrain()
Type
void
Module_Resolution
s
Slot<n>.Module_Resolutions()
List
ForceLinkRefresh
Slot<n>.Out<n>.ForceLinkRefres
h()
Void
Slots Commands
Example
// Module 14 phase :---------------------::::::::::,
centres at 27, 27 (27).
!Done Slot14.PhaseRetrain()
640x480p60;4:3;
640x480p72;4:3;
…
Empty1000;4:3;
Empty1001;4:3;
Empty1002;4:3;
Empty1003;4:3;
Empty1004;4:3;
Empty1005;4:3;
Empty1006;4:3;
Empty1007;4:3;
Empty1008;4:3;
Empty1009;4:3;
!Done Slot14.Module_Resolutions()
Slot14.Out1.ForceLinkRefresh()
!Done Slot14.Out1.ForceLinkRefresh()
56
Description
Initiate a Phase retrain for this slot
List all of the supported resolutions for
this slot.
Custom resolutions will appear at the
end of the list.
The list is semicolon separated.
Reset the connection to the display.
HDBaseT Output Module
It is possible to use Slot<n>.Out<n> and S<n>O<n> in place of Slots.Slot<n>.Out<n>.
Properties
Property Name
Slot<n>
Syntax
Slot<n>
Type
List
Cardtype
Slot<n>.Cardtype
CardTypeEn
um
CardData
Out<n>
Slot<n>.Carddata
Slot<n>.Out<n>
Slots Commands
List
Example
Slot15.Cardtype = HDBASET 2-out
Slot15.Carddata = <No Value>
Slot15.Out1 = <...>
Slot15.Out2 = <...>
Slot15.PhaseRetrain()
Slot15.Module_Resolutions()
Slot15.Resolutions = <...>
!Done Slot15
Slot15.Cardtype = HDBASET 2-out
!Done Slot15.Cardtype
Slot15.Out1.FullName = Out1
Slot15.Out1.Status = UNKNOWN
Slot15.Out1.Alias = s15o1
Slot15.Out1.AspectChoice = 4:3
Slot15.Out1.DisplayType = Monitor
Slot15.Out1.Resolution = 1280x720p60
Slot15.Out1.DefaultLoRes = 720x576i50
Slot15.Out1.Width = 1280
Slot15.Out1.Height = 720
Slot15.Out1.Field_Rate = 60.00
Slot15.Out1.Frame_ip = p
Slot15.Out1.AnalogType = RGBHV
Slot15.Out1.ColourScale = Auto
Slot15.Out1.GenlockSource = NULL
Slot15.Out1.Genlock = Off
Slot15.Out1.RawMatrixSwitch = Off
Slot15.Out1.Audio = Off
Slot15.Out1.AudOutA = NULL
Slot15.Out1.AudOutB = NULL
Slot15.Out1.AudOutC = NULL
57
Description
List the properties of the card in this slot
or “NO CARD” if the slot is empty.
Read-only.
Get the type of the card in this slot
Not used.
List the properties for an Output on the
given Slot.
Where Out<n> is the output on the card.
Property Name
Slots Commands
Syntax
Type
Example
Slot15.Out1.AudOutD = NULL
Slot15.Out1.ForceLinkRefresh()
Slot15.Out1.HDCP_Active = Active
Slot15.Out1.HDCP_Downstream = HoldOn
Slot15.Out1.HDMI = Found
Slot15.Out1.Layout = Layout4
Slot15.Out1.WidthInLayout = 1024
Slot15.Out1.HeightInLayout = 768
Slot15.Out1.LayoutXCentre = 0
Slot15.Out1.LayoutYCentre = 0
Slot15.Out1.RotateOutDeg = 0
Slot15.Out1.HFlip = Off
Slot15.Out1.VFlip = Off
Slot15.Out1.GammaRed = 1
Slot15.Out1.GammaGreen = 1
Slot15.Out1.GammaBlue = 1
Slot15.Out1.SCurve = 1
Slot15.Out1.EdgeBlend_Mode = Off
Slot15.Out1.OuterGrid = Off
Slot15.Out1.InnerGrid = Off
Slot15.Out1.LeftOverlap = 80
Slot15.Out1.RightOverlap = 80
Slot15.Out1.TopOverlap = 80
Slot15.Out1.BottomOverlap = 80
Slot15.Out1.LeftEBPos = -511
Slot15.Out1.RightEBPos = 511
Slot15.Out1.TopEBPos = -383
Slot15.Out1.BottomEBPos = 383
Slot15.Out1.Centre_BB = 0
Slot15.Out1.Left_BB = 0
Slot15.Out1.Right_BB = 0
Slot15.Out1.Top_BB = 0
Slot15.Out1.Bottom_BB = 0
Slot15.Out1.ProjectorWidthDeg = 30
Slot15.Out1.ProjectorHeightDeg = 30
58
Description
Property Name
Syntax
Type
FullName
Slot<n>.Out<n>.FullName
String
Status
Slot<n>.Out<n>.Status
StatusEnum
Alias
Slot<n>.Out<n>.Alias
String
AspectChoice
Slot<n>.Out<n>.AspectChoice
AspectRatio
DisplayType
Slot<n>.Out<n>.DisplayType
DisplayType
Slots Commands
Example
Slot15.Out1.KeystoneXDeg = 0
Slot15.Out1.KeystoneYDeg = 0
Slot15.Out1.WarpTable_Filename =
Slot15.Out1.WarpTable = 0
Slot15.Out1.EDID_Filename =
Slot15.Out1.View = MonitorViews.View3
Slot15.Out1.ViewPosCode = 18
Slot15.Out1.AudioBars = 4
Slot15.Out1.Equipment =
Slot15.Out1.PhysicalCenterX = 0
Slot15.Out1.PhysicalCenterY = 0
Slot15.Out1.PhysicalWidth = 0
Slot15.Out1.PhysicalHeight = 0
Slot15.Out1.PhysicalPixelWidth = 0
Slot15.Out1.PhysicalPixelHeight = 0
Slot15.Out1.PhysicalBezelTop = 0
Slot15.Out1.PhysicalBezelBottom = 0
Slot15.Out1.PhysicalBezelLeft = 0
Slot15.Out1.PhysicalBezelRight = 0
Slot15.Out1.InsList = Slot3.In1
Slot15.Out1.CutToBlack = Off
Slot15.Out1.HDBaseT = <...>
!Done Slot15.Out1
Slot15.Out1.FullName = Out1
!Done Slot15.Out1.FullName
Slot15.Out1.Status = UNKNOWN
!Done Slot15.Out1.Status
Slot15.Out1.Alias = s15o1
!Done Slot15.Out1.Alias
Slot15.Out1.AspectChoice = 4:3
!Done Slot15.Out1.AspectChoice
Slot15.Out1.DisplayType = Monitor
!Done Slot15.Out1.DisplayType
59
Description
Read-only.
Get the full name of the Window
Read-only.
Get the status of the output
Get or set the Alias name for this output.
Get or set the aspect ratio for this
output.
Get or set the type of display connected
to this output.
Property Name
Resolution
Syntax
Slot<n>.Out<n>.Resolution
Type
Resolution
Example
Slot15.Out1.Resolution = 1280x720p60
!Done Slot15.Out1.Resolution
DefaultLoRes
Slot<n>.Out<n>.DefaultLoRes
Resolution
Slot15.Out1.DefaultLoRes = 720x576i50
!Done Slot15.Out1.DefaultLoRes
Width
Slot<n>.Out<n>.Width
Integer
Slot15.Out1.Width = 1280
!Done Slot15.Out1.Width
Height
Slot<n>.Out<n>.Height
Integer
Slot15.Out1.Height = 720
!Done Slot15.Out1.Height
Field_Rate
Slot<n>.Out<n>.Field_Rate
String
Slot15.Out1.Field_Rate = 60.00
!Done Slot15.Out1.Field_Rate
Frame_ip
Slot<n>.Out<n>.Frame_ip
FrameType
Slot15.Out1.Frame_ip = p
!Done Slot15.Out1.Frame_ip
AnalogType
Slot<n>.Out<n>.AnalogType
AnalogType
ColourScale
Slot<n>.Out<n>.ColourScale
ColourScale
GenlockSource
Slot<n>.Out<n>.GenlockSource
Input
Slot15.Out1.AnalogType = RGBHV
!Done Slot15.Out1.AnalogType
Slot15.Out1.ColourScale = Auto
!Done Slot15.Out1.ColourScale
Slot15.Out1.GenlockSource = NULL
!Done Slot15.Out1.GenlockSource
Genlock
Slot<n>.Out<n>.Genlock
GenlockStat
us
Slots Commands
Slot15.Out1.Genlock = Off
!Done Slot15.Out1.Genlock
60
Description
Get or set the resolution to use on this
output.
This must be the name of a valid
resolution. See Resources Resolutions
on page 33 above.
Get or set the resolution to use on this
output when HDCP is requested by the
source but the display failed HDCP
negotiation.
This must be the name of a valid
resolution. See Resources Resolutions
on page 33 above.
Read-only.
Get the width of this output based on
the select resolution.
Read-only.
Get the height of this output based on
the select resolution.
Read-only.
Get the field rate for this output based
on the select resolution.
Read-only.
Get the frame type for this output based
on the select resolution.
Get or set the type of analog signal to
use on this output.
Get or set the color scale to use on this
output..
Get or set the Input to be used as the
genlock source for the Output.
If no Genlock is to be use then the value
is to be NULL.
Read-only.
Get the status of genlock for this output.
Property Name
RawMatrixSwitch
Syntax
Slot<n>.Out<n>.RawMatrixSwit
ch
Type
Boolean
Example
Slot15.Out1.RawMatrixSwitch = Off
!Done Slot15.Out1.RawMatrixSwitch
Audio
Slot<n>.Out<n>.Audio
FoundOff
Slot15.Out1.Audio = Off
!Done Slot15.Out1.Audio
AudOutA
Slot<n>.Out<n>.AudOutA
String
Slot15.Out1.AudOutA = NULL
!Done Slot15.Out1.AudOutA
AudOutB
Slot<n>.Out<n>.AudOutB
String
AudOutC
Slot<n>.Out<n>.AudOutC
String
AudOutD
Slot<n>.Out<n>.AudOutD
String
HDCP_Active
Slot<n>.Out<n>.HDCP_Active
Boolean
HDCP_Downstream
HDMI
Slot<n>.Out<n>.HDCP_Downstr
eam
Slot<n>.Out<n>.HDMI
HDCPDowns
tream
FoundNot
Slot15.Out1.AudOutB = NULL
!Done Slot15.Out1.AudOutB
Slot15.Out1.AudOutC = NULL
!Done Slot15.Out1.AudOutC
Slot15.Out1.AudOutD = NULL
!Done Slot15.Out1.AudOutD
Slot15.Out1.HDCP_Active = Off
!Done Slot15.Out1.HDCP_Active
Slot15.Out1.HDCP_Downstream = HoldOn
!Done Slot15.Out1.HDCP_Downstream
Slot15.Out1.HDMI = Found
!Done Slot15.Out1.HDMI
Layout
WidthInLayout
HeightInLayout
LayoutXCentre
LayoutYCentre
RotateOutDeg
HFlip
VFlip
GammaRed
Slot<n>.Out<n>.Layout
Slot<n>.Out<n>.WidthInLayout
Slot<n>.Out<n>.HeightInLayout
Slot<n>.Out<n>.LayoutXCentre
Slot<n>.Out<n>.LayoutYCentre
Slot<n>.Out<n>.RotateOutDeg
Slot<n>.Out<n>.HFlip
Slot<n>.Out<n>.VFlip
Slot<n>.Out<n>.GammaRed
Number
Slot15.Out1.GammaRed = 1
!Done Slot15.Out1.GammaRed
GammaGreen
Slot<n>.Out<n>.GammaGreen
Number
Slot15.Out1.GammaGreen = 1
!Done Slot15.Out1.GammaGreen
Slots Commands
61
Description
Get or set the input switching mode:
Off = fade though black
On = freeze and cut
Read only.
Get if there is audio available for this
input.
Read only.
Defines the audio channel output for
channel A
Defines the audio channel output for
channel B
Defines the audio channel output for
channel C
Defines the audio channel output for
channel D
Read only.
Get the HDCP status of this output.
Get or set the downstream HDCP mode.
Read-only.
Get the detected HDMI status.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Get or set the red gamma value for this
output
Range: 0.30 to 2.00
Get or set the green gamma value for
this output
Range: 0.30 to 2.00
Property Name
GammaBlue
Syntax
Slot<n>.Out<n>.GammaBlue
Type
Number
Example
Slot15.Out1.GammaBlue = 1
!Done Slot15.Out1.GammaBlue
SCurve
Slot<n>.Out<n>.SCurve
Number
Slot15.Out1.SCurve = 1
!Done Slot15.Out1.SCurve
EdgeBlend_Mode
Slot<n>.Out<n>.EdgeBlend_Mo
de
Slot<n>.Out<n>.OuterGrid
Slot<n>.Out<n>.InnerGrid
Slot<n>.Out<n>.LeftOverlap
Slot<n>.Out<n>.RightOverlap
Slot<n>.Out<n>.TopOverlap
Slot<n>.Out<n>.BottomOverlap
Slot<n>.Out<n>.LeftEBPos
Slot<n>.Out<n>.RightEBPos
Slot<n>.Out<n>.TopEBPos
Slot<n>.Out<n>.BottomEBPos
Slot<n>.Out<n>.Centre_BB
Slot<n>.Out<n>.Left_BB
Slot<n>.Out<n>.Right_BB
Slot<n>.Out<n>.Top_BB
Slot<n>.Out<n>.Bottom_BB
Slot<n>.Out<n>.ProjectorWidth
Deg
Slot<n>.Out<n>.ProjectorHeight
Deg
Slot<n>.Out<n>.KeystoneXDeg
Slot<n>.Out<n>.KeystoneYDeg
Slot<n>.Out<n>.WarpTable_File
name
Slot<n>.Out<n>.WarpTable
Slot<n>.Out<n>.EDID_Filename
OuterGrid
InnerGrid
LeftOverlap
RightOverlap
TopOverlap
BottomOverlap
LeftEBPos
RightEBPos
TopEBPos
BottomEBPos
Centre_BB
Left_BB
Right_BB
Top_BB
Bottom_BB
ProjectorWidthDeg
ProjectorHeightDeg
KeystoneXDeg
KeystoneYDeg
WarpTable_Filena
me
WarpTable
EDID_Filename
Slots Commands
Description
Get or set the blue gamma value for this
output
Range: 0.30 to 2.00
Get or set the SCurve value for this
output. (brightness curve)
Range: 0.30 to 2.00
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
String
Slot15.Out1.EDID_Filename =
!Done Slot15.Out1.EDID_Filename
62
Not used.
Get or set the EDID file in any currently
being used for this output.
Property Name
View
Syntax
Slot<n>.Out<n>.View
Type
String
Example
Slot15.Out1.View = MonitorViews.View3
!Done Slot15.Out1.View
ViewPosCode
Slot<n>.Out<n>.ViewPosCode
Integer
Slot15.Out1.ViewPosCode = 18
!Done Slot15.Out1.ViewPosCode
AudioBars
Slot<n>.Out<n>.AudioBars
Integer
Slot15.Out1.AudioBars = 4
!Done Slot15.Out1.AudioBars
Equipment
PhysicalCenterX
Slot<n>.Out<n>.Equipment
Slot<n>.Out<n>.PhysicalCenter
X
Slot<n>.Out<n>.PhysicalCenterY
Slot<n>.Out<n>.PhysicalWidth
Slot<n>.Out<n>.PhysicalHeight
Slot<n>.Out<n>.PhysicalPixelWi
dth
Slot<n>.Out<n>.PhysicalPixelHe
ight
Slot<n>.Out<n>.PhysicalBezelTo
p
Slot<n>.Out<n>.PhysicalBezelBo
ttom
Slot<n>.Out<n>.PhysicalBezelLe
ft
Slot<n>.Out<n>.PhysicalBezelRi
ght
Slot<n>.Out<n>.InsList
PhysicalCenterY
PhysicalWidth
PhysicalHeight
PhysicalPixelWidth
PhysicalPixelHeight
PhysicalBezelTop
PhysicalBezelBotto
m
PhysicalBezelLeft
PhysicalBezelRight
InsList
Slots Commands
Description
This attribute will only show when there
is a Monitor Card in the system.
Get or set the view to show on the
Monitor Card.
This attribute will only show when there
is a Monitor Card in the system.
Get or set the view position for this
output on the Monitor Card.
Get or set the number of audio bars to
show for this output on the Monitor
Card.
The range is 0 to the number of audio
channels.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
Not used.
List
Slot15.Out1.InsList = NULL
!Done Slot15.Out1.InsList
63
Read only.
Get or set the list of inputs routed to this
output.
Property Name
CutToBlack
Syntax
Slot<n>.Out<n>.CutToBlack
Type
Boolean
Example
Slot15.Out1.CutToBlack = Off
!Done Slot15.Out1.CutToBlack
HDBaseT
Slot<n>.Out<n>.HDBaseT
List
CurrentMode
Slot<n>.Out<n>.HDBaseTCurren
tMode
HDBaseTStat
us
Slot15.Out1.HDBaseT.CurrentMode = Auto
Standard mode
Slot15.Out1.HDBaseT.LocalLinkStatus =
HDBASE_T_LINK_ON
Slot15.Out1.HDBaseT.LocalFwVer = 1.30.37.10
Slot15.Out1.HDBaseT.CableLength = Invalid
Slot15.Out1.HDBaseT.LocalHDMIStatus =
HDBASE_T_HDMI_HDCP_ON
Slot15.Out1.HDBaseT.MaxError = Caution: 1 : 0
:0:0
Slot15.Out1.HDBaseT.RemoteFWVer = 1.30.4.0
Slot15.Out1.HDBaseT.RemoteLinkStatus =
HDBASE_T_LINK_ON
Slot15.Out1.HDBaseT.RemoteHDMIStatus =
HDBASE_T_HDMI_HDCP_ON
Slot15.Out1.HDBaseT.LocalLinkReset()
Slot15.Out1.HDBaseT.RemoteLinkReset()
!Done Slot15.Out1.HDBaseT
Slot15.Out1.HDBaseT.CurrentMode = Auto
Standard mode
!Done Slot15.Out1.HDBaseT.CurrentMode
LocalLinkStatus
Slot<n>.Out<n>.HDBaseTLocalLi
nkStatus
HDBaseTLink
LocalFwVer
Slot<n>.Out<n>.HDBaseTLocalF
wVer
String
Slots Commands
Slot15.Out1.HDBaseT.LocalLinkStatus =
HDBASE_T_LINK_ON
!Done Slot15.Out1.HDBaseT.LocalLinkStatus
Slot15.Out1.HDBaseT.LocalFwVer = 1.30.37.10
!Done Slot15.Out1.HDBaseT.LocalFwVer
64
Description
Get or set the output to black.
When setting multiple outputs to black it
is recommended to surround them with
startbatch() endbatch() to synchronise
output blanking
List the HDBaseT specific attributes for
this card.
Read only.
Get the current HTBaseT status.
This comprises of the current
configuration and mode.
Read only.
Get the status of the local end of the
link.
Read only.
Get the version of the HDBaseT
firmware in the card.
Property Name
CableLength
Syntax
Slot<n>.Out<n>.HDBaseTCableL
ength
Type
String
Example
Slot15.Out1.HDBaseT.CableLength = Invalid
!Done Slot15.Out1.HDBaseT.CableLength
LocalHDMIStatus
Slot<n>.Out<n>.HDBaseTLocalH
DMIStatus
HDBaseTHD
MI
MaxError
Slot<n>.Out<n>.HDBaseTMaxEr
ror
HDBaseTErr
or
RemoteFWVer
Slot<n>.Out<n>.HDBaseTRemot
eFWVer
String
Slot15.Out1.HDBaseT.LocalHDMIStatus =
HDBASE_T_HDMI_HDCP_ON
!Done Slot15.Out1.HDBaseT.LocalHDMIStatus
Slot15.Out1.HDBaseT.MaxError = Caution: 255
: 255 : 255 : 255
!Done Slot15.Out1.HDBaseT.MaxError
Slot15.Out1.HDBaseT.RemoteFWVer = 1.30.4.0
!Done Slot15.Out1.HDBaseT.RemoteFWVer
RemoteLinkStatus
Slot<n>.Out<n>.HDBaseTRemot
eLinkStatus
HDBaseTLink
RemoteHDMIStatus
Slot<n>.Out<n>.HDBaseTRemot
eHDMIStatus
HDBaseTHD
MI
Slots Commands
Slot15.Out1.HDBaseT.RemoteLinkStatus =
HDBASE_T_LINK_ON
!Done Slot15.Out1.HDBaseT.RemoteLinkStatus
Slot15.Out1.HDBaseT.RemoteHDMIStatus =
HDBASE_T_HDMI_HDCP_ON
!Done
Slot15.Out1.HDBaseT.RemoteHDMIStatus
65
Description
Read only.
Get the link cable length in meters as
measured by the card.
This may be “Invalid” or a value between
20 and 100.
“Invalid,” a value outside the range or
significantly different from that of the
physical cable may indicate a cabling
issue.
Read only.
Get the status of the video connection at
the local end of the link.
Read only.
Get the error statistics.
Read only.
Get the version of the HDBaseT
firmware in the remote device.
Read only.
Get the status of the remote end of the
link.
Read only.
Get the status of the video connection at
the remote end of the link.
Property Name
Resolutions
Syntax
Slot<n>
Type
List
Resolution<n>
Slot<n>.Resolutions.Resolution
<n>
List
Name
Slot<n>.Resolutions.Resolution
<n>.Name
String
Aspect
Slot<n>.Resolutions.Resolution
<n>.Aspect
AspectRatio
CanFramelock
Slot<n>.Resolutions.Resolution
<n>.CanFramelock
Slots Commands
Example
Slot15.Resolutions.Resolution1 = <...>
Slot15.Resolutions.Resolution2 = <...>
…
Slot15.Resolutions.Resolution1000 = <...>
Slot15.Resolutions.Resolution1001 = <...>
Slot15.Resolutions.Resolution1002 = <...>
Slot15.Resolutions.Resolution1003 = <...>
Slot15.Resolutions.Resolution1004 = <...>
Slot15.Resolutions.Resolution1005 = <...>
Slot15.Resolutions.Resolution1006 = <...>
Slot15.Resolutions.Resolution1007 = <...>
Slot15.Resolutions.Resolution1008 = <...>
Slot15.Resolutions.Resolution1009 = <...>
!Done Slot15.Resolutions
Slot15.Resolutions.Resolution1.Name =
640x480p60
Slot15.Resolutions.Resolution1.Aspect = 4:3
Slot15.Resolutions.Resolution1.CanFramelock =
No
!Done Slot15.Resolutions.Resolution1
Slot15.Resolutions.Resolution1.Name =
640x480p60
!Done Slot15.Resolutions.Resolution1.Name
Slot15.Resolutions.Resolution1.Aspect = 4:3
!Done Slot15.Resolutions.Resolution1.Aspect
66
Description
List the properties for a Resolution.
Where <n> is the number of the
Resolution.
Note that Resolution1000 to
Resolution1009 are Custom Resolutions.
List the properties of the selected
resolution.
Read only.
Get the name of this resolution.
Read only.
Get or set the aspect ratio of this
resolution
Used assist in the signal conversion
when an input and the output have
different aspect ratio.
Not used.
Methods
Command
PhaseRetrain
Syntax
Slot<n>.PhaseRetrain()
Type
void
Module_Resolution
s
Slot<n>.Module_Resolutions()
List
LocalLinkReset
Slot<n>.Out<n>.HDBaseT.LocalL
inkReset()
Slot<n>.Out<n>.HDBaseT.Remo
teLinkReset()
Void
RemoteLinkReset()
Slots Commands
Void
Example
// Module 15 phase ------------------R:::::::::R---,
centres at 23, 23 (23).
!Done Slot15.PhaseRetrain()
640x480p60;4:3;
640x480p72;4:3;
…
Empty1001;4:3;
Empty1002;4:3;
Empty1003;4:3;
Empty1004;4:3;
Empty1005;4:3;
Empty1006;4:3;
Empty1007;4:3;
Empty1008;4:3;
Empty1009;4:3;
!Done Slot15.Module_Resolutions()
Slot15.Out1.HDBaseT.LocalLinkReset()
!Done Slot15.Out1.HDBaseT.LocalLinkReset()
Slot15.Out1.HDBaseT.RemoteLinkReset()
!Done Slot15.Out1.HDBaseT.RemoteLinkReset()
67
Description
Initiates a Phase retrain for this slot
List all of the supported resolutions for
this slot.
Custom resolutions will appear at the
end of the list.
The list is semicolon separated.
Reset the local end of the link.
Reset the remote end of the link.
Audio Module
It is possible to use Slot<n>.Out<n> and S<n>O<n> in place of Slots.Slot<n>.Out<n> and Slot<n>.Out<n> and S<n>O<n> in place of Slots.Slot<n>.Out<n>.
Properties
Property Name
Slot<n>
Syntax
Slot<n>
Type
List
Cardtype
Slot<n>.Cardtype
CardTypeEn
um
CardData
In<n>
Slot<n>.Carddata
Slot<n>.In<n>
List
FullName
Slot<n>.In<n>.FullName
String
Status
Slot<n>.In<n>.Status
StatusEnum
Slots Commands
Example
Slot1.Cardtype = Audio 8-in 8-out
Slot1.Carddata = <No Value>
Slot1.In1 = <...>
Slot1.In2 = <...>
Slot1.In3 = <...>
Slot1.In4 = <...>
Slot1.In5 = <...>
Slot1.In6 = <...>
Slot1.In7 = <...>
Slot1.In8 = <...>
Slot1.Out1 = <...>
Slot1.Out2 = <...>
Slot1.Out3 = <...>
Slot1.Out4 = <...>
Slot1.Out5 = <...>
Slot1.Out6 = <...>
Slot1.Out7 = <...>
Slot1.Out8 = <...>
!Done Slot1
Slot1.Cardtype = Audio 8-in 8-out
!Done Slot1.Cardtype
Slot1.In1.FullName = In1
Slot1.In1.Status =
Slot1.In1.Alias = s1i1
Slot1.In1.AudInA = NULL
!Done Slot1.In1
Slot1.In1.FullName = In1
!Done Slot1.In1.FullName
Slot1.In2.Status =
!Done Slot1.In2.Status
68
Description
List the properties of the card in this slot
or “NO CARD” if the slot is empty.
Read-only.
Get the type of the card in this slot.
Not used.
List the properties for an Input on this
Slot.
Where In<n> is the input on the card.
Read-only.
Get the full name of the Window
Read-only.
Get the status of the input.
Property Name
Alias
Syntax
Slot<n>.In<n>.Alias
Type
String
AudInA
Slot<n>.In<n>.AudInA
String
Out<n>
Slot<n>.Out<n>
List
FullName
Slot<n>.Out<n>.FullName
String
Status
Slot<n>.Out<n>.Status
StatusEnum
Alias
Slot<n>.Out<n>.Alias
String
AudOutA
Slot<n>.Out<n>.AudOutA
String
Slots Commands
Example
Slot1.In1.Alias = s1i1
!Done Slot1.In1.Alias
Slot1.In1.AudInA = NULL
!Done Slot1.In1.AudInA
Slot1.Out1.FullName = Out1
Slot1.Out1.Status =
Slot1.Out1.Alias = s1o1
Slot1.Out1.AudOutA = NULL
!Done Slot1.Out1
Slot1.Out1.FullName = Out1
!Done Slot1.Out1.FullName
Slot1.Out1.Status =
!Done Slot1.Out1.Status
Slot1.Out1.Alias = s1o1
!Done Slot1.Out1.Alias
Slot1.Out1.AudOutA = NULL
!Done Slot1.Out1.AudOutA
69
Description
Get or set the Alias name for this input.
Read only.
Defines the audio channel input for
channel A
List the properties for an Output on this
Slot.
Where Out<n> is the output on the card.
Read-only.
Get the full name of the Window
Read-only.
Get the status of the output
Get or set the Alias name for this output.
Read only.
Defines the audio channel output for
channel A
Routing Commands
Properties
Command
Routing
Syntax
Routing
Windows
Canvases
Layouts
Routing.Windows
Routing.Canvases
Routing.Layouts
Routing Commands
Type
List
Example
Routing.Windows = <...>
Routing.Canvases = <...>
Routing.Layouts = <...>
Routing.MonitorViews = <...>
Routing.Preset = <...>
!Done Routing
Description
List the routing commands and
properties
Not used.
Not used.
Not used.
70
MonitorViews Commands
It is possible to use MonitorViews in place of Routing. MonitorViews and either View<n> or MonitorViews.View<n> in place of Routing.
MonitorViews.View<n>.
In View<n> the “<n>” represents the number of the View (for example “1” for View1).
Note that these attributes will only be available if there is a Monitor Card present.
Properties
Property Name
MonitorViews
Syntax
MonitorViews
Type
List
View<n>
View<n>
List
FullName
View<n>.FullName
String
Status
View<n>.Status
Alias
View<n>.Alias
String
Canvas
View<n>.Canvas
String
Routing Commands
Example
MonitorViews.View1 = <...>
MonitorViews.View2 = <...>
MonitorViews.View3 = <...>
MonitorViews.View4 = <...>
MonitorViews.AutoScaling = On
MonitorViews.Auto = Off
!Done MonitorViews
View1.FullName = View1
View1.Status = FREE
View1.Alias = NULL
View1.Canvas = Canvas1
View1.CanWidth = 896
View1.CanHeight = 512
View1.CanXCentre = -448
View1.CanYCentre = -256
View1.Zorder = 1
View1.RotateDeg = 0
View1.VNum = 34
!Done View1
View1.FullName = View1
!Done View1.FullName
View1.Status = FREE
!Done View1.Status
View1.Alias = NULL
!Done View1.Alias
View1.Canvas = Canvas1
71
Description
List of properties and submenus for the
Monitor Card routing.
List the View properties.
Get or set the name of this monitor
view.
Not used.
Get or set the alias name for this View
Get or set the view of a thumbnail.
Property Name
Syntax
Type
CanWidth
View<n>.CanWidth
Integer
CanHeight
View<n>.CanHeight
Integer
CanXCentre
View<n>.CanXCentre
Integer
CanYCentre
View<n>.CanYCentre
Integer
Zorder
View<n>.Zorder
Integer
RotateDeg
View<n>.RotateDeg
Degrees
VNum
View<n>.VNum
Integer
AutoScaling
MonitorViews.AutoScaling
Boolean
Auto
MonitorViews.Auto
Boolean
Routing Commands
Example
!Done View1.Canvas
View1.CanWidth = 896
!Done View1.CanWidth
View1.CanHeight = 512
!Done View1.CanHeight
View1.CanXCentre = -448
!Done View1.CanXCentre
View1.CanYCentre = -256
!Done View1.CanYCentre
View1.Zorder = 1
!Done View1.Zorder
View1.RotateDeg = 0
!Done View1.RotateDeg
View1.VNum = 34
!Done View1.VNum
MonitorViews.AutoScaling = On
!Done MonitorViews.AutoScaling
MonitorViews.Auto = Off
!Done MonitorViews.Auto
72
Description
Get or set the width of a thumbnail.
Get or set the height a thumbnail.
Get or set the horizontal location on
screen of a thumbnail.
Get or set the vertical location on screen
of a thumbnail.
Get or set the order of the thumbnails.
Get or set the rotation of a thumbnail in
degrees.
Get or set the thumbnail grid layout.
The number is calculated from the
following formula:
VNum = <x> * 16 + <y>
For example:
1x1 grid = 1 * 16 + 1 = 17
2x2 grid = 2 * 16 + 2 = 34
2x1 grid = 2 * 16 + 1 = 33
4x4 grid = 4 * 16 + 4 = 68
Get or set automatic scaling of the
thumbnails.
Get or set automatic (“On”) or manual
(“Off”) configuration of the Monitor
Card views.
Preset Commands
It is possible to use Preset in place of Routing.Preset.
Properties
Property Name
Preset
Syntax
Preset
Type
List
Take
Preset.Take
Integer
Read
Preset.Read
Integer
Valid
Preset.Valid
Boolean
NameRead
Preset.NameRead
String
CanvasRead
SeqNumRead
FlagsRead
DataRead
Preset.CanvasRead
Preset.SeqNumRead
Preset.FlagsRead
Preset.DataRead
Routing Commands
Example
Preset.PresetList()
Preset.Take = 0
Preset.Read = 0
Preset.Valid = No
Preset.NameRead =
Preset.CanvasRead =
Preset.SeqNumRead = 0
Preset.FlagsRead = 0
Preset.DataRead = <No Value>
Preset.SaveRead()
Preset.RestoreRead()
Preset.RmvPresetFileRead()
Preset.SaveAllPresets()
Preset.RestoreAllPresets()
Preset.RemovePresetFiles()
!Done Preset
Preset.Take = 0
!Done Preset.Take
Preset.Read = 0
!Done Preset.Read
Preset.Valid = No
!Done Preset.Valid
Preset.NameRead =
!Done Preset.NameRead
73
Description
List of the preset properties.
Get or set the active preset (by ID
number: 1-49)
This is the equivalent to Preset.Read
followed by Preset.RestoreRead.
Get or set the preset to be edited (by ID
number: 1-49)
Read-only.
Get if the active preset has been saved.
Get or set the name of the active preset.
The name may be up to 19
alphanumeric characters, no spaces.
Not used.
Not used.
Not used.
Not used.
Methods
Command
PresetList
Syntax
Preset.PresetList()
Type
List
Example
Routing.Preset.PresetList[0]=preset0,
!Done Preset.PresetList()
SaveRead
Preset.SaveRead()
Void
RestoreRead
Preset.RestoreRead()
Void
RmvPresetFileRead
Preset.RmvPresetFileRead()
Void
SaveAllPresets
Preset.SaveAllPresets()
Void
// Preset(s) saved.
!Done Preset.SaveRead()
// Preset(s) restored.
!Done Preset.RestoreRead()
// Preset(s) cleared.
!Done Preset.RmvPresetFileRead()
// Preset(s) saved.
!Done Preset.SaveAllPresets()
RestoreAllPresets
Preset.RestoreAllPresets()
Void
// Preset(s) restored.
!Done Preset.RestoreAllPresets()
RemovePresetFiles
Preset.RemovePresetFiles()
Void
// Preset(s) cleared.
!Done Preset.RemovePresetFiles()
Routing Commands
74
Description
List all the valid presets by ID.
The result will contain the preset name
and Canvas name if any.
Save the active preset from the live data
(RAM) to the on-chip memory.
Restore the active preset from the onchip memory to the live data (RAM).
Clear the active preset from the on-chip
memory.
Deprecated
Save all presets to the on-chip memory.
Redundant as RAM and on-chip memory
are kept synchronized.
Deprecated
Restore all presets from the on-chip
memory.
Redundant as RAM and on-chip memory
are kept synchronized.
Clear all presets from the on-chip
memory.
Custom Types
Name
AnalogType
AspectRatio
AudioInput
Boolean
ColourScale
DisplayType
FoundNot
FoundOff
FramelockStatus
FrameType
GenlockStatus
HDBaseTError
HDBaseTHDMI
HDBaseTLink
Custom Types
Values
RGBHV, RGBs, RGsB, YCbCr/YPbPr
16:9, 4:3, 5:4, 16:10, 5:3, 1:1, 16:6
Slot<n>.In<n>.AudIn<X>, NULL
–
Where <n> is a number and <X> is a letter.
“On” and “Off” or “Yes” and “No”
Auto, Black, YUV, RGB, YUV_601, YUV_709
Monitor, Projector, None
Found, Not_Found
Found, Off
Off, Locked, Unlocked
I
Interlaced
P
Progressive
Off, Locked
The quality of the HDBaseT link.
Max error Status:
Valid: <n> : <n> : <n> : <n>
The error statistics have stabilised.
Caution: <n> : <n> : <n> : <n>
The error statistics have not yet stabilised.
Four channels of error statistics. If valid, the lower the number the better the quality of the link For example:
Valid: 16 : 15 : 15 : 16
The current state of the Video transfer:
HDBASE_T_HDMI_NONE
No video is being transmitted over the link.
HDBASE_T_HDMI_ON
Un-encrypted video is being transmitted over the link.
HDBASE_T_HDMI_HDCP_ON
Encrypted video is being sent over the link.
HDBASE_T_HDMI_INDETERMINATE
Warning, unable to read remote status.
Local and remote link status:
HDBASE_T_LINK_NONE
No link established.
HDBASE_T_LINK_ON
Link is established.
HDBASE_T_LINK_LOW_POWER
Link has entered a low power mode.
HDBASE_T_LINK_ETHER_ONLY
Ethernet only mode.
HDBASE_T_LINK_INDETERMINATE
An error condition has occurred.
Note that the remote link and the local link should normally be expected to be in the same state. A difference would indicate an error
condition, or a possible incompatibility between the transmitter and the receiver.
75
Name
HDBaseTStatus
HDCPDownstream
HDCPReq
HDCPSup
Polarity
Role
ScanMode
SrcLossColor
StatusEnum
SystemStatus
TestPattern
TypeChoice
WindowStatus
Custom Types
Values
The status of the HTBaseT module, it consists of a configuration part and a mode part.
The current configuration:
Unknown
An error has occurred.
Auto
The link has auto configured. The expected value.
Manual
Not supported
The current mode:
Standard mode
Default, normal operation.
Disconnect
Link is inactive.
Long reach mode
Link is attempting to work over a longer cable.
Ethernet Fallback
Link will pass Ethernet connections but not video.
Reserved
Link is in a reserved state. This will indicate an error condition.
Powerdown 1
The link has entered one of two low power modes
Powerdown 2
The link has entered one of two low power modes.
HDMI Bypass
Link is not being used. Entering this mode will indicate an error of some kind.
Status of the HDCP link:
HoldOn
Keep HDCP active
KeepOff
De-activate HDCP
FollowSource
Turns HDCP on or off depending on the source
Required, Off
Supported, Off
N
Negative
P
Positive
Administrator, PowerUser, User, Guest, Test
I
Interlaced
P
Progressive
Black, Blue, Red, Green, Yellow, Magenta, Cyan, White
UNKNOWN, OK, INVALID
Serving, Busy
RGB_100, Black, 8x8_Grid, Dot, 8x8_ChqBrd
Options for DVI cards:
DVI, RGBHV, RGsB, YUV, CV, YC
Options for SDI cards
SDI
FREE, ALLOCATED, IN USE, NULL
76
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising