AMX DTV VISION2 INTEGRATION - DIAGRAM Parts list manual

Operation/Reference Guide
Video Management/Distribution
Vision2
API Guide
Initial Release: 11/14/2011
Vision2API Guide

AMX Limited Warranty and Disclaimer
This Limited Warranty and Disclaimer extends only to products purchased directly from AMX or an AMX Authorized Partner which
include AMX Dealers, Distributors, VIP’s or other AMX authorized entity.
AMX warrants its products to be free of defects in material and workmanship under normal use for three (3) years from the date of
purchase, with the following exceptions:
• Electroluminescent and LCD Control Panels are warranted for three (3) years, except for the display and touch overlay compo-
nents are warranted for a period of one (1) year.
• Disk drive mechanisms, pan/tilt heads, power supplies, and MX Series products are warranted for a period of one (1) year.
• AMX lighting products are guaranteed to switch on and off any load that is properly connected to our lighting products, as long
as the AMX lighting products are under warranty. AMX also guarantees the control of dimmable loads that are properly con-
nected to our lighting products. The dimming performance or quality there of is not guaranteed, impart due to the random combi-
nations of dimmers, lamps and ballasts or transformers.
• AMX software is warranted for a period of ninety (90) days.
• Batteries and incandescent lamps are not covered under the warranty.
• AMX AutoPatch Epica, Modula, Modula Series4, Modula CatPro Series and 8Y-3000 product models will be free of defects in
materials and manufacture at the time of sale and will remain in good working order for a period of three (3) years following the
date of the original sales invoice from AMX. The three-year warranty period will be extended to the life of the product (Limited
Lifetime Warranty) if the warranty card is filled out by the dealer and/or end user and returned to AMX so that AMX receives it
within thirty (30) days of the installation of equipment but no later than six (6) months from original AMX sales invoice date. The
life of the product extends until five (5) years after AMX ceases manufacturing the product model. The Limited Lifetime Warranty
applies to products in their original installation only. If a product is moved to a different installation, the Limited Lifetime Warranty
will no longer apply, and the product warranty will instead be the three (3) year Limited Warranty.
All products returned to AMX require a Return Material Authorization (RMA) number. The RMA number is obtained from the AMX
RMA Department. The RMA number must be clearly marked on the outside of each box. The RMA is valid for a 30-day period. After
the 30-day period the RMA will be cancelled. Any shipments received not consistent with the RMA, or after the RMA is cancelled, will
be refused. AMX is not responsible for products returned without a valid RMA number.
AMX is not liable for any damages caused by its products or for the failure of its products to perform. This includes any lost profits, lost
savings, incidental damages, or consequential damages. AMX is not liable for any claim made by a third party or by an AMX Autho-
rized Partner for a third party.
This Limited Warranty does not apply to (a) any AMX product that has been modified, altered or repaired by an unauthorized agent or
improperly transported, stored, installed, used, or maintained; (b) damage caused by acts of nature, including flood, erosion, or earth-
quake; (c) damage caused by a sustained low or high voltage situation or by a low or high voltage disturbance, including brownouts,
sags, spikes, or power outages; or (d) damage caused by war, vandalism, theft, depletion, or obsolescence.
This limitation of liability applies whether damages are sought, or a claim is made, under this warranty or as a tort claim (including
negligence and strict product liability), a contract claim, or any other claim. This limitation of liability cannot be waived or amended by
any person. This limitation of liability will be effective even if AMX or an authorized representative of AMX has been advised of the
possibility of any such damages. This limitation of liability, however, will not apply to claims for personal injury.
Some states do not allow a limitation of how long an implied warranty last. Some states do not allow the limitation or exclusion of inci-
dental or consequential damages for consumer products. In such states, the limitation or exclusion of the Limited Warranty may not
apply. This Limited Warranty gives the owner specific legal rights. The owner may also have other rights that vary from state to state.
The owner is advised to consult applicable state laws for full determination of rights.
EXCEPT AS EXPRESSLY SET FORTH IN THIS WARRANTY, AMX MAKES NO OTHER WARRANTIES, EXPRESSED OR
IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. AMX
EXPRESSLY DISCLAIMS ALL WARRANTIES NOT STATED IN THIS LIMITED WARRANTY. ANY IMPLIED WARRANTIES THAT
MAY BE IMPOSED BY LAW ARE LIMITED TO THE TERMS OF THIS LIMITED WARRANTY. EXCEPT AS OTHERWISE LIMITED
BY APPLICABLE LAW, AMX RESERVES THE RIGHT TO MODIFY OR DISCONTINUE DESIGNS, SPECIFICATIONS, WARRAN-
TIES, PRICES, AND POLICIES WITHOUT NOTICE.

AMX Software License and Warranty Agreement
• LICENSE GRANT. AMX grants to Licensee the non-exclusive right to use the AMX Software in the manner described in this
License. The AMX Software is licensed, not sold. This license does not grant Licensee the right to create derivative works of the
AMX Software. The AMX Software consists of generally available programming and development software, product documenta-
tion, sample applications, tools and utilities, and miscellaneous technical information. Please refer to the README.TXT file on
the compact disc or download for further information regarding the components of the AMX Software. The AMX Software is sub-
ject to restrictions on distribution described in this License Agreement. AMX Dealer, Distributor, VIP or other AMX authorized
entity shall not, and shall not permit any other person to, disclose, display, loan, publish, transfer (whether by sale, assignment,
exchange, gift, operation of law or otherwise), license, sublicense, copy, or otherwise disseminate the AMX Software. Licensee
may not reverse engineer, decompile, or disassemble the AMX Software.
• ACKNOWLEDGEMENT. You hereby acknowledge that you are an authorized AMX dealer, distributor, VIP or other AMX autho-
rized entity in good standing and have the right to enter into and be bound by the terms of this Agreement.
• INTELLECTUAL PROPERTY. The AMX Software is owned by AMX and is protected by United States copyright laws, patent
laws, international treaty provisions, and/or state of Texas trade secret laws. Licensee may make copies of the AMX Software
solely for backup or archival purposes. Licensee may not copy the written materials accompanying the AMX Software.
• TERMINATION. AMX RESERVES THE RIGHT, IN ITS SOLE DISCRETION, TO TERMINATE THIS LICENSE FOR ANY REA-
SON UPON WRITTEN NOTICE TO LICENSEE. In the event that AMX terminates this License, the Licensee shall return or
destroy all originals and copies of the AMX Software to AMX and certify in writing that all originals and copies have been
returned or destroyed.
• PRE-RELEASE CODE. Portions of the AMX Software may, from time to time, as identified in the AMX Software, include PRE-
RELEASE CODE and such code may not be at the level of performance, compatibility and functionality of the GA code. The
PRE-RELEASE CODE may not operate correctly and may be substantially modified prior to final release or certain features may
not be generally released. AMX is not obligated to make or support any PRE-RELEASE CODE. ALL PRE-RELEASE CODE IS
PROVIDED "AS IS" WITH NO WARRANTIES.
• LIMITED WARRANTY. AMX warrants that the AMX Software (other than pre-release code) will perform substantially in accor-
dance with the accompanying written materials for a period of ninety (90) days from the date of receipt. AMX DISCLAIMS ALL
OTHER WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WITH REGARD TO THE AMX SOFTWARE. THIS LIM-
ITED WARRANTY GIVES LICENSEE SPECIFIC LEGAL RIGHTS. Any supplements or updates to the AMX SOFTWARE,
including without limitation, any (if any) service packs or hot fixes provided to Licensee after the expiration of the ninety (90) day
Limited Warranty period are not covered by any warranty or condition, express, implied or statutory.
• LICENSEE REMEDIES. AMX's entire liability and Licensee's exclusive remedy shall be repair or replacement of the AMX Soft-
ware that does not meet AMX's Limited Warranty and which is returned to AMX in accordance with AMX's current return policy.
This Limited Warranty is void if failure of the AMX Software has resulted from accident, abuse, or misapplication. Any replace-
ment AMX Software will be warranted for the remainder of the original warranty period or thirty (30) days, whichever is longer.
Outside the United States, these remedies may not available. NO LIABILITY FOR CONSEQUENTIAL DAMAGES. IN NO
EVENT SHALL AMX BE LIABLE FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES
FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR ANY OTHER
PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THIS AMX SOFTWARE, EVEN IF AMX HAS
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME STATES/COUNTRIES DO NOT ALLOW
THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE LIMITA-
TION MAY NOT APPLY TO LICENSEE.
• U.S. GOVERNMENT RESTRICTED RIGHTS. The AMX Software is provided with RESTRICTED RIGHTS. Use, duplication, or
disclosure by the Government is subject to restrictions as set forth in subparagraph ©(1)(ii) of The Rights in Technical Data and
Computer Software clause at DFARS 252.227-7013 or subparagraphs ©(1) and (2) of the Commercial Computer Software
Restricted Rights at 48 CFR 52.227-19, as applicable.
• SOFTWARE AND OTHER MATERIALS FROM AMX.COM MAY BE SUBJECT TO EXPORT CONTROL. The United States
Export Control laws prohibit the export of certain technical data and software to certain territories. No software from this Site may
be downloaded or exported (i) into (or to a national or resident of) Cuba, Iraq, Libya, North Korea, Iran, Syria, or any other coun-
try to which the United States has embargoed goods; or (ii) anyone on the United States Treasury Department's list of Specially
Designated Nationals or the U.S. Commerce Department's Table of Deny Orders. AMX does not authorize the downloading or
exporting of any software or technical data from this site to any jurisdiction prohibited by the United States Export Laws.
This Agreement replaces and supersedes all previous AMX Software License Agreements and is governed by the laws of
the State of Texas, and all disputes will be resolved in the courts in Collin County, Texas, USA. For any questions concern-
ing this Agreement, or to contact AMX for any reason, please write: AMX License and Warranty Department, 3000 Research
Drive, Richardson, TX 75082.

Table of Contents
i
Vision2Operation/Reference Guide
Table of Contents
Using the API ......................................................................................................1
Controlling the Amino Set-Top Box .......................................................................... 1
Forcing a Set-Top Box to Play a Specific Live Channel.................................................... 1
Forcing a Specific Set-Top Box to Play a Specific Video ................................................. 2
Enabling and Disabling Live Channels....................................................................... 3
Enabling IIS Security for the Administrator API ........................................................ 4
Enabling Devices Which Do Not Support Windows Authentication ......................... 4
API Commands ...................................................................................................7
Main Control API ...................................................................................................... 7
Accessing Video On Demand Content...................................................................... 7
Archive Commands ................................................................................................... 8
v2Archive_DeleteVideo................................................................................................... 8
v2Archive_GetDiskSpace ................................................................................................ 8
v2Archive_GetLastUpdateTime ....................................................................................... 8
Master Commands.................................................................................................... 9
v2Master_STB_Amino_GetSTBs ...................................................................................... 9
v2Master_STB_Amino_GetSTBsByFirstLetterInName.................................................... 10
v2Master_STB_Amino_GetStatus .................................................................................. 11
v2Master_STB_Amino_GoBack...................................................................................... 11
v2Master_STB_Amino_SetLiveChannelByID .................................................................. 12
v2Master_STB_Amino_SetLiveChannel ......................................................................... 12
v2Master_STB_Amino_SetLiveChannel_Multi................................................................ 13
v2Master_STB_Amino_PlayVideo .................................................................................. 13
v2Master_STB_Amino_SetARC...................................................................................... 13
v2Master_STB_Amino_SendRS232................................................................................ 14
v2Master_GetListOfServers .......................................................................................... 14
v2Master_GetFullChannelList........................................................................................ 15
v2Master_GetDiagnostics ............................................................................................. 16
v2Master_GetAPIVersion .............................................................................................. 17
v2Master_GetListOfServices ......................................................................................... 18
v2Master_GetListOfServices_NameAndIDOnly............................................................. 19
v2Master_GetServiceXML ............................................................................................. 19
v2Master_GetLiveChannelList ....................................................................................... 20
v2Master_GetLiveChannelListLastUpdateTime ............................................................. 20
Live Commands....................................................................................................... 21
v2Live_StartMPEGEncoder ........................................................................................... 21
v2Live_StopMPEGEncoder............................................................................................ 21

ii Vision2Operation/Reference Guide
Table of Contents
v2Live_StartWMVEncoder ............................................................................................. 22
v2Live_StopWMVEncoder ............................................................................................. 22
V2Live_GetEncoderStatus ............................................................................................. 22
Producer Commands............................................................................................... 23
v2Producer_GetSchedule .............................................................................................. 23
v2Producer_GetSettings ............................................................................................... 25
v2Producer_SetParameters ........................................................................................... 26
v2Producer_StartBroadcast........................................................................................... 27
v2Producer_StopBroadcast ........................................................................................... 27
Record Commands.................................................................................................. 28
v2Record_GetSettings................................................................................................... 28
v2Record_SetParameters .............................................................................................. 30
v2Record_StartRecording.............................................................................................. 30
v2Record_StopRecording.............................................................................................. 31
v2Record_CancelRecording........................................................................................... 31
v2Record_RestartRecording .......................................................................................... 31
Reflector Commands............................................................................................... 32
v2Reflector_GetSettings ............................................................................................... 32
v2Reflector_SetParameters ........................................................................................... 33
v2Reflector_StartBroadcast........................................................................................... 34
v2Reflector_StopBroadcast ........................................................................................... 34
DVB Commands ...................................................................................................... 35
v2DVB_StartBroadcast .................................................................................................. 35
v2DVB_StopBroadcast .................................................................................................. 35
Vision2 RenderThumbs Explorer ......................................................................37
Initial Requests........................................................................................................ 38
Handling Search Thumbnails................................................................................... 43
Playing a Video ....................................................................................................... 43

Using the API
1
Vision2API Guide
Using the API
The control API for Vision2enables external control of the system. The control API is accessible from the
Master server in the Vision2system, and the Vision2system manages sending subsequent requests to other
servers in the system. A programmer using the API should not have to know which server to send an API
request to, as all requests go to the Master server.
Controlling the Amino Set-Top Box
The following sections detail how to use the Vision2control API with the Amino set-top box.
Forcing a Set-Top Box to Play a Specific Live Channel
Before using the API, you must first obtain a list of available set-top boxes using the
v2Master_STB_Amino_GetSTBs command. This command is used by accessing a Vision2server from a web
browser. For example, the command can be used in the following URL:
http://<server>/v2services/v2_API/v2_APIAdminService.asmx/v2Master_STB_Amino_GetSTBs
where <server> is the name of the Master server. This command returns XML code similar to the following:
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
<stbs localip="43.192.168.100">
<stb
name="Main Reception"
status="playing video on demand"
playing="Welcome to AMX"
playingraw="rtsp://43.192.168.100:8554/
H:\vcContent\Archive1\1500\68\ts\high\Video.ts"
ip="43.192.168.110"
pending="nothing"
pendingparams="-1"
screensaver="0"
arc="true" />
<stb
name="Board Room"
status="idle"
playing=" "
playingraw=" "
ip="43.192.168.111"
pending="nothing"
pendingparams="-1"
screensaver="0"
arc="true" />
</stbs>
</v2>
From this XML code, all you need to extract is the name and IP attributes to provide a means of selecting the
desired STB:
"Main Reception" = "43.192.168.110"
"Board Room" = "43.192.168.111"

Using the API
2Vision2API Guide
Next, you must obtain a list of live channels which the Amino can play by using the
v2Master_GetLiveChannelList command. For example:
http://<server>/v2services/v2_API/v2_APIUserService.asmx/v2Master_GetLiveChannelList
?sWantWMV=false&sWantMPEG2=true&sWantH264=true
This command returns XML code similar to the following:
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
<livechannels>
<channel
type="v2DVB"
id="9018:16384:17024"
name="BBC Parliament"
address="234.1.0.2"
port="5500"
url="videocastmcast://234.1.0.2:5500/BBC Parliament"
level="0"
unmanaged="no"
/>
<channel
type="v2DVB"
id="9018:16384:17023"
name="BBC One"
address="234.1.0.3"
port="5500"
url="videocastmcast://234.1.0.3:5500/BBC One"
level="0"
unmanaged="no"
/>
</livechannels>
<secure>true</secure>
</v2>
From this code, all you need to extract is the name attribute to provide a means of selecting the desired
channel:
"BBC Parliament"
"BBC One"
For illustration purposes, assume the user selects "Main Reception" set-top box and the "BBC One" channel.
The user must then to make the change call to the v2Master_STB_Amino_SetLiveChannel command. For
example:
http://<server>/v2services/v2_API/v2_APIAdminService.asmx/v2Master_STB_Amino_SetLiveChannel

?sSTBIPAddress=43.192.168.110&sChannelIndex =1
Forcing a Specific Set-Top Box to Play a Specific Video
Obtain a list of the available set-top boxes as described in the Forcing a Set-Top Box to Play a Specific Live
Channel section on page 1. Next, you need to provide functionality to enable the user to choose the video to
play. See the Vision2 RenderThumbs Explorer section on page 37 for information on how to create a user
interface to play a video.
When the user has selected the video to play, you must then use to the v2Master_STB_Amino_PlayVideo
command to start playback. For example:
http://server/v2services/v2_API/v2_APIAdminService.asmx/ v2Master_STB_Amino_PlayVideo
?sSTBIPAddress=43.192.168.110&sArchiveID=201101020304&sVideoID=150002

Using the API
3
Vision2API Guide
Enabling and Disabling Live Channels
To control which channels are broadcasting on a Vision2system the first thing you need is a list of all the
available channels which can be found using the v2Master_GetFullChannelList command. For example:
http://server/v2services/v2_API/v2_APIAdminService.asmx/v2Master_GetFullChannelList
This command returns XML code similar to the following:
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
<channels>
<channel
type="v2DVB"
name="BBC THREE"
id="9018:4100:4351"
transmitting="false" />
<channel
type="v2DVB"
name="BBC NEWS"
id="9018:4100:4415"
transmitting="true" />
<channel
type="v2Live"
name="MPEG Encoder"
id="20110014111920046"
transmitting="false" />
<channel
type="v2Producer"
name="Producer MPEG 1"
id="20110014111920687"
transmitting="false" />
<channel
type="v2ReflectorWMV"
name="WMV Reflector 1"
id="20110014111921218"
transmitting="true" />
<channel
type="v2ProducerWMV"
name="Producer WMV 1"
id="20110014111921593"
transmitting="false" />
</channels>
</v2>
You can then convert this code into a list from which the user can select a channel and change the transmitting
status as necessary, depending on the channel type you need to make the correct call.

Using the API
4Vision2API Guide
Enabling IIS Security for the Administrator API
With IIS security enabled, a block of code attempting to access an API function will require an Administrator
log in. Perform the following steps to enable IIS security for the Administrative API:
1. On the Master Server, click the following path: Start Menu > Administrative Tools > Internet Information
Services (IIS) Manager. The Internet Information Services (IIS) Manager opens.
2. In the tree view on the left pane, navigate to server name > Web Sites > Default Web Site > v2Services >
V2_API.
3. In the right pane, right-click v2_APIAdminService.asmx and select Properties.
4. Select the File Security tab.
5. In the Authentication and access control section, click Edit.
6. In the Authentication Methods dialog box, uncheck Enable anonymous access, and click OK.
7. Click Apply, then click OK to close the window.
Enabling Devices Which Do Not Support Windows
Authentication
For devices which do not support Windows authentication (such as a NetLinx device), calls must be made to a
proxy web service which impersonates a known user. For example, rather than calling the IIS-protected
function at the following address:
http://<server name>/v2Services/v2_API/v2_APIAdminService.asmx/v2Master_GetListOfServices? 
sServiceType=v2Archive
instead, call the proxy web service at an address like the following:
http://<server name>/v2Services/v2_API/v2_AdminProxy.aspx?ReturnXML=v2Master_GetListOfServices?

sServiceType=v2Archive
When the call is made to the proxy web service, a check is performed to see whether the MAC address that
made the call is on a White List. If the MAC Address has not been enabled in the White List, an error message
returns noting that the MAC address has not been validated.
This change only needs to be made on the Master server.
All calls to the API can be proxied in this manner.

Using the API
5
Vision2API Guide
To configure the White List on the server open the following file at the following location:
C:\Inetpub\wwwroot\v2Services\v2_API
Opening the file displays code similar to the following:
<?xml version="1.0" encoding="utf-8"?>
<list user="" pass="">
</list>
Edit the username and password settings to the Administrator login for the server.
When a new device attempts to make a proxy call and its MAC address does not exist in the list, an error
message returns. If the device attempts another call, the proxy replies with another error message that the
MAC address is in the White List, but has not yet been validated.
At this stage, the WhiteList.xml file should contain a new entry like the following:
<allow mac="00:1B:38:0A:10:E1" ip="43.192.168.101" validated="false" />
Change validated="false" to validated="true" to allow this device access to the Administrator API.
The IP address is recorded to help with identification only, it is the MAC address that
is tested.

Using the API
6Vision2API Guide

API Commands
7
Vision2API Guide
API Commands
Main Control API
The main control API consists of a standard XML based web service. An interactive means of testing the API
is available at:
http://_server_name_/v2Services/v2_API/v2_APIAdminService.asmx
Accessing Video On Demand Content
The Vision2RenderThumbs Explorer is available as a way of simplifying user access to content from a Vision2
archive. The Vision2RenderThumbs Explorer provides the following advantages:
Much simpler than rolling your own user interface
Single call provides either data or a rendered user interface as an image
Data is available as either XML or JSON
Rendered user interface is template to provide both customization and uniformity
Even if you do need a custom user interface, the returned XML | JSON is much easier to process
than accessing the raw content.
This API is used to provide the user interface for the new Amino 140H STB and for the new Tablet PC support
for Vision2. See the Vision2 RenderThumbs Explorer section on page 37 for information.

API Commands
8Vision2API Guide
Archive Commands
The following section lists the API commands available for the Archive service.
v2Archive_DeleteVideo
Deletes the specified video from the specified archive.
v2Archive_GetDiskSpace
Obtains the free and used space on the disk being used by the specified archive.
v2Archive_GetLastUpdateTime
Obtain the date and time that the specified archive was last updated.
Parameters
sArchiveID The ID of the Archive containing the video
sVideoID The ID of the video to be deleted
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
</v2>
PRGM EX. 1 v2Archive_DeleteVideo Sample XML
Parameters
sServiceID The service ID of the Vision2archive
<v2>
<result>OK</result>
<freespace>
<entry label="Free Space 59.02 GBytes" data="59.0183" />
<entry label="Used Space 406.74 GBytes" data="406.741" />
</freespace>
</v2>
PRGM EX. 2 v2Archive_GetDiskSpace Return XML
The data values are always returned in Gigabytes.
Parameters
sServiceID The service ID of the Vision2archive

API Commands
9
Vision2API Guide
Master Commands
The following section lists the API commands available for the Master.
v2Master_STB_Amino_GetSTBs
Get an XML list of all of the Set-Top Boxes.
Sample URL:
http://server/v2services/v2_API/v2_APIAdminService.asmx/v2Master_STB_Amino_GetSTBs
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
<stbs localip="43.192.168.100">
<stb
name="Main Reception"
status="playing video on demand"
playing="Welcome to AMX"
playingraw="rtsp://43.192.168.100:8554/
H:\vcContent\Archive1\1500\68\ts\high\Video.ts"
ip="43.192.168.110"
pending="nothing"
pendingparams="-1"
screensaver="0"
arc="true" />
<stb
name="Board Room"
status="idle"
playing=" "
playingraw=" "
ip="43.192.168.111"
pending="nothing"
pendingparams="-1"
screensaver="0"
arc="true" />
</stbs>
</v2>
PRGM EX. 3 v2Master_STB_Amino_GetSTBs Sample XML
Program Attributes
name The name given to the STB in the management
UIstatus What the STB is currently doing. Can be "playing live channel", "playing video on
demand", or "idle".
playing If playing then the name of the video or live channel
playingraw The video URL currently being accessed
ip The IP Address of the STB
pending The remote command currently being processed. Can be ChangeChannel, PlayVOD, or
ARC.
Screensaver Not used
arc If true means the STB can Access Restricted Content

API Commands
10 Vision2API Guide
v2Master_STB_Amino_GetSTBsByFirstLetterInName
Get an XML list of all of the Set Top Boxes whose name begins with the letter specified. Note this call only
returns the STBs name and IP Address.
Sample URL
http://server/v2services/v2_API/v2_APIAdminService.asmx/
v2Master_STB_Amino_GetSTBsByFirstLetterInName?sStartLetter=c
Parameters
sStartLetter The start letter if the name. Case is ignored. If this is '*' then all STBs are returned
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
<stbs localip="43.192.168.100">
<stb name="Canteen" ip="43.192.168.111" />
<stb name="Common Area 1" ip="43.192.168.112" />
<stb name="Common Area 2" ip="43.192.168.113" />
</stbs>
</v2>
PRGM EX. 4 v2Master_STB_Amino_GetSTBsByFirstLetterInName Sample XML
Program Attributes
name The name given to the STB in the management UI
ip The IP Address of the STB

API Commands
11
Vision2API Guide
v2Master_STB_Amino_GetStatus
Obtains the current status of the STB specified by its IP Address
Sample URL
http://server/v2services/v2_API/v2_APIAdminService.asmx/
v2Master_STB_Amino_GetStatus?sSTBIPAddress=43.192.168.110
See the v2Master_STB_Amino_GetSTBs section on page 9 for an explanation of the returned XML.
v2Master_STB_Amino_GoBack
Forces the STB to return to what they were watching when a command was called with sBookmark=true
Sample URL
http://server/v2services/v2_API/v2_APIAdminService.asmx/v2Master_STB_Amino_GoBack
?sSTBIPAddress=43.192.168.110
Parameters
sSTBIPAddress The IP Address of the STB to obtain the status from
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
<stb
<stb
name="Main Reception"
status="playing video on demand"
playing="Toxic"
playingraw="rtsp://43.192.168.100:8554/
H:\vcContent\Archive1\1500\68\ts\high\Video.ts"ip="43.192.168.110"
ip="43.192.168.110"
pending="nothing"
pendingparams="-1"
screensaver="0"
arc="true" />
</v2>
PRGM EX. 5 v2Master_STB_Amino_GetStatus Sample XML
Parameters
sSTBIPAddress The IP Address of the STB to obtain the status from. If the IP Address is ‘ALLSTBS’ then
all the STBs on the system will be updated
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
</v2>
PRGM EX. 6 v2Master_STB_Amino_GoBack Sample XML

API Commands
12 Vision2API Guide
v2Master_STB_Amino_SetLiveChannelByID
Forces the STB to display the selected live channel
Sample URL
http://server/v2services/v2_API/v2_APIAdminService.asmx/v2Master_STB_Amino_SetLiveChannelByID
?sSTBIPAddress=43.192.168.110
&sChannelID= 20110701095642500
&sBookmark=false
v2Master_STB_Amino_SetLiveChannel
Forces the STB to display the selected live channel.
Sample URL:
http://server/v2services/v2_API/v2_APIAdminService.asmx/v2Master_STB_Amino_SetLiveChannel 
?sSTBIPAddress=43.192.168.110 
&sChannelIndex =2
Parameters
sSTBIPAddress The IP Address of the STB to obtain the status from. If the IP Address is ‘ALLSTBS’ then
all the STBs on the system will be updated
sChannelID The ID of the channel to play
sBookmark If 'true' then the current channel or VOD status is saved for later use by a call to
v2Master_STB_Amino_GoBack
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
</v2>
PRGM EX. 7 v2Master_STB_Amino_SetLiveChannelByID Sample XML
The list of suitable live channels can be obtained by calling
http://<servername>/v2Servers/v2_API/V2_APIAdminService.asmx
v2Master_GetLiveChannelList
?sWantWMV=false
&sWantMPEG2=true
&sWantH264=true
Parameters
sSTBIPAddress The IP Address of the STB to obtain the status from
sChannelIndex The index of the channel to play
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
</v2>
PRGM EX. 8 v2Master_STB_Amino_SetLiveChannel Sample XML
The list of suitable live channels can be obtained by calling http://<servername>/
v2Servers/v2_API/V2_APIAdminService.asmx/ v2Master_GetLiveChannelList

