Getting from http://forum.xtreamer.net/mediawiki-1.15.1/index.php/Talk:Xtreamer_RSS_Guide

Full sample of text element without description :

getFocusMenuIndex

Description: fetch the index of the item which is Focus.

Input Parameters:
None

Output Parameters:
the Index of focusMenu

Sample Code:

setFocusMenuIndex

Description: set the item focus.

Input Parameters:
index

Output Parameters:
return NULL;

Sample Code:

showIdle

Description: show the idle image
Input Parameters:
None

Output Parameters:
return NULL;

Sample Code:

cancelIdle

Description: cancel the showing of idle image

Input Parameters:
None

Output Parameters:
return NULL

Sample Code:

getSelectedItemIndex

Description: fetch the index of the item which is selected.

Input Parameters:
None

Output Parameters:
index

Sample Code:

getDrawingItemState

Description: fetch the state of the item which is be Drawing.

Input Parameters:
None

Output Parameters:
Item 's state，such as: "focus"、"unfocus"、"inactive"

Sample Code:

getUserInput

Description: fetch the corresponding user input
Input Parameters:
None

Output Parameters:
Command，such as:
"left";"right";"up";"pageup";"pagedown";"down";"enter";"return";"edit";"download";
"video_completed";"video_stop";"video_pause";"video_ffwd";"video_sfwd";"video_srwd";
"video_repeat";"video_abrepeat";

Sample Code:

userSelectToString

Description: change UserSelect to a command string

Input Parameters:
USR_SELECT userInput

Output Parameters:
command string

Sample Code:

stringToUserSelect

Description: change the command string to UserSelect

Input Parameters:
command string

Output Parameters:
USR_SELECT userInput

Sample Code:

currentUserInput

Description: fetch the current user input
currentUserInput() return the current user selection, like "up", "down", "left" ...
It is often used inside <onUserInput> element in the script to know what's the user selection

Input Parameters:
None

Output Parameters:
Command，such as:
"left";"right";"up";"pageup";"pagedown";"down";"enter";"return";"edit";"download";
"video_completed";"video_stop";"video_pause";"video_ffwd";"video_sfwd";"video_srwd";
"video_repeat";"video_abrepeat";

Sample Code:

postMessage

Description: execution the command

Input Parameters:
command，such as:
"enter" "left";"right";"up";"pageup";"pagedown";"down";"enter";"return";"edit";"download";
"video_completed";"video_stop";"video_pause";"video_ffwd";"video_sfwd";"video_srwd";
"video_repeat";"video_abrepeat";

Output Parameters:
return NULL;

Sample Code:

setRefreshTime

Description: set the refresh time of the page, in milliseconds. the refresh timer for the current page. when timer is up, the <onRefresh> element inside the script will be called.

Input Parameters:
time millisecond

Output Parameters:
return None

Sample Code:

getURL

