background image

O p e r a t i o n / R e f e r e n c e   G u i d e

V i d e o   M a n a g e m e n t / D i s t r i b u t i o n

Vision

2

API Guide

I n i t i a l   R e l e a s e :   1 1 / 1 4 / 2 0 1 1

Vision

2

 API Guide

Summary of Contents for DTV VISION2 INTEGRATION - DIAGRAM

Page 1: ...Operation Reference Guide Video Management Distribution Vision2 API Guide Initial Release 11 14 2011 Vision2 API Guide...

Page 2: ...ked 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 w...

Page 3: ...PLIED 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 A...

Page 4: ......

Page 5: ...tUpdateTime 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_SetLiveCha...

Page 6: ...t 27 Record Commands 28 v2Record_GetSettings 28 v2Record_SetParameters 30 v2Record_StartRecording 30 v2Record_StopRecording 31 v2Record_CancelRecording 31 v2Record_RestartRecording 31 Reflector Comman...

Page 7: ...and is used by accessing a Vision2 server 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 w...

Page 8: ...nel 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_Set...

Page 9: ...l 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 transmi...

Page 10: ...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...

Page 11: ...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 t...

Page 12: ...Using the API 6 Vision2 API Guide...

Page 13: ...erThumbs 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 eit...

Page 14: ...chive 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 v2Arc...

Page 15: ...3 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...

Page 16: ...BsByFirstLetterInName 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...

Page 17: ...Master_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 R...

Page 18: ...annelID 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...

Page 19: ...ervices 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 sChannel...

Page 20: ...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 versi...

Page 21: ...d 9018 4100 4164 transmitting true channel type v2DVB name 301 id 9018 4100 7168 transmitting false channel type v2 Live name MPEG Encoder id 20110014111920046 transmitting false channel type v2Produc...

Page 22: ...10_100 PCI TX NIC 3C905B TX Applian Miniport name connectionspeed 100000000 connectionspeed megabitsreceiving 0 megabitsreceiving megabitssending 0 megabitssending nic nic name Marvell Yukon 88E8050...

Page 23: ...oding utf 8 v2 result OK result version major 7 2 major autobuild 17955941 autobuild version secure true secure v2 PRGM EX 16 v2Master_GetAPIVersion Sample XML Secure is set true if Vision2 User Acces...

Page 24: ...g utf 8 v2 result OK result services service servicetype v2DVB id 20110014111919578 name DVB 1 tuner AMX DTV TX01 DVB T Multicast on NIC 2 captureepg false activated true licensed true capturenan fals...

Page 25: ...ProducerWMV or ALL which returns every service on the system xml version 1 0 encoding utf 8 v2 result OK result services service id 20110014111919578 name DVB 1 services v2 PRGM EX 18 v2Master_GetList...

Page 26: ...l 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 livechannels secure true secure v2 PRGM EX 19 v2M...

Page 27: ...2Live_StopMPEGEncoder Stops the specified encoder transmitting Channel Attributes sServiceID The service ID of the Live Service to start xml version 1 0 encoding utf 8 v2 result OK result v2 PRGM EX 2...

Page 28: ...s before it returns as the WMV encoder can take this long to start up Parameters sServiceID The service ID of the WMV Encoder Service to start xml version 1 0 encoding utf 8 v2 result OK result v2 PRG...

Page 29: ...art xml version 1 0 encoding utf 8 v2 result OK result week 2 week day 2 day schedule week id 0 day id 3 program name Better the devil you know duration 00 04 colourindex 1 id 000008 uniqueid entry0 s...

Page 30: ...cheduled End time start Scheduled Start Time end Scheduled End time url The URL of the video API Commands 24 Vision2 API Guide week is current week in schedule and day is the current day in the schedu...

Page 31: ...lue medium option name Low value low param param name Multicast Address selected 234 4 0 0 type text param name Multicast Port selected 5500 type text param name Multicast TTL selected 3 type text par...

Page 32: ...Producer Service sIntermissionEnable true to enable intermission sIntermission The URL for Live channels or path to the video file to be used as the source for the intermission sNICIndex The index of...

Page 33: ...producer service broadcasting and adds the channel to the playlists Parameters sServiceID The service ID of the Producer Service xml version 1 0 encoding utf 8 v2 result OK result v2 PRGM EX 28 v2Prod...

Page 34: ...d Type selected Scheduled type list selectby value option name Manual value Manual option name Continuous value Continuous option name Scheduled value Scheduled param param name Segment Length selecte...

Page 35: ...ed to Keep Archive for If Record Type Continuous then how long to keep the recordings for before they are automatically deleted from the Archive Path to Save to This value should be simply passed back...

Page 36: ...e The name of the channel being recorded sChanneTolRecordURL The URL to record from sArchiveServiceURL The URL to the Archive Service sKeepArchiveDays If Record Type Continuous then how long to keep t...

Page 37: ...The service ID of the Recording Service xml version 1 0 encoding utf 8 v2 result OK result v2 PRGM EX 33 v2Record_StopRecording Sample XML v Record_CancelRecording Parameters sServiceID The service ID...

Page 38: ...name Source ID selected internetunicastsource type list selectby value option name Manual Unicast Source value internetunicastsource id internetunicastsource option name WMV Encoder 1 id 201100141119...

Page 39: ...r is created depending on what is selected in the Source ID parameter Two values are used here as if the Source ID is set to internetunicastsource then the value of the Source URL is entered manually...

Page 40: ...service broadcasting Parameters sServiceID The service ID of the Reflector service to start xml version 1 0 encoding utf 8 v2 result OK result v2 PRGM EX 38 v2Reflector_StartBroadcast Sample XML Param...

Page 41: ...ameters sChannellD The channel ID to start xml version 1 0 encoding utf 8 v2 result OK result v2 PRGM EX 40 v2DVB_StartBroadcast Sample XML Here you need the Channel ID and not the Service ID as a DVB...

Page 42: ...API Commands 36 Vision2 API Guide...

Page 43: ...I but this method makes creating user interfaces much easier than calling the raw API directly The test page on the Vision2 System at http _v2server_name_ v2Services v2_API RenderTest aspx can be used...

Page 44: ...available on the target device for the UI ServiceID The Service ID of the Archive from which to return the data The available IDs are returned by leaving this entry blank and requesting a StartingID...

Page 45: ...id 20100424134125671 webserviceurl http LENOVO v2Services serverip 43 192 168 201 left 20 top 216 right 272 bottom 389 entry content v2 Initially the first thing to look for is that the result is OK...

Page 46: ...the x and y coordinates fall between x 20 y 29 x 272 y 212 then the user clicked on the first thumbnail which has an ID of 20110014111919390 FIG 3 Archive 3x3 grid XML Tags and Attributes Tag Attribu...

Page 47: ...1 cols 3 rows 3 thumbwidth 252 thumbheight 173 entry type search name Search id Search contentpath left 20 top 39 right 272 bottom 212 entry type category name Automatic Recordings id VideoCast_DVRAu...

Page 48: ...ntain the metadata for the video and the JPEG will be formatted to provide a background on which to display the metadata For example the XML will look similar to xml version 1 0 encoding utf 8 v2 resu...

Page 49: ...ple searching for Kylie AND Jason finds videos which contain both words Searching for Kylie NOT Jason finds videos which contain the word Kylie but do not contain the word Jason Playing a Video A Vide...

Page 50: ...Vision2 RenderThumbs Explorer 44 Vision2 API Guide...

Page 51: ...Record Service 45 Vision2 Operation Reference Guide...

Page 52: ...t you have the opportunity to gather the information and experience you need to deliver strong AMX solutions Plus AMX courses also help you earn CEDIA NSCA InfoComm and AMX continuing education units...

Reviews: