AMX Vision2 Operation/Reference Manual
  1. Manuals
  2. Brands
  3. AMX Manuals
  4. Set-top boxes
  5. DTV VISION2 INTEGRATION - DIAGRAM
  6. Operation/reference manual
AMX Vision2 Operation/Reference Manual

AMX Vision2 Operation/Reference Manual

Api guide
Hide thumbs Also See for Vision2:
Table of Contents

Advertisement

Quick Links

See also: Manual , Operation/reference Manual
2
Vision
API Guide
Operation/Reference Guide
2
Vision
API Guide
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
I n i t i a l R e l e a s e : 1 1 / 1 4 / 2 0 1 1

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Vision2 and is the answer not in the manual?

Questions and answers

Related Manuals for AMX Vision2

Summary of Contents for AMX Vision2

  • Page 1 Vision API Guide Operation/Reference Guide Vision API Guide 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 I n i t i a l R e l e a s e : 1 1 / 1 4 / 2 0 1 1...
  • Page 2 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.
  • Page 3 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.

  • Page 5: Table Of Contents

    Table of Contents 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...............
  • Page 6 ....................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 Vision Operation/Reference Guide...

  • Page 7: Using The Api

    <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" />...

  • Page 8: Forcing A Specific Set-Top Box To Play A Specific Video

    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.

  • Page 9: Enabling And Disabling Live Channels

    Using the API Enabling and Disabling Live Channels To control which channels are broadcasting on a Vision system 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"...

  • Page 10: Enabling Iis Security For The Administrator Api

    Using the API 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: On the Master Server, click the following path: Start Menu >...
  • Page 11 Using the API 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.
  • Page 12 Using the API Vision API Guide...

  • Page 13: Api Commands

    This API is used to provide the user interface for the new Amino 140H STB and for the new Tablet PC support for Vision . See the Vision2 RenderThumbs Explorer section on page 37 for information. Vision API Guide...

  • Page 14: Archive Commands

    API Commands Archive Commands The following section lists the API commands available for the Archive service. v2Archive_DeleteVideo Deletes the specified video from the specified archive. Parameters sArchiveID The ID of the Archive containing the video sVideoID The ID of the video to be deleted <?xml version="1.0"...

  • Page 15: Master Commands

    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"...

  • Page 16: V2Master_Stb_Amino_Getstbsbyfirstletterinname

    API Commands 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"...

  • Page 17: V2Master_Stb_Amino_Getstatus

    API Commands 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 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"...

  • Page 18: V2Master_Stb_Amino_Setlivechannelbyid

    API Commands 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 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...

  • Page 19: V2Master_Stb_Amino_Setlivechannel_Multi

    API Commands 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 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"...

  • Page 20: V2Master_Stb_Amino_Sendrs232

    API Commands 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 Parameters sSTBIPAddress The IP address of the set-top box to obtain the status from sBaudRate Must be 9600 or 19200 sWantBinary...

  • Page 21: V2Master_Getfullchannellist

    API Commands v2Master_GetFullChannelList Obtains a list of all of the Vision channels even the ones not transmitting. <?xml version="1.0" encoding="utf-8" ?> <v2> <result>OK</result> <channels> <channel type="v2DVB" name="BBC TWO" id="9018:4100:4228" transmitting="false" /> <channel type="v2DVB" name="BBC ONE" id="9018:4100:4164" transmitting="true" /> <channel type="v2DVB" name="301"...

  • Page 22: V2Master_Getdiagnostics

    API Commands v2Master_GetDiagnostics btains diagnostic information about the selected server.. <?xml version="1.0" encoding="utf-8" ?> <v2> <result>OK</result> <os> <name>Microsoft Windows Server 2003 Enterprise Edition</name> <version>Service Pack 2</version> <serial>69713-357-0526242-42064</serial> </os> <memory> <total>3143356</total> <free>1664488</free> </memory> <CPUs> <CPU> <loadpercentage>8</loadpercentage> </CPU> <CPU> <loadpercentage>2</loadpercentage> </CPU> </CPUs> <nics>...

  • Page 23: V2Master_Getapiversion

    API Commands v2Master_GetAPIVersion Returns the current version of the API. <?xml version="1.0" encoding="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 Vision User Access Control is enabled on the system and offers an easy method to check if user log in is required to access content.

  • Page 24: V2Master_Getlistofservices

    ALL which returns every service on the system. <?xml version="1.0" encoding="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="false" demomode="false" basemulticastaddress="234.1.0.0" port="5500" ttl="2" nic="1"...

  • Page 25: V2Master_Getlistofservices_Nameandidonly

    API Commands v2Master_GetListOfServices_NameAndIDOnly Obtains a list of selected service types on the entire Vision system returning only the 'name' and 'id' attributes. Parameters sServiceType The type of services to return. This can be one of the following values: v2Archive, v2DVB, v2Live, v2Record, v2Producer, v2LiveWMV, v2ReflectorWMV, v2ProducerWMV, or ALL which returns every service on the system.

  • Page 26: V2Master_Getlivechannellist

    API Commands v2Master_GetLiveChannelList Returns a list of the selected channel types. Parameters sWantWMV ' true' if you want the list to include Windows Media Format Channels sWantMPEG2 'true' if you want the list to include MPEG-2 (Video) Format Channels sWantH264 'true' if you want the list to include h.264 (Video) Format Channels <?xml version="1.0"...

  • Page 27: Live Commands

    API Commands Live Commands The following section lists the API commands available for the Live MPEG and Live WMV services. v2Live_StartMPEGEncoder Starts the specified encoder transmitting. Channel Attributes sServiceID The service ID of the Live Service to start <?xml version="1.0" encoding="utf-8" ?> <v2>...

  • Page 28: V2Live_Startwmvencoder

    API Commands v2Live_StartWMVEncoder Starts the specified encoder transmitting. This command call can take up to 20 seconds 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"...

  • Page 29: Producer Commands

    API Commands Producer Commands The following section lists the API commands available for the Producer service. All commands are valid for both WMV and MPEG producer channels. v2Producer_GetSchedule Obtains the XML schedule for the specified Producer channel. Channel Attributes sServiceID The service ID of the Producer Service to start <?xml version="1.0"...
  • Page 30 API Commands 'week' is current week in schedule and 'day' is the current day in the schedule.The schedule starts at Week 0 and ends at Week 3, days start at 0 (Sunday). If no content is scheduled for a week then there will be no week node. Also, if no content is scheduled then there will be no day node.

  • Page 31: V2Producer_Getsettings

    API Commands v2Producer_GetSettings Obtains the settings for the specified Producer channel. Program Attributes sServiceID The service ID of the Producer Service <?xml version="1.0" encoding="utf-8" ?> <v2> <result>OK</result> <params> <param name="Enabled" selected="false" type="true-false" /> <param name="Archive ID" selected="20110014111919390" type="readonly" /> <param name="Base Video Path" selected="h:\vcContent\" type="readonly" /> <param name="Enable Intermission"...

  • Page 32: V2Producer_Setparameters

    API Commands Program Attributes (Cont.) Multicast Address The Address to multicast on Multicast Port The Port to multicast on Multicast TTL The Time To Live for the multicast Broadcast Is ’true' for multicast 'false' for unicast (only WMV producers can unicast, so for MPEG this Multicast value must be true v2Producer_SetParameters...

  • Page 33: V2Producer_Startbroadcast

    API Commands v2Producer_StartBroadcast Starts the selected 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 v2Producer_StartBroadcast Sample XML v2Producer_StopBroadcast Stops the selected producer service broadcasting and adds the channel to the playlists.. Parameters sServiceID The service ID of the Producer Service...

  • Page 34: Record Commands

    API Commands Record Commands The following section lists the API commands available for the Record service. These commands only controls a Record service that is configured and enabled as a Manual record service. v2Record_GetSettings Obtains the settings for the specified Record channel. Program Attributes sServiceID The service ID of the Recording Service...
  • Page 35 API Commands Program Attributes The index of the network interface to use Record Type Defines how the service operates 'Manual' = Recording is manually started and stopped by calls to the web service 'Continuous' = Recording is non stop 'Scheduled' = Recordings are made to a schedule Segment Length If Record Type = 'Continuous' then a new file will be automatically created and added to the archive every 'Segment Length' minutes...

  • Page 36: V2Record_Setparameters

    API Commands v2Record_SetParameters Obtains the settings for the selected record service. v2Record_SetParameters Parameters sServiceID The service ID of the Recording Service sNICindex The index of the NIC to use to receive the stream sRecordingType Defines how the service operates sSegmentLength If Record Type = 'Continuous' then a new file will be automatically created and added to the archive every 'Segment Length' minutes sRootPathToSaveTo...

  • Page 37: V2Record_Stoprecording

    API Commands v2Record_StopRecording Stops the selected record service recording. v2Record_StopRecording Parameters sServiceID 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 v2Record_CancelRecording Stops the current recording, deletes the file from the disk and prevents it being archived. v@Record_CancelRecording Parameters sServiceID The service ID of the Recording Service...

  • Page 38: Reflector Commands

    API Commands Reflector Commands The following section lists the API commands available for the Reflector service. v2Reflector_GetSettings Obtains the settings for the selected reflector service. Parameters sServiceID The service ID of the Reflector Service <?xml version="1.0" encoding="utf-8" ?> <v2> <result>OK</result> <params>...

  • Page 39: V2Reflector_Setparameters

    API Commands Program Attributes Enabled 'true' if the reflector is broadcasting Source URL See note below Source ID See note below The index of the NIC to multicast on Multicast Address The Address to multicast on Multicast Port The Port to multicast on Multicast TTL The Time To Live for the multicast Broadcast Is...

  • Page 40: V2Reflector_Startbroadcast

    API Commands v2Reflector_StartBroadcast Starts the selected reflector 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 v2Reflector_StopBroadcast Stops the selected reflector service broadcasting.. Parameters sServiceID The service ID of the Reflector service to stop.

  • Page 41: Dvb Commands

    API Commands DVB Commands The following section lists the API commands available for the DVB service. v2DVB_StartBroadcast Starts the selected DVB channel for broadcasting.. Parameters 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 service can host many channels.
  • Page 42 API Commands Vision API Guide...

  • Page 43: Vision2 Renderthumbs Explorer

    Vision2 RenderThumbs Explorer Vision RenderThumbs Explorer The Vision RenderThumbs Explorer is a Meta API helper for creating any user interface which needs to provide the user with a graphical way to navigate or search the Vision Archives on the system. Underneath...

  • Page 44: Initial Requests

    Vision2 RenderThumbs Explorer Initial Requests Using the default settings when the page loaded, change the RequestType parameter to XML and then click Apply and test with parameters. If you have multiple Archives then in the right hand area you will see the returned XML which will be similar to those below.
  • Page 45 Vision2 RenderThumbs Explorer Parameter Descriptions (Cont.) WantSplash If this is true then a Splash Image is created. This is built from the background image from the template folder plus a PNG file from the same folder called Splash_ + Device + ".png".
  • Page 46 Vision2 RenderThumbs Explorer Return to the options on the RenderThumbs Explorer page, change the RequestType option to JPEG, and click Apply and test with parameters again. Vision renders a user interface for you according to the template indicated on the RenderThumbs Explorer page. The result should appear similar to the image in FIG.
  • Page 47 Vision2 RenderThumbs Explorer On the RenderThumbs Explorer page, change the RequestType back to XML and click Apply and test with parameters. Next, copy the ID of the first thumbnail into the StartingID parameter. Finally, edit the ServiceID parameter so it is empty and click Apply and test with parameters. You will then get the updated XML as displayed below: <v2>...
  • Page 48 Vision2 RenderThumbs Explorer On the RenderThumbs Explorer page, change the RequestType back to JPEG and click Apply and test with parameters. You will see the image for the current selection (FIG. 4). FIG. 4 Content page To provide navigation down through the folders, change the value of the StartingID parameter to the ID of the thumbnail, and resubmit the two calls sequentially when a user clicks on a thumbnail.

  • Page 49: Handling Search Thumbnails

    Vision2 RenderThumbs Explorer When you see this code in the RenderThumbs Explorer page, Internet Explorer displays the XML with the &lt; and &gt; entries of the info node automatically converted to < and >. If you want actual HTML, you will need to perform these replacements yourself.
  • Page 50 Vision2 RenderThumbs Explorer Vision API Guide...
  • Page 51 Record Service Vision Operation/Reference Guide...
  • Page 52 - Schedules and registration for any AMX University course - Travel and hotel information - Your individual certification requirements and progress 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.com...

Table of Contents