?sWantWMV=false 
&sWantMPEG2=true 
&sWantH264=true.

API Commands
13
Vision2API Guide
v2Master_STB_Amino_SetLiveChannel_Multi
Forces the selected STBs to display the selected live channel.
Sample URL:
http://server/v2services/v2_API/v2_APIAdminService.asmx/v2Master_STB_Amino_SetLiveChannel_Multi 
?sSTBIPAddresses=43.192.168.110 
&sChannelIndex =2
v2Master_STB_Amino_PlayVideo
Forces the STB to play a Video On Demand Title
Sample URL:
http://server/v2services/v2_API/v2_APIAdminService.asmx/
v2Master_STB_Amino_PlayVideo?sSTBIPAddress=43.192.168.110&s

ArchiveID=201101020304&sVideoID=150002
v2Master_STB_Amino_SetARC
Allows the defined STB to access content which has been restricted using the management interface.
Sample URL:
http://server/v2services/v2_API/v2_APIAdminService.asmx/
v2Master_STB_Amino_SetARC?sSTBIPAddress=43.192.168.110&s

ARCValue =true
Parameters
sSTBIPAddresses The IP Addresses of the STBs to obtain the status from
sChannelIndex The index of the channel to play
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
</v2>
PRGM EX. 9 v2Master_STB_Amino_SetLiveChannel_Multi Sample XML
Parameters
sSTBIPAddress The IP address of the STB to obtain the status from
sArchiveID The ID of the Archive Service on which the video resides
sVideoID The ID of the video to play
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
</v2>
PRGM EX. 10 v2Master_STB_Amino_PlayVideo Sample XML
Parameters
sSTBIPAddress The IP address of the STB to obtain the status from
sARCValue 'true' to allow access and 'false' to prevent access
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
</v2>
PRGM EX. 11 v2Master_STB_Amino_SetARC Sample XML

API Commands
14 Vision2API Guide
v2Master_STB_Amino_SendRS232
Send a string via RS-232 on the Amino140H (only) and wait for the reply.
Sample URL:
http://<server>/v2services/v2_API/v2_APIAdminService.asmx/
v2Master_STB_Amino_SendRS232?sSTBIPAddress=43.192.168.110

&sBaudRate =19200&sWantBinary=false&sData= ka 01 01\n
v2Master_GetListOfServers
Obtain a list of all of the Vision2 servers in the system and determine if they are online.
Parameters
sSTBIPAddress The IP address of the set-top box to obtain the status from
sBaudRate Must be 9600 or 19200
sWantBinary Must be false in this release
sData The string to send (note that \r and \n will be converted to actual ASCII and any escaped
characters (e.g. %03) will also be converted.)
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>a 01 OK01\n</result>
</v2>
PRGM EX. 12 v2Master_STB_Amino_SendRS232 Sample XML
<?xml version="1.0" encoding="utf-8" ?>
<v2>
<result>OK</result>
<servers>
<server
name="WIN2K3SERVER"
webserviceurl="http://WIN2K3SERVER/v2Services/"
online="true" />
<server
name="LENOVO"
webserviceurl="http://LENOVO/v2Services/"
online="false" />
</servers>
</v2>
PRGM EX. 13 v2Master_GetListOfServers Sample XML
If many of the Vision2Servers are offline then this call may take some time before it
returns as the system times-out trying to contact an offline server.