Vision2 RenderThumbs Explorer
38
Vision
2
API Guide
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.
The actual call the test page makes will be similar to the following URL:
http://_Server_name_/v2Services/v2_API/v2_RenderThumbs.aspx?UserName=&Password
=&RequestType=XML&ContentType=mpg_high&Device=Tablet&WantMP3=false&Template=720x576_4x
4_blue&AvailableWidth=800&AvailableHeight=600&ServiceID=&StartingID=v2Archives&PageNumber=0
&Search=&WantSplash=false&WantAminoPlaybackUI=false&WantAminoLiveUI=false
The following table lists the parameter descriptions for the above URL. These definitions also appear on the
Vision
2
RenderThumbs Explorer screen.
Parameter Descriptions
UserName
User name if log in is required to access the system. Note that security can be
bypassed if the device making the request appears in the file
C:\Inetpub\wwwroot\v2Services\v2_API\WhiteList.xml
Password
Password if log in is required to access the system
RequestType
The return type of the data requested
ContentType
The format and bitrate of videos required
Device
The device being used to play the video. This changes the video URLs returned by
the call to be correct for the type of device.For example the Amino uses RTSP while
Tablets use HTTP calls.
Template
The template defines how the thumbnails are laid out and the colors used.
Templates are stored on the system under
C:\Inetpub\wwwroot\v2Services\UI\Generic\Templates
AvailableWidth
The
width
available
on
the
target
device
for
the
UI.
AvailableHeight
The height 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 of "v2Archives".
StartingID
The ID from which to return the data.
If you first request "v2Archives" you will get a list of all of the archives (and their IDs)
on all systems (note that if there is only one archive on the entire system then you
will get the root content for the only archive back. If you ask for
"VideoCast_ContentRoot" or "" then you will get the root content of the archive
server you made the v2_RenderThumbs call to.
If the ID is a category you will get back a list / image of thumbnails.
If the ID is an actual video you will get back a background for a information page if
RequestType=JPEG, or you will get back the Metadata for that video if
RequestType=XML (note that on this page Internet Explorer will display the XML
with the < and > entries automatically converted to < and >. If you want actual
HTML then you will need to perform these replacements yourself. (If you right click
on the XML on this page and select View Source you will see what is actually
returned.)
PageNumber
When the number of thumbnails exceeds the total available as defined by the
template then this parameter allows you to select which page of thumbs are
returned. Note that this parameter is only valid when requesting an image as when
requesting XML or JSON then the entries for all of the content at the specified ID will
be returned.
Search
If this parameter is not empty then it overrides the StartingID. If the search string
contains more than one word then the exact string is searched for.
The search string can also contain the terms AND a NOT. For example searching
for Kylie AND Jason will find videos which contain both words. Searching for Kylie
NOT Jason will find videos which contain the word Kylie but do not contain the word
Jason.