Description: fetch the content of an URL (local file and http:// only).

Input Parameters:
url The URL of remote content. For example, http://www.google.com/video/rse1234.xml

Output Parameters:
the content of the URL

Sample Code:

getCSVFromURL

Description: get the CSV stirng from the url.

Input Parameters:
url The URL of remote content.

Output Parameters:
Command Separated value

Sample Code:

getItemInfoArray

Description: function returns a string with the values, separates with '\n'. If an item does not have the element, it will contain only the '\n' without value

Input Parameters:
itemElementName The element name to be fetched item by item.

Output Parameters:
a string with the element values, separates with '\n'

Sample Code:

catStringArray

Description: Function cat the string array with separator

Input Parameters:
separator

Output Parameters:
a string which cat values with separator

Sample Code:

pushBackStringArray

Description: Function append an element to the end of an existing string array, A stringArray is a text string separated with \n.

Input Parameters:
element A char string.

Output Parameters:
the new string array

Sample Code:

getStringArrayAt

Description: Function gets an element from a string array.

Input Parameters:
Index 0 based index. When index equals to -1, system will get the index from user’s current selection.

Output Parameters:
the value of array[index]

Sample Code:

deleteStringArrayAt

Description: Function deletes an element from a string array.

Input Parameters:
stringArray and index. if index = -1 mean current item index. Default value is -1.

Output Parameters:
the new string array

Sample Code:

updateDisplay

Description:Update the Diaplay

Input Parameters:
None

Output Parameters:
return NULL;

Sample Code:

loadXMLFile

Description: load an XML file from local storage or http protocol, and create a global xml DOM object. The next call of loadXML file will destroy the previous DOM object and form the new one.

Input Parameters:
url the URL. For example "http://www.google.com/rss/sample.rss", or local file "/tmp/scripts/sample.rss".

Output Parameters:
if fail to load the file, function return NULL.

Sample Code:

Print

Description: print(arg1, arg2, arg3 .....). print to debug console on windows

Input Parameters:
char string,

Output Parameters:
return NULL.

Sample Code:

getItemInfo

Description: function return the item value associate with the name.

Input Parameters:
Index: the item index

Name string:
you can query the standard item elements defined inside RSS2.0. Any element text inside <item> <xx> TEST </xx> </item> can be queried by name. In this example, getItemInfo("xx") return "TEST".
"mediaURL"  : the direct URL path of the media file from internet. This link must be consistent on the web server. Or it can be the videoID on storage after user download from playURL
"playURL"  : the web URL to the internet contents. it is used when the web server will re-direct the link to other places like youtube.
"link"  : when user select the item, this is the url that the service will go to. we use "link" to go to services, for example "rss_file://test.rss" will open the rss file in our browser.
"pageNumber": the page number of requested item is located

indexForMultipleResults:
default to 0, and if index = -1, function will fetch current focus item, which equal to the second prototype of this function

Output Parameters:
return the string of item value associate with the name.

Sample Code:

getPageInfo

Description: function return the value associate with the name. This is page releated attributes

Input Parameters:
Name string:
e.g. name can be "itemCount" or "focusItemIndex". "itemCount" means how many items show in the current page.

Output Parameters:
return the string of current page value associate with the name.

Sample Code:

getQueryItemIndex

Description: return the current item index that the View is currently scanning at. This function is useful in item_template to get the item index. When your script is scanning the items by itself instead of user focus change, use getQueryItemIndex. It is not the focused item, it is the item that the view is currently drawing

Input Parameters:
None

Output Parameters:
Index : the current item index that the View is currently scanning at

Sample Code:

getQueryMenuIndex

Description: return the current menu index that the View is currently scanning at.

Input Parameters:
None

Output Parameters:
Index : the current menu index that the View is currently scanning at

Sample Code:

getFocusItemIndex

Description: return the current item index that the View is currently focus on.

Input Parameters:
None

Output Parameters:
FocusIndex : the current focus item index

Sample Code:

addItem

Description: add Item to current document. Function add an element to current page.

Input Parameters:
String: new element name

Output Parameters:
None

Sample Code:

redrawDisplay

Description: redraw the display.

Input Parameters:
None

Output Parameters:
None

Sample Code:

getXMLElementCount

Description: get the count of a specific element from xml dom object.

Input Parameters:
name string of specific element

Output Parameters:
Count string

Sample Code:

getXMLText

Description: get the text of specific element from global xml dom object

Input Parameters:
name string of specific element

Output Parameters:
Context of element

Sample Code:

getXMLAttribute

Description: get the attribute of a specific element from global xml dom object

Input Parameters:
name string of specific element

Output Parameters:
attribute of element

Sample Code:

getURLforStock

Description: get URL informations for stock

Input Parameters:
URL Path

Output Parameters:
None

Sample Code:

selectMenu

Description: function will select the menu.

Input Parameters:
Menu index

Output Parameters:
None

Sample Code:

setItemFocus

Description: function will focus the menu.

Input Parameters:
Menu index

Output Parameters:
None

Sample Code:

executeScript

Description: function will execute a script block.

Input Parameters:
specific element string name

Output Parameters:
None

Sample Code:

jumpToLink

Description: function will jump to other URL follow the description of a script block.

Input Parameters:
element link

Output Parameters:
None

Sample Code:

writeStringToFile

Description: write value to file

Input Parameters:
Filename; value

Output Parameters:
None

Sample Code:

playItemURL

Description: play the "playURL" of item in previewWindow or full screen

Input Parameters:
Index
element1, element2 : the element tag name to previewWindow,

Output Parameters:
None

Sample Code:

sprintf1

Integer1

sprintf

Integer

Add

Minus

getInput

Decription: Function will pop up window to get user input. function will return the string from user input.
If user escape the input window, function will return "null".

postMessage

Decription: postMessage() post a user message to system
you can post, "left", "right", "up", "down", "enter", "return", "edit"

setRefreshTime

Decription: set the refresh timer for the current page. when timer is up, the <onRefresh> element inside the script will be called.
setRefreshTime(miliseconds);

getURL

Decription: fetch the content from internet site.
getURL(url). function return the http content in full text.

getCSVFromURL

Decription: fetch the content from internet site.
getCSVFromURL(url). function return the http content parse to string array basing on CSV fomat, which is comma separated string

getItemInfo

Decription: getItemInfo(index, name, indexForMultipleResults), function return the item[index]["name"][indexForMultipleResults] value associate with the name.
getItemInfo(name, indexForMultipleResults), function return current focus item["name"][indexForMultipleResults].
indexForMultipleResults default to 0, and if index = -1, function will fetch current focus item, which equal to the second prototype of this function name: you can query the standard item elements defined inside RSS2.0. Any element text inside <item> <xx> TEST </xx> </item> can be queried by name. In this example, getItemInfo("xx") return "TEST".
"mediaURL"  : the direct URL path of the media file from internet. This link must be consistent on the web server. Or it can be the videoID on storage after user download from playURL
"getplayURL"  : the web URL to the internet contents. it is used when the web server will re-direct the link to other places like youtube.
"link"  : when user select the item, this is the url that the service will go to. we use "link" to go to services, for example "rss_file://test.rss" will open the rss file in our browser.

for rss definition, please see RSS2.0 documentation.

"length", "duration", "description", "title", "mediaType", "pubDate" are default RSS2.0 elements, please refer to RSS2.0 spec
"pageNumber": the page number of requested item is located

Any XML file conform to our dataProivder can have any custom name-value pair. For example, Flickr xml feed has "id" element, that you can use getItemInfo to get the value corresponding to the "id" element.

youtube has "rating", "viewcount", "durationHHMMSS"

getPageInfo

Decription: getPageInfo(name), function return the value associate with the name. This is page releated attributes
e.g. name can be "itemCount" or "focusItemIndex". "itemCount" means how many items show in the current page.

getQueryItemIndex

Decription: getQueryItemIndex() return the current item index that the View is currently scanning at
This function is useful in item_template to get the item index. When your script is scanning the items by itself instead of user focus change, use getQueryItemIndex. It is not the focused item, it is the item that the view is currently drawing

getQueryMenuIndex

getFocusItemIndex

Decription: getFocusItemIndex() return the current item index that the View is currently focus on.

getFocusMenuIndex

getSelectedItemIndex

Decription: getSelectedItemIndex() return the last selected item. It might not equal to current focus.

getDrawingItemState

Decription: getDrawingItemState() return the current drawing item state. The return value is "focus", "unfocus",or "inactive"

getItemInfoArray

Decription: getItemInfoArray(itemElementName), function return a string with the values, separates with '\n'. If an item does not have the element, it will contain only the '\n' without value

this function is useful to get one data column of all items.

catStringArray

Decription: catStringArray(stringArray, "+"). Function replace the string array with separator.
example: the "taipei \n tokyo \n" will become "taipei + tokyo +"

getStringArrayAt

Decription: getStringArrayAt(stringArray, index). Function get the indexth entry of the string array.
if index = -1 mean current item index. Default value is -1.
example: getStringArrayAt(stringArray) will get the getQueryItemIndex, then issue getStringArrayAt(string, getQueryItemIndex).

deleteStringArrayAt

Decription: deleteStringArrayAt(stringArray, index). Function delete the indexth entry of the string array.
if index = -1 mean current item index. Default value is -1.
example: deleteStringArrayAt(stringArray) will delete the getQueryItemIndex, t

function will cause the number of element of the array reduce 1

addItem

Decription: add Item to current document. Function add an element to current page.
example: addItem("newItem"). the calling will find the <newItem> element under <rss> domain, then rename and resolve the scripts inside <newItem> element, insert the <newItem> element inside <channel> domain, and rename <newItem> to <item>

redrawDisplay

Decription: redraw the display

loadXMLFile

Decription: load an xml file from url, and create a global xml dom object
only one instance of xml at a time. Call loadXML will switch to another xml document.

getXMLElementCount

Decription: return the count of a specific element from xml dom object
example: getXMLElementCount("rsp", "photos", "photo"); If return 5, means there are 5 <photo> elements under <photos> element

getXMLText

Decription: get the text of specific element from global xml dom object
For example, getXMLText("rss", "channel", "title");
For example, getXMLText("rss", "channel", "title", 5, "text"); The number 5 means the 5th "title" element. Default element index is 0 for each element. getXMLText("rss", "channel", "title", 5, "text", 5); is equal to ["rss"][0]["channel"][0]["title"][5]["text"][6]

getXMLAttribute

Decription: get the attribute of a specific element from global xml dom object
The last parameter is the attribute of the element.
For example, getXMLText("rss", "channel", "content", "url");
Usage, please see getXMLText

pushBackStringArray

Description: push a string to the back of the string array. A stringArray is a text string separated with \n.

example.
the idArray will contain "1\n2\n". Use getStringArrayAt(idArray, 1); will return 2.
use catStringArray(idArray, "+") will generate "1+2+"

getURLforStock

Description: get URL informations for stock

selectMenu

Description: selectMenu(index); function will select the menu. selectMenu(2) will select the 3rd menu item.

executeScript

Description: executeScript will execute a script block.
executeScript("testFunction"); will execute the script inside <testFunction> in the RSS scope

jumpToLink

Description: jumpToLink will jump to other URL follow the description of a script block.
jumpToLink("nextLink1"); will follow the link inside <nextLink1> in the RSS scope
example of <nextLink1>

setItemFocus

Description: setItemFocus(index); function will set the item focus. The setting will effect on the dataProvider
If want to reflect on view, you need to redraw the display.

playItemURL

Description: control video. play video in previewWindow or full screen !!
general usage of the script function is
playItemURL(op, url, startupfullness, offset, chapIndex, element1, element2....).
argument list:
1, op : required operation code, the valid numbers are
  op=1: stop current video
  op=2: pause current video
  op=0: play the video in URL
  op=10: play video in URL, and display idle image before video starts
  op=3: play video in URL, but pause the video on start
  op=4: play video in URL, pause video on start, and don't hide OSD
  op=5: play audio in URL (for audio file).

2, URL, required, and only relevant if op is "play"
  URL can be a number, playItemUrl will try to get the index item's playURL in current dataprovider.
  URL can be a file path, the specified file will be played
  URL can be http URL.

3, optional startupfullness, a integer specify how much to buffer before playing. not used, default -1

4, optional offset, a integer specify where to seek to to play, default -1

5, optional chapIndex, not used, a integer specify the chapter to start, default -1

3,4,5,6 - optional element strings to specify where the preview window is. If no preview window, video will play full screen.
if arg 3/4/5 is not a number (startupfullness), then starting with 3, arg 3/4/5, all following arguments will be treated as element string.

playAtTime

getPlaybackStatus

Description: get the status of video playback, in the format of "current/max"
both are integers. If no video is playing, you get "0/100".

getCachedStreamDataSize

setPreviewWindow

tearDownPlaybackFlow

setVoutDisplay

GetScreenSaverStatus

SetScreenSaverStatus

isInternalHDDExist

getPTS

updatePlaybackProgress

Description: update playback progress bar
updatePlaybackProgress(progress, element1, element2....). element1, element2 is the element tag name to previewWindow,
for example, ["mediaDisplay"][0]["previewWindow"][0], will be playItemURL(index, "mediaDisplay", "previewWindow");
last element must be previewWindow element,

readStringFromFile

Description: read string from file
readStringFromFile(fileName)

writeStringToFile

Description: write value to file
writeStringToFile(fileName, value)

setEnv

Description: set environment variable
setEnv(name, value, overWrite)

unsetEnv

Description: unset environment variable

getEnv

Description: read environment variable
getEnv(name)

getStoragePath

Description: get the path of local storage. e.g. temporary storage "tmp", non-volitle storage "key"
getStoragePath(symbol). symbol is "tmp", "key"

drawImageOnScreen

Description: drawImageOnScreen will draw image on the on screen buffer. It will not effect backbuffer
drawImageOnScreen(path, xPC, yPC, widthPC, heightPC). All refer to panelWidth and panelHeight

drawImage

Description: drawImage will draw image on the back buffer.
drawImage(path, xPC, yPC, widthPC, heightPC). All refer to panelWidth and panelHeight

urlEncode

Description: function return encoded url

menuCmd

Description: menuCmd(AP_Name, cmd1, cmd2 .....). send command to AP by user select

getCurrentAPName

Description: getCurrentAPName(). get current AP's name

setParentFade

Description: setParentFade(). set Parent AP's display area fade

deleteItem

Description: remove an item from saved file.

setFocusItemIndex

Description: setFocusItemIndex set the current focus Item

setFocusMenuIndex

Description: setFocusMenuIndex set the current focus menu

convertSpaceInUrl

Description: convert ' ' in url to %20

prepareAnimation

Description: prepare system for animation

getErrorCode

getErrorString

doModalRss

setReturnString

googleServiceLogin

Description: this is google authentication service (clientLogin), it take multiple keywords. The first word is the keyword,
"youtube usr pass" - for log into youtube, with usr/pass
return "success" if OK
"status youtube Auth" - check youtube (logged in?)
return auth string
"status youtube ..." - check youtube (logged in?)
return youtubeUsername

to be extended to other google services (picasa etc)

cancelDownload

Description: cancel the url downloading, you can cancel multiple downloads in single function call

Sample code: