VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network...

40
Infinite Ways to Collaborate VIA Collage API Commands (For Version 1.7) www.True-Collaboration.com

Transcript of VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network...

Page 1: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

Infinite Ways to Collaborate

VIA Collage API Commands(For Version 1.7)

www.True-Collaboration.com

Page 2: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

V I A C o l l a g e A P I C o m m a n d s

CONTENTS

INTRODUCTION ............................................................................................................ 1

CONNECTING TO WINDOWS .......................................................................................... 2

CONNECTING TO MAC ................................................................................................... 3

COMMANDS AND DESCRIPTION ..................................................................................... 4

LOGIN ......................................................................................................................... 5

PLIST .......................................................................................................................... 6

DISPLAYSTATUS .......................................................................................................... 7

HDMI .......................................................................................................................... 8

VOL .......................................................................................................................... 11

SETTINGS .................................................................................................................. 12

IPINFO ...................................................................................................................... 13

IPSETTING ................................................................................................................. 14

RCODE ...................................................................................................................... 15

RNAME ..................................................................................................................... 18

DATETIME ................................................................................................................. 20

PIP ........................................................................................................................... 21

PRSMODE ................................................................................................................. 22

MEDIAMODE .............................................................................................................. 23

LOG .......................................................................................................................... 24

QUICKLAUNCH ........................................................................................................... 25

RESET ....................................................................................................................... 26

REBOOT .................................................................................................................... 27

SCREENSHARE ........................................................................................................... 28

WHITEBOARD ............................................................................................................ 29

GETTPAPP ................................................................................................................. 30

LAUNCH ................................................................................................................... 31

CONTROL .................................................................................................................. 32

SUPDATE .................................................................................................................. 33

UPDATE .................................................................................................................... 34

POWEROFF ................................................................................................................ 35

DND ......................................................................................................................... 36

KICKOFF .................................................................................................................... 37

Page 3: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

1V I A C o l l a g e A P I C o m m a n d s

INTRODUCTION

PURPOSE

This document lists the configuration and operation commands for VIA Collage used with different touch panel controllers.

INTENDED AUDIENCE AND READING SUGGESTIONS

The document is intended for AV consultants, integrators and touch panel programmers, to de-sign and develop AV solutions based on VIA Collage.

DEVELOPMENT/TESTING REQUIREMENTS

• A functioning VIA Collage unit installed and configured on a network• Any one of these

• A computer with Windows 7 installed• An Apple computer• A Telnet Client (PuTTY, Terminal or some other client)

To download and run PuTTY, use the following Web sites:• http://the.earth.li/~sgtatham/putty/latest/x86/putty.exe• http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html

SETUP

VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if a VIA Collage is working as intended, install the latest VIA Collage client software and login using a nickname.

Page 4: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

2 V I A C o l l a g e A P I C o m m a n d s

CONNECTING TO WINDOWS1. Open PuTTY and enter the VIA Collage IP address under Host Name.2. Enter 9982 as Port 3. Select Telnet under Protocol and click Open.

4. A login screen appears indicating that PuTTY is connected to server.

Page 5: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

3V I A C o l l a g e A P I C o m m a n d s

CONNECTING TO MAC1. Open Terminal2. Type telnet <VIA Collage unit’s IP Address> 9982

P.S.: Leave a space between IP address and port number. 3. On successful login, the following screen appears

P.S.: The commands explained in the following pages are all case sensitive. If the commands do not generate an output and appear to be not doing anything, check the syntax and case.

Page 6: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

4 V I A C o l l a g e A P I C o m m a n d s

COMMANDS AND DESCRIPTIONAn input command is a XML-based format that passes various parameters for different tasks. The commands must not contain any blank spaces.

<P><UN>Username</UN><Pwd>Password</Pwd><Cmd>Command</Cmd><P1>Parame-ter1</P1><P2>Parameter2</P2><P3>Parameter3</P3><P4>Parameter4</P4><P5>Pa-rameter5</P5><P6>Parameter6</P6><P7>Parameter7</P7><P8>Parameter8</P8><P9>Parameter9</P9><P10>Parameter10</P10></P>

Abbreviation Description Values

P Command wrapper Required

UN A valid username for authentication Required

Pwd Password of the above user for authentication Required

Cmd Actual command to send Required

P1 Parameter one of command Optional

P2 Parameter two of command Optional

P3 Parameter three of command Optional

P4 Parameter four of command Optional

P5 Parameter five of command Optional

P6 Parameter six of command Optional

P7 Parameter seven of command Optional

P8 Parameter eight of command Optional

P9 Parameter nine of command Optional

P10 Parameter ten of command Optional

For all following command examples, we use a VIA Collage unit with IP address 192.168.100.240 and three users: Jolly, Mike and Smith. User name: su and password: supass was used for authentication.

P.S.: Ensure that the commands mentioned do not contain unwarranted blank spaces. Edit to remove these spaces before using these commands.

Page 7: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

5V I A C o l l a g e A P I C o m m a n d s

LOGINDESCRIPTION: This command authenticates the touch panel user and enables execution of other commands. After a successful login, the password, enclosed by <Pwd> and </Pwd>, can be left blank from all the subsequent commands. The username, however, must be mentioned under <UN></UN> in all commands.COMMAND: <P><UN>su</UN><Pwd>supass</Pwd><Cmd>Login</Cmd><P1></P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Login Successful Now Please send a commandEXPLANATION:User name and password provided in ‘UN’ and ‘Pwd’ sections are correct.

ERROR

If the username, password or their combination is incorrect, the following errors are generated:

Error Code Error Code Description

Error11 XML does not contain User Name. Username blank

Error12 User is not authorized.

Error13 Incorrect User name and password.

Error14 No such user exists.

Page 8: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

6 V I A C o l l a g e A P I C o m m a n d s

PLISTDESCRIPTION: This command gives number of all users logged in to VIA Collage along with their participant type. PList stands for Participant List. Parameter P2 of this command gets the participant type: 0—Inactive (not presenting on display)1—Active (presenting on display)2—Waiting (waiting for permission from Moderator in presentation mode)3—All

CNT

DESCRIPTION: Parameter P1 gets the count of users logged in to VIA Collage at that moment. COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PList</Cmd><P1>cnt</P1><P2>3</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: PList|cnt|<Participant Type>|<count of users>OUTPUT: PList|cnt|3|3EXPLANATION: 3 denotes participant type (All) and 3 is count of logged-in users.

ALL

DESCRIPTION: Parameter P1 gets the names of users logged in to VIA Collage.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PList</Cmd><P1>all</P1><P2>3</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: PList|all|<Participant Type>|<User name 1>#<User Name 2>#...OUTPUT: PList|all|3|jolly#smith#mike# EXPLANATION: Here jolly, mike and smith are logged in to VIA Collage at the moment and their names are delimited by #. ‘3’ denotes participant type ‘all’.

STATUS

DESCRIPTION: This is different from the above command in the way that it gives the status of all users. For this we pass ‘4’ as parameter for P2.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PList</Cmd><P1>all</P1><P2>4</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: PList|all|<User name 1>#<User Name 2>#...OUTPUT: Plist|all|jolly_0#mike_1#Smith_2EXPLANATION: Here 0 is not presenting, 1 is presenting and 2 is waiting (in case of pre-sentation mode). Hence jolly is not presenting, mike is presenting and smith is waiting for per-mission from the moderator.

Page 9: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

7V I A C o l l a g e A P I C o m m a n d s

DISPLAYSTATUSDESCRIPTION: This command gets the display status of a user. Also, you can start or stop a user’s presentation on main display using this command.

GET

DESCRIPTION: Parameter P1 gets the display status of a user specified in parameter P2. The display status can be Presenting, Not Presenting or Waiting (in case waiting for permission from Moderator when presentation mode is active).COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>DisplayStatus</Cmd><P1>Get</P1><P2>jolly</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: DisplayStatus|Get|<display status of user>OUTPUT: DisplayStatus|Get|PresentingEXPLANATION: Here Presenting denotes that jolly is presenting on main display

Expected Output Details

DisplayStatus|Get|Presenting User is presenting on main display

DisplayStatus|Get|NotPresenting User is not presenting on main display

DisplayStatus|Get|Waiting User is awaiting Moderator’s permission to take display (applicable in Presentation Mode)

SET

DESCRIPTION: This command starts / stops presentation of a user on main display. Set is parameter P1, User Name as parameter P2 and 0 or 1 as parameter P3 for Start or Stop Pre-sentation respectively.

Value for P3 Details

0 Stop user’s presentation

1 Start user’s presentation

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>DisplayStatus</Cmd><P1>Set</P1><P2>mike</P2><P3>1</P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: DisplayStatus|Set|<user name>|1

Expected Output Details

DisplayStatus|Set|<user Name>|<0/1> Presentation Starts / Stops

DisplayStatus|Set|AlreadyPresenting User presenting on main display already

DisplayStatus|Set|AlreadyNotPresenting User not presenting already

OUTPUT: DisplayStatus|Set|mike|1EXPLANATION: Mike’s display is now seen on main screen.

Page 10: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

8 V I A C o l l a g e A P I C o m m a n d s

HDMIDESCRIPTION: This command, through its parameters — cnt, Get, Switch, On and Off — gets the count of HDMI Inputs, statuses of devices connected to these HDMI inputs, switches between PIP and non PIP mode and can start or stop the input from these devices. The switch command can run only on first HDMI Input port.

CNT

DESCRIPTION: Parameter P1 gets the count of HDMI Input ports on a VIA Collage unit. This command is not to check the status of devices connected through HDMI ports, rather to check if a gateway in question has HDMI ports and their count, if any.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>HDMI</Cmd><P1>cnt</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: HDMI|cnt|<no. of HDMI Input> OUTPUT: HDMI|cnt|1EXPLANATION: Here 1 denotes, 1 HDMI Input port on VIA Collage unit.

Expected Output Details

HDMI|cnt|-1 VIA Collage has no HDMI input ports

HDMI|cnt|1 VIA Collage has single HDMI input port

HDMI|cnt|2 VIA Collage has two HDMI input ports

GET

DESCRIPTION: This command gets the status of the device connected to the VIA Collage HDMI input channel specified by parameter P2. In other words, parameter P1 returns the status of HDMI Input, which was passed in parameter P2.

Value for P2 Details

1 To check the status of HDMI Input 1

2 To check the status of HDMI Input 2

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>HDMI</Cmd><P1>Get</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: HDMI|Status|<HDMI # 1 or 2>|<Status of HDMI # 1 or 2>OUTPUT: HDMI|Status|1|1EXPLANATION: Here output shows the status of HDMI Input 1 is ON

Expected Output Details

HDMI|Status|1|1 HDMI Input 1 is ON

HDMI|Status|1|0 HDMI Input 1 is OFF

HDMI|Status|2|1 HDMI Input 2 is ON

HDMI|Status|2|0 HDMI Input 2 is OFF

Page 11: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

9V I A C o l l a g e A P I C o m m a n d s

SWITCH

DESCRIPTION: Parameter P1 switches between PIP and non-PIP mode on HDMI 1.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>HDMI</Cmd><P1>Switch</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: HDMI|Switch|1| <Status>OUTPUT: HDMI|Switch|1|1EXPLANATION: The first 1 denotes the HDMI Input Port position (First or second) and the second 1 means the command run was successful.

ON

Description: This parameter enables the input specified in Parameter P1. Parameter P2 specifies the channel number 1 or 2 (to enable).

Value for P2 Details

1 For HDMI Input 1

2 For HDMI Input 2

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>HDMI</Cmd><P1>On</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: HDMI|On|<no. of HDMI Input>|1OUTPUT: HDMI|On|1|1EXPLANATION: Output of HDMI Input 1 was displayed successfully on VIA Collage display.

Expected Output Details

HDMI|On|1|1 Output of HDMI Input 1 shows successfully at VIA Collage display

HDMI|On|2|1 Output of HDMI Input 2 shows successfully at VIA Collage display

OFF

DESCRIPTION: This parameter disables the input specified in Parameter P1. Parameter P2 specifies the channel number 1 or 2 (to disable)

Value for P2 Details

1 For HDMI Input 1

2 For HDMI Input 2

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>HDMI</Cmd><P1>Off</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: HDMI|Off|<HDMI Input position (1 or 2)>|1 OUTPUT: HDMI|Off|1|1EXPLANATION: Output of HDMI Input 1 was stopped successfully

Page 12: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

10 V I A C o l l a g e A P I C o m m a n d s

Expected Output Details

HDMI|Off|1|1 Output of HDMI Input 1 stops successfully from VIA Collage display

HDMI|Off|2|1 Output of HDMI Input 2 stops successfully from VIA Collage display

Page 13: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

11V I A C o l l a g e A P I C o m m a n d s

VOLDESCRIPTION: This command gets/sets the volume of VIA Collage.

GET

DESCRIPTION: Parameter P1 returns the current Volume value of VIA Collage unitCOMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Vol</Cmd><P1>Get</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Vol|Get|<value of Volume>OUTPUT: Vol|Get|15EXPLANATION: Here 15 shows that currently, the Volume of Multimedia Player is set at 15%.

SET

DESCRIPTION: This command sets the volume of VIA Collage unit. User passes a value — a whole number — in parameter P2. The volume set here immediately reflects on VIA Collage unit. However, this command does not return any result.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Vol</Cmd><P1>Set</P1><P2>65</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Sets the volume as per the value passed in command.

ERROR

Error Code Error Code Description

Error01 Invalid value passed in command to set volume.

Error02 Blank value passed to set volume.

Page 14: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

12 V I A C o l l a g e A P I C o m m a n d s

SETTINGSThe changes mentioned here are intrinsic to VIA Collage’s functioning. Whenever a change is made to any option under VIA Collage Settings you must restart the unit. Include a rebooting com-mand every time the following changes are made.

For changes to take effect, the VIA Collage unit must be restarted. The following command re-boots a VIA Collage unit:

<P><UN>su</UN><Pwd></Pwd><Cmd>Reboot</Cmd><P1></P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>P.S.: Make changes to VIA Collage Settings when there are no participants connected so the reboot does not interrupt any ongoing presentation.

Page 15: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

13V I A C o l l a g e A P I C o m m a n d s

IPINFODESCRIPTION: This command gets the IP Address information like: IP Address, Subnet Mask, Gateway, DNS Server 1, and DNS Server 2 for a VIA Collage unitCOMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>IpInfo</Cmd><P1></P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: IP:<VIA Collage IP Address> | NETMASK: <Net mask of VIA Collage> | GATEWAY: <Gateway Address defined at VIA Collage> | DNS1:<DNS Server 1 defined at VIA Collage> | DNS2:<DNS Server 2 defined at VIA Collage>OUTPUT: IP:192.168.11.11|NETMASK:255.255.255.0|GATEWAY:192.168.11.1| DNS1:192.168.100.3|DNS2:|EXPLANATION: The output shows all details like IP address, default gateway and DNS server.

Page 16: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

14 V I A C o l l a g e A P I C o m m a n d s

IPSETTINGDESCRIPTION: This command sets IP Address and other network related information for a VIA Collage unit.

Parameter Value Details

P1 IP Address Specify IP Address for VIA Collage unit

P2 Subnet Mask Specify Subnet Mask for VIA Collage unit

P3 Gateway Specify Default Gateway for VIA Collage unit

P4 DNS Server1 Specify DNS Server1 for VIA Collage unit

P5 DNS Server2 Specify DNS Server2 for VIA Collage unit

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>IpSetting</Cm-d><P1>192.168.100.240</P1><P2>255.255.255.0</P2><P3>192.168.100.1</P3><P4>192.168.100.3</P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>This command updates the LAN Settings for VIA Collage unit and reboots the VIA Collage unit. DNS Server 2 is optional. Give DNS Server 1 only when the unit is to be connected to the internet.

P.S.: The IP address is not validated, so check the values before running this command. If the unit is not accessible after running this command, connect a keyboard and mouse to the VIA Collage and reset the IP settings manually.

Page 17: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

15V I A C o l l a g e A P I C o m m a n d s

RCODEDESCRIPTION: This command checks the Room Code settings.

GET (ACTIVESTATUS)

DESCRIPTION: These parameters get the status of Room Code i.e. whether Room Code is required while logging in. Parameter P2 gets the status of Room Code i.e.COMMAND:<P><UN>su</UN><Pwd></Pwd><Cmd>RCode</Cmd><P1>Get</P1><P2>Ac-tiveStatus</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RCode|Get|ActiveStatus|<status of Room Code>OUTPUT: RCode|Get|ActiveStatus|1EXPLANATION: 1 in the output shows that Room Code is currently required by VIA Collage client to login

Expected Output Details

RCode|Get|ActiveStatus|1 Room Code is currently required by VIA Collage client.

RCode|Get|ActiveStatus|0 Room Code is currently not required by VIA Collage client.

GET (APPEARSTATUS)

DESCRIPTION: These parameters check the display status of Room Code i.e. whether the Room Code always displays on wallpaper or appears only when someone attempts a login. Param-eter P2 gets the display status of Room Code.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RCode</Cmd><P1>Get</P1><P2>Ap-pearStatus</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RCode|Get|AppearStatus|<show status of Room Code>OUTPUT: RCode|Get|AppearStatus|1EXPLANATION: The output shows that Room Code appear status is enabled at this time and the Room Code is in ‘always shows on wallpaper’ mode.

Expected Output Details

RCode|Get|AppearStatus|1 Room Code appear status is enable currently

RCode|Get|AppearStatus|0 Room Code appear status is disable currently

GET (CODE)

DESCRIPTION: These parameters help you get the Room Code to login at VIA Collage client.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RCode</Cmd><P1>Get</P1><P2>Code</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RCode|Get|Code|<current Room Code from VIA Collage>OUTPUT: RCode|Get|Code|7864EXPLANATION: The output shows that 7864 is the current Room Code used to login at VIA Collage client.

Page 18: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

16 V I A C o l l a g e A P I C o m m a n d s

ERROR

If Room Code is not enabled then the following error appears:

Error Code Error Code Description

Error21 Room code is not enabled.

GET (RTIME)

DESCRIPTION: These parameters check the refresh time for Room Code i.e. the duration for which Room Code remains the same before changing.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RCode</Cmd><P1>Get</P1><P2>R-Time</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P> Expected Output: RCode|Get|RTime|<Room Code Refresh Time>OUTPUT: RCode|Get|Rtime|30EXPLANATION: The output shows Room Code refresh time is 30 min, meaning that the Room Code changes after 30 mins.

SET (RTIME)

DESCRIPTION: These parameters set the Refresh Time (in minutes) for Room Code. Param-eter P3 passes the time value. COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RCode</Cmd><P1>Set</P1><P2>R-Time</P2><P3>10</P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RCode|Set|RTime|1EXPLANATION: 1 in the output shows the command is successful and the Room Code changes every 10 minutes.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error32 Unable to set refresh time

Error33 Wrong refresh time value

Error34 Blank refresh time value

P.S.: You can set only those Refresh Time values that are defined in Refresh Time drop down menu in Room Name/Code tab under VIA Collage Settings.

SET (ACTIVESTATUS)

DESCRIPTION: These parameters enable/disable Room Code requirement by VIA Collage Client to login. Pass 1 or 0 as parameter(P3) to enable/disable Room Code.

Value for P3 Details

1 To enable Room Code for login at VIA Collage client

0 To disable Room Code for login at VIA Collage client

Page 19: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

17V I A C o l l a g e A P I C o m m a n d s

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RCode</Cmd><P1>Set</P1><P2>Ac-tiveStatus</P2><P3>1</P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RCode|Set|ActiveStatus|1

ERROR

Invalid command values give the following errors:

Error Code Error Code Description

Error22 Unable to set active status.

Error23 Room code active status already On.

Error24 Unable to set active status.

Error25 Unable to set active status.

Error26 Room code active status already Off.

SET (APPEARSTATUS)

DESCRIPTION: These parameters set the appear status of the Room Code i.e. if Room Code is enabled this parameter enables/disables permanent display of Room Code on VIA Collage wall-paper. User has to give a value of 1 or 0 in parameter P3.

Value for P3 Details

1 To show Room Code always at wallpaper

0 To hide visibility of Room Code

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RCode</Cmd><P1>Set</P1><P2>Ap-pearStatus</P2><P3>1</P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RCode|Set|AppearStatus|1EXPLANATION: 1 shows the command is successful and Room Code shows on the wallpaper.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error27 Room code is not active.

Error28 Unable to set appear status.

Error29 Room code appears status already On.

Error30 Unable to set appear status.

Error31 Room code appear status already Off.

Page 20: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

18 V I A C o l l a g e A P I C o m m a n d s

RNAMEDESCRIPTION: This command gets/sets the Room name settings available on VIA Collage.

GET (STATUS)

DESCRIPTION: These parameters check the Room Name. Parameter P1 and P2 are used for the same. COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RName</Cmd><P1>Get</P1><P2>Status</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RName|Get|Status|<active status of Room Name>OUTPUT: RName|Get|Status|1EXPLANATION: 1 shows Room Name is activated at this moment and displayed at the wall-paper of VIA Collage unit.

Expected Output Details

RName|Get|Status|1 Room Name is activated and appears on VIA Collage wallpaper

RName|Get|status|0 Room Name is deactivated and does not appear on wallpaper

SET (STATUS)

Description: These parameters set the status of Room name i.e. whether Room name is shown or not on the wallpaper of VIA Collage unit. 1/0 in parameter P3 enables/disables the displayed status of Room Name.

Value for P3 Details

1 Displays Room Name on VIA Collage Wallpaper

0 Hides Room name

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RName</Cmd><P1>Set</P1><P2> Status</P2><P3>1</P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8> <P9></P9><P10></P10></P>EXPECTED OUTPUT: Rname|Set|Status|1EXPLANATION: 1 shows command is successful and Room Name is now enable/disable to be displayed on the wallpaper of VIA Collage unit.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error43 Unable to set room name status.

Error44 Room name status already on.

Error45 Unable to set room name status.

Error46 Room name status already off.

Page 21: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

19V I A C o l l a g e A P I C o m m a n d s

GET (NAME)

DESCRIPTION: This parameter (P2) checks the Room name shown on the wallpaper of VIA Collage.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>RName</Cmd><P1>Get</P1><P2>Name</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RName|Get|Name|<name of VIA Collage>OUTPUT: RName|Get|Name|VIA Collage_14EXPLANATION: The output shows VIA Collage_14 is the Room Name of VIA Collage.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error41 Unable to get room name value.

Error42 Unable to get room name value.

SET (NAME)

DESCRIPTION: This command sets the Room Name for VIA Collage which is used to login at VIA Collage client and shown at wallpaper of VIA Collage unit. The user passes the value for Room Name in (P3) parameter.COMMAND:<P><UN>su</UN><Pwd></Pwd><Cmd>RName</Cmd><P1>Set</P1><P2>Name</P2><P3>VIA Collage_ConRoom</P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: RName|Set|Name|1EXPLANATION: Here 1 shows that command is successful and Room Name is updated now.

P.S. If name is used as shown in example above, then a DNS has to be configured accordingly.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error47 Room name is not active.

Error48 Unable to set room name value.

Error49 Blank room name value.

Page 22: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

20 V I A C o l l a g e A P I C o m m a n d s

DATETIMEDESCRIPTION: This command checks and updates display status of Date & Time on VIA Col-lage wallpaper.

GETVISIBLE

DESCRIPTION: Parameter (P1) checks the display status of Date & Time on VIA Collage wall-paper.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>DateTime</Cmd><P1>GetVisi-ble</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: DateTime|GetVisible|<show status of Date & Time>OUTPUT: DateTime|GetVisible|1EXPLANATION:1 in the output shows that Date & Time is visible on VIA Collage wallpaper.

Expected Output Details

DateTime|GetVisible|1 Show status of Date & Time is enabled.

DateTime|GetVisible|0 Show status of Date & Time is disabled.

SETVISIBLE

DESCRIPTION: This parameter enables / disables Date & Time display. Pass 1 or 0 as P2.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>DateTime</Cmd><P1>SetVisi-ble</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: DateTime|SetVisible|1EXPLANATION: 1 denotes display status for Date & Time is enabled successfully.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error71 Unable to set Date & Time visibility.

Error72 Date & Time visibility already on.

Error73 Unable to set Date & Time visibility.

Error74 Date & Time visibility already off.

Page 23: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

21V I A C o l l a g e A P I C o m m a n d s

PIPDescription: This command checks and sets the default mode of HDMI Input as PIP (Picture in Picture) or a normal display.

GET

DESCRIPTION: This parameter gets the current mode of HDMI Input. COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PIP</Cmd><P1>Get</P1><P2></P2> <P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9> <P10></P10></P>EXPECTED OUTPUT: PIP|Get|<current mode of HDMI Input>OUTPUT: PIP|Get|1EXPLANATION: 1 shows PIP mode is enabled for HDMI Input meaning HDMI Input is shown in PIP mode by default.

Expected Output Details

PIP|Get|1 PIP mode is enabled for HDMI Input

PIP|Get|0 PIP mode is disabled for HDMI Input

SET

DESCRIPTION: This parameter enables/disables the PIP mode for an HDMI Input. User pass-es 1 or 0 to enable or disable PIP mode in parameter P2.

Value for P2 Details

1 To enable PIP mode for HDMI Input

0 To disable PIP mode for HDMI Input

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PIP</Cmd><P1>Set</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: PIP|Set|1EXPLANATION: 1 in the output shows the command was successful and the mode for HDMI Input set successfully.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error51 Unable to set PIP mode.

Error52 PIP mode already on.

Error53 Unable to set PIP mode.

Error54 PIP mode already off.

Page 24: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

22 V I A C o l l a g e A P I C o m m a n d s

PRSMODEDESCRIPTION: This command checks the status of Presentation Mode and enables or dis-ables the Presentation Mode on VIA Collage.

GET

DESCRIPTION: This parameter gets the status of Presentation mode.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PrsMode</Cmd><P1>Get</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: PrsMode|Get|<status of Presentation mode>OUTPUT: PrsMode|Get|0EXPLANATION: 0 shows presentation mode is not enabled at this point of time.

Expected Output Details

PrsMode|Get|1 Presentation mode is enabled

PrsMode|Get|0 Presentation mode is disabled

SET

DESCRIPTION: This parameter enables / disables Presentation mode for VIA Collage. The user passes 1/0 to enable/disable Presentation mode in parameter P2.

Value for P2 Description

1 To enable Presentation mode

0 To disable Presentation mode

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PrsMode</Cmd><P1>Set</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: PrsMode|Set|1EXPLANATION: 1 in output shows command run successfully and presentation mode is enabled now.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error61 Unable to set Presentation mode.

Error62 Presentation mode already on.

Error63 Unable to set Presentation mode.

Error64 Presentation mode already off.

Page 25: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

23V I A C o l l a g e A P I C o m m a n d s

MEDIAMODEDESCRIPTION: This command checks the status of Media mode. User can set Media mode for VIA Collage using these commands.

GET

DESCRIPTION: Parameter P1 checks the status of Media mode. COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>MediaMode</Cmd><P1>Get</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: MediaMode|Get|<status of Media mode>OUTPUT: MediaMode|Get|0EXPLANATION: 0 in the output shows media mode is not presently enabled.

Expected Output Details

MediaMode|Get|1 Media mode is presently enabled

MediaMode|Get|0 Media mode is presently disabled

SET

DESCRIPTION: Parameter P1 enables/disables Media Mode for VIA Collage. The user passes 1/0 to enable/disable Media mode in parameter P2.

Value for P2 Details

1 To enable Media mode

0 To disable Media mode

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>MediaMode</Cmd><P1>Set</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: MediaMode|Set|1EXPLANATION: 1 in the output shows command ran successfully and the media mode is set as enable/disable.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error66 Unable to set Media mode.

Error67 Media mode already on.

Error68 Unable to set Media mode.

Error69 Media mode already off.

Page 26: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

24 V I A C o l l a g e A P I C o m m a n d s

LOGDescription: This command checks the status of Log mode. The user can enable/disable Log mode using these commands.

GET

DESCRIPTION: Parameter P1 returns the status of Log mode if it is enabled or disabled.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Log</Cmd><P1>Get</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>Expected Output: Log|Get|<status of Log mode>Output: Log|Get|0EXPLANATION: 0 in the output shows Log mode is not presently enabled.

Expected Output Details

Log|Get|1 Log mode is presently enabled

Log|Get|0 Log mode is presently disabled

SET

DESCRIPTION: Parameter P1 enables/disables Log mode for VIA Collage. User passes 1/0 to enable/disable Log mode in parameter P2.

Value for P2 Details

1 To enable Log mode

0 To disable Log mode

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Log</Cmd><P1>Set</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Log|Set|1EXPLANATION:

1 in the output shows command ran successfully and log mode is enabled/disabled.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error56 Unable to set log mode.

Error56 Log mode already on.

Error56 Unable to set log mode.

Error56 Log mode already off.

Page 27: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

25V I A C o l l a g e A P I C o m m a n d s

QUICKLAUNCHDESCRIPTION: This command checks the status of Quick Client Access. The user can also enable/disable Quick Client Access using this command.

GET

DESCRIPTION: Parameter P1 returns the status of Quick Client Access whether it is enabled or disabled.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>QuickLaunch</Cmd><P1>Get</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: QuickLaunch|Get|<status of QuickLaunch>OUTPUT: QuickLaunch|Get|1EXPLANATION: 1 in the output shows Quick Client Access is presently enabled and is dis-played at the VIA Collage unit.

Expected Output Details

QuickLaunch|Get|1 Quick Client Access is presently enabled

QuickLaunch|Get|0 Quick Client Access is presently disabled

SET

Description: Parameter P1 enables/disables Quick Launch for VIA Collage. The user passes 1/0 to enable/disable Quick Launch in parameter P2.

Value for P2 Details

1 To enable Quick Client Access

0 To disable Quick Client Access

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>QuickLaunch</Cmd><P1>Set</P1><P2>1</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: QuickLaunch|Set|1EXPLANATION: 1 in the output shows command ran successfully and Quick Client Access is enabled /disabled now.

ERROR

Invalid command values return the following errors:

Error Code Error Code Description

Error76 Unable to set Quick Launch mode.

Error77 Quick Launch mode already on.

Error78 Unable to set Quick Launch mode.

Error79 Quick Launch mode already off.

Page 28: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

26 V I A C o l l a g e A P I C o m m a n d s

RESETDESCRIPTION: This command resets the VIA Collage unit. Use this command in conditions when VIA Collage becomes unresponsive and appears to not do anything in the background. To avoid restarting the whole unit, a soft reset can be performed for VIA Collage to rollback to defaults.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Reset</Cmd><P1></P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Reset|1EXPLANATION: 1 in the output shows command ran successfully and VIA Collage has been reset.

Page 29: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

27V I A C o l l a g e A P I C o m m a n d s

REBOOTDESCRIPTION: This command reboots the VIA Collage unit. COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Reboot</Cmd><P1></P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Reboot|1EXPLANATION: 1 in the output shows the command ran successfully and the VIA Collage unit is rebooting.

POWEROFF

DESCRIPTION: This command shuts down the VIA Collage unit. COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PowerOff</Cmd><P1></P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: PowerOff|1EXPLANATION: 1 in the output shows command ran successfully and the VIA Collage unit is shutting down now.

ERROR

Common Error Output if the command contains any invalid information about Username and Password:

Error Code Error Code Description

Error11 Command does not contain Username.

Error12 User is not authorized.

Error13 Wrong Username and password.

P.S. Reboot the VIA Collage unit after changes are made in Settings i.e. Room Code, Room name, PIP mode, Presentation mode, Media Mode etc. You can set multiple settings and then reboot once to make sure all are applied correctly.

Page 30: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

28 V I A C o l l a g e A P I C o m m a n d s

SCREENSHARE

ON

DESCRIPTION: This command sends VIA Collage display to all client displays.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>ScreenShare</Cmd><P1>On</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: ScreenShare|On|1EXPLANATION: Screen share has been switched ‘on’ and VIA Collage display is now sent to all client displays

OFF

DESCRIPTION: This command stops viewing of VIA Collage display, on all client displays, only if it is a result of the above ‘ON’ command.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>ScreenShare</Cmd><P1>Off</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: ScreenShare|Off|1EXPLANATION: Screen share was switched ‘off’ and the VIA Collage display is not sent to all client displays.

ERROR

There are no errors associated with this command. If screen share is enabled and is on every client screen, sending the On command again does nothing.

Page 31: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

29V I A C o l l a g e A P I C o m m a n d s

WHITEBOARDDESCRIPTION: This command opens a whiteboard on VIA Collage display for everyone to annotate.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>WhiteBoard</Cmd><P1>On</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: WhiteBoard|On|1EXPLANATION: WhiteBoard is running on VIA Collage display.

ERROR

There is no command to close the whiteboard, as users might want to save the annotations. How-ever, if the parameter P1 contains any other value except ‘On’, the following is the output seen:WhiteBoard|On|Error15

Page 32: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

30 V I A C o l l a g e A P I C o m m a n d s

GETTPAPPDESCRIPTION: This command gets the list of all the third party applications installed on gate-way. It does not include inbuilt applications like Skype, Lync and GoToMeeting. Run this command before the launch command, to verify the applications installed and their names.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>GetTPApp</Cmd><P1></P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: GetTPApp|Calculator#Drop Box#Excel Sheet#MS Paint#Note Pad#Pre-sentation#WMP#Word #vlc playerEXPLANATION: All application names are seen. These applications were added as third party applications.

ERROR

If there are no apps installed on the VIA Collage gateway, an error 115 is displayed in the following format:GetTPApp|Error115

Page 33: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

31V I A C o l l a g e A P I C o m m a n d s

LAUNCHDESCRIPTION: This set of commands launches the targeted third party application installed on the gateway.

THIRD PARTY APPLICATION

DESCRIPTION: This command looks for and launches the application listed under third party apps. Here parameter P1 is zero and parameter P2 is the third party application name.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Launch</Cmd><P1>0</P1><P2>Cal-culator</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Calculator starts on VIA Collage gateway.

ERROR

Error code Error Code Description

121 Third Party App does not exist.

SKYPE

DESCRIPTION: This command looks for and launches Skype. Here parameter P1 is 1 and parameters P2 through P10 are blank.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Launch</Cmd><P1>1</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Skype starts on VIA Collage gateway.

LYNC

DESCRIPTION: This command looks for and launches Lync. Here again parameter P1 is 2 and parameters P2 through P10 are blank.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Launch</Cmd><P1>2</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Lync starts on VIA Collage gateway.

GOTOMEETING

DESCRIPTION: This command looks for and launches GoToMeeting. Here again parameter P1 should be three and parameters P2 through P10 should be blank.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Launch</Cmd><P1>3</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: GoToMeeting starts on VIA Collage gateway.

BROWSER

DESCRIPTION: This command looks for and launches Internet Explorer. Here parameter P1 is 4 and parameter P2 contains a URL of the Web site to open. If this parameter is left blank, Internet Explorer still launches but opens the home page.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Launch</Cmd><P1>4</P1><P2>w-ww.google.com</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Internet Explorer opens with the specified website on VIA Collage gateway.

Page 34: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

32 V I A C o l l a g e A P I C o m m a n d s

CONTROLDESCRIPTION: This command enables or disables the option to control a user’s computer from the gateway. Parameter P1 is set to 0 or 1, to disable or enable control of user’s computer. Parameter P2 contains the user’s name to disable or enable.

ENABLE CONTROL

DESCRIPTION: This command enables the option to control a user’s computer from the gate-way. Set Parameter P1 to 1 to enable control of user’s computer. Set Parameter P2 to the user’s name whose control is to be enabled.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Control</Cmd><P1>1</P1><P2>-jolly</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: User jolly’s computer can now be accessed from gateway.

ERROR

Error Code Error Code Description

112 Permission to be controlled has already been granted.

113 Participant on iPad or a Tablet device.

114 Participant not in display (not stepped-in)

DISABLE CONTROL

DESCRIPTION: This command disables the option to control a user’s computer from the gate-way. Set Parameter P1 to 0 to disable control of user’s computer. Parameter P2 contains the user’s name whose control is to be disabled.

COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>Control</Cmd><P1>0</P1><P2>-jolly</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: User jolly’s computer cannot be accessed from the gateway now.

ERROR

Error Code Error Code Description

