basic.networks.javascript

Interface SignStixNetwork

SignStixNetwork

Javascript-to-Player interface with functions for making calls over the network.

Function Summary

Modifier and Type	Function and Description
void	downloadRssFeed(String feedUrl, int timeoutSecs, String jsFunctionName) Download and parse the RSS feed XML at the argument URL.
void	downloadText(String url, int timeoutSecs, String jsFunctionName) Download text content from the argument URL.
void	findWebControlInterfaces(int timeoutSecs, String jsFunctionNameSingle, String jsFunctionNameAll) Discover any local SignStix devices currently offering the Web Control interface and find the IP address and port of those interfaces, for subsequent communication.

Function Detail

downloadText

void downloadText(String url,
                  int timeoutSecs,
                  String jsFunctionName)

Download text content from the argument URL. This function will return quickly. The results are returned via the callback function.

Parameters:

url - the URL of the content.

timeoutSecs - the maximum number of seconds before giving up.

jsFunctionName - the name of a Javascript function that takes the following parameter:

1. content - the downloaded text content, or null if the content could not be downloaded.

Since:

Player 3.2.1

downloadRssFeed

void downloadRssFeed(String feedUrl,
                     int timeoutSecs,
                     String jsFunctionName)

Download and parse the RSS feed XML at the argument URL. This function will return quickly. The results are returned via the callback function.

Parameters:

feedUrl - the URL of the RSS feed.

timeoutSecs - the maximum number of seconds before giving up.

jsFunctionName - the name of a Javascript function that takes parameters as follows:

1. rssJson - a JSON-formatted string representing the contents of the feed XML, or null if the feed could not be downloaded. Note that parameters from the XML become JSON nodes prefixed with "-" in the RSS. Text between start and end tags in the XML becomes a JSON child node called "#text". Consecutive XML nodes with the same tag become an array in the JSON. For example, this XML:

      
    		<rss><channel>
    		  <title><![CDATA[My RSS Feed!]]></title>
    		    <item>
    		      <title><![CDATA[This is the first story title]]></title>
    		      <description><![CDATA[Lots of info about story 1]]></description>
    		      <thumbnail width="1920" height="1080" url="http://mydomain.com/greatImage1.jpg"/>
    		    </item>
    		    <item>
    		      <title><![CDATA[This is the second story title]]></title>
    		      <description><![CDATA[Lots of info about story 2]]></description>
    		      <thumbnail width="1920" height="1080" url="http://mydomain.com/greatImage2.jpg"/>
    		    </item>
    		  </channel>
    		</rss>
    	
    

   ... would be converted to this JSON:

                   {
                     "rss": {
                       "channel": {
                         "title": "My RSS Feed!",
                         "item": [
                           {
                             "title": "This is the first story title",
                             "description": "Lots of info about story 1",
                             "thumbnail": {
                               "-width": "1920",
                               "-height": "1080",
                               "-url": "http://mydomain.com/greatImage1.jpg"
                             }
                           },
                           {
                             "title": "This is the second story title",
                             "description": "Lots of info about story 2",
                             "thumbnail": {
                               "-width": "1920",
                               "-height": "1080",
                               "-url": "http://mydomain.com/greatImage2.jpg"
                             }
                           }
                         ]
                       }
                     }
                   }
                   

Since:

Player 3.2.1

findWebControlInterfaces

void findWebControlInterfaces(int timeoutSecs,
                              String jsFunctionNameSingle,
                              String jsFunctionNameAll)

Discover any local SignStix devices currently offering the Web Control interface and find the IP address and port of those interfaces, for subsequent communication. This function will return quickly. The results are returned via two named callback functions.

Parameters:

timeoutSecs - the maximum number of seconds to allow before giving up.

jsFunctionNameSingle - the name of a Javascript function which is called each time a device is discovered. It takes the following parameter:

1. address - a string of the form "IP-Address:Port".

jsFunctionNameAll - the name of a Javascript function which is called when the timeout expires. It takes the following parameter:

1. addresses - a JSON-formatted string representing an array of addresses of the form "IP-Address:Port" e.g. '["192.168.10.1:8081", "192.168.10.35:8081"]'. The array may be empty if no devices are discovered.

Since:

Player 3.2.1