111 Permission to be controlled has already been revoked.

113 Participant on iPad or a Tablet device.

114 Participant not in display (not stepped-in)

Page 35: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

33V I A C o l l a g e A P I C o m m a n d s

SUPDATEDESCRIPTION: This command starts the procedure of updating the VIA Collage software.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>SUpdate</Cmd><P1>C:\update.exe</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>Expected Output: SUpdate|<Status>EXPLANATION: If the update is successful, it returns:SUpdate|1elseSUpdate|0

Page 36: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

34 V I A C o l l a g e A P I C o m m a n d s

UPDATEDESCRIPTION: This ongoing process gives updates pertaining to the users logged in and their status, if any user logs in, logs out, takes the display or requests the display. This is not a com-mand that runs, but reads the updates given by the gateway. Update is shown as follows with the list of Output Value and a detailed description of each:

Command Update Parameter Output Value Description

PList UP cnt Incremental New User logged into VIA Collage

PList UP User Name 1 This user login into VIA Collage

PList UP cnt Decremental User logged out from VIA Collage

PList UP User Name 0 This user logged out from VIA Collage

D i s p l a y Status

UP User Name 1 This user starts presentation at VIA Collage display

D i s p l a y Status

UP User Name 0 This user stops presenting at VIA Collage display

EXPECTED OUTPUT: PList|UP|cnt|<no. of Users>OUTPUT: PList|UP|cnt|3EXPLANATION: Update tells that a user is logged into VIA Collage and the total number of logged in users is 3.EXPECTED OUTPUT: PList|UP|<user name>|1OUTPUT: PList|UP|mike|1EXPLANATION: Update tells Mike is logged into VIA CollageEXPECTED OUTPUT: PList|UP|cnt|<no. of Users>OUTPUT: PList|UP|cnt|2EXPLANATION: Update shows a user is logged out from VIA Collage and now the total number of logged in users is 2.EXPECTED OUTPUT: PList|UP|<User name>|0OUTPUT: PList|UP|mike|0EXPLANATION: Update shows that mike is logged out from VIA CollageEXPECTED OUTPUT: DisplayStatus|UP|<User name>|1OUTPUT: DisplayStatus|UP|mike|1EXPLANATION: Update shows mike has started his presentation at VIA Collage display.EXPECTED OUTPUT: DisplayStatus|UP|<User name>|0OUTPUT: DisplayStatus|UP|mike|0EXPLANATION: Update shows mike has stopped presenting at VIA Collage display.

P.S. There can be multiple combinations of User Status and Display Status.

Page 37: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

35V I A C o l l a g e A P I C o m m a n d s

POWEROFFDESCRIPTION: This command shutSdown the VIA Collage unit. COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>PowerOff</Cmd><P1></P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: PowerOff|1EXPLANATION: ”1” in the output shows command run successfully and the VIA Collage unit has shutdown.

ERROR

Common Error Output if command contains any invalid information about Username and Password:

Error Code Error Code Description

Error11 Command does not contain Username

Error12 User is not authorized.

Error13 Wrong Username and password.

Note: Reboot the VIA Collage unit after any changes made in Settings i.e. Room Code, Room name, PIP mode, Presentation mode, Media Mode etc. You can set multiple settings and then reboot once to make sure all is applied correctly.

Page 38: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

36 V I A C o l l a g e A P I C o m m a n d s

DND (DO NOT DISTURB)DESCRIPTION: This command enables or disables DND mode on the gateway. Parameter P1 is sent as ‘set’ or ‘unset’ to activate or deactivate DND for the user mentioned in Parameter P2.

SET

DESCRIPTION: This command enables the DND mode on gateway. ‘Set’ is passed as Parameter P1 to enable DND for the user specified in parameter P2.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>DND</Cmd><P1>Set</P1><P2>-jolly</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Only the defined user can present on the gateway; everyone else’s Step-In button changes to View Main Display.

ERROR

Error Code Error Code Description

123 System is already in DND mode

124 User count greater than one. User not presenting

127 DND mode is not enabled

UNSET

DESCRIPTION: This command disables the DND mode on gateway. ‘UnSet’ is passed as Pa-rameter P1 to enable DND for a user specified in parameter P2.COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>DND</Cmd><P1>UnSet</P1><P2>-jolly</P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: DND is disabled for the selected user and everyone’s View Main Display changes to Step-In button.

ERROR

Error Code Error Code Description

125 System is already in non-DND mode

126User count greater than one. User not in presenting state. User is not same as the user who set the DND mode

127 DND Mode is not enabled

Page 39: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

37V I A C o l l a g e A P I C o m m a n d s

KICKOFFDESCRIPTION: This command removes any logged in user from gateway. User’s name is specified in parameter P1COMMAND: <P><UN>su</UN><Pwd></Pwd><Cmd>KickOff</Cmd><P1> jolly</P1><P2></P2><P3></P3><P4></P4><P5></P5><P6></P6><P7></P7><P8></P8><P9></P9><P10></P10></P>EXPECTED OUTPUT: Jolly is logged out from gateway and room code is changed

ERROR

Error Code Error Code Description

UsrNotExist User does not exist

Page 40: VIA Collage API Commands - Kramer Electronics · VIA Collage unit must be connected to a network and must be accessible through a Windows or a Mac computer. To ensure and test if

Kramer Electronics LTD.

www.True-Collaboration.com