Action Scripting: Dictionary
Introduction
The following information details the complete list of action scripts within Appspace, along with their definitions and parameters (where applicable).
- BaseElement (All Players)
- WayFinder (DMP 4400)
- MediaZone (All Players)
- FlashContainer (DMP 4310, DMP 4400, Edge 300)
- EventCalendar (All Players)
- ItemContainer (All Players)
- InfoMenu (All Players)
- MediaContainer (All Players)
- TextTicker (All Players)
- RSSTicker (All Players)
- MediaTicker (DMP 4310, DMP 4400, Edge 300)
- RSSViewer (All Players)
- PlainText (All Players)
- RemoteControl (DMP 4310)
- KeyPad (DMP 4400)
- TableListing (DMP 4310, DMP 4400, Edge 300)
- System (All Players)
- Application (All Players)
- Layout (All Players)
BaseElement (All Players)
Events
| Event Name | Description |
|---|---|
| On Freeze | Triggers action when a widget/set of widgets moves off an active layout |
| On Unfreeze | Triggers action when a widget/set of widgets moves back into an active layout |
| Mouse Click / Touch | Triggers action when the mouse/pointer is clicked or when the designated area of a screen is touched |
WayFinder (DMP 4400)
Actions
Load Building By Name
- loads a building map by building name
- Building Name:string->insert building name
Load Building By ID
- loads building map by building id
- Building ID:string->insert building id
Load Floor By Name
- loads floor map by floor name
- Floor Name:string->insert building floor name
Load Floor By ID
- loads floor map by floor id
- Floor ID:string->floor id
Show Locations
- displays the locations marked in the map
- Show:string->insert true or false (e.g:true means show marked locations). default value is set to false
Show Paths
- shows marked paths in the map
- Show:string->insert true or false (e.g:true means show paths). default value is set to false
Set Route Looping
- loops the routing animations
- Loop:string->insert true or false (e.g:true means route will always loop). default value is set to false
Set Avatar
- set custom avatar
- Avatar URL:string->insert avatar URL (e.g: http://www.avatar-test.com)
- Avatar Width:string->insert avatar width in pixel
- Avatar Height:string->insert avatar height in pixel
Set Avatar Location By Name
- define avatar location
- Location Name:string->insert location name
Set Avatar Location By Position
- define avatar location
- Position X:string->insert start location X coordinate (e.g:123)
- Position Y:string->insert start location Y coordinate (e.g:123)
Show Route From Floor To Floor
- shows route across multiple floors by using location and floor name as parameters
- From Location Name:string->insert start location name
- From Floor Name:string->insert start floor name
- To Location Name:string->insert destination location name
- To Floor Name:string->insert destination floor name
Show Route To Location By Name
- shows route by using location name as parameters
- From Location Name:string->insert start location name
- To Location Name:string->insert destination location name
Show Route By Location Coordinate
- shows route by using location coordinates as parameters for a single floor
- From Position X:string->insert start location X coordinate (e.g:123)
- From Position Y:string->insert start position Y coordinate (e.g:123)
- To Position X:string->insert destination location X coordinate (e.g:123)
- To Position Y:string->insert destination location Y coordinate (e.g:123)
- Floor Name:string->insert floor name
Show Route To Location By Coordinate
- shows route by using location coordinates and destination name
- From Position X:string->insert start location X coordinate (e.g:123)
- From Position Y:string->insert start location Y coordinate (e.g:123)
- Location Name:string->insert destination location name
MediaZone (All Players)
Actions
Next Media
- go to next media content in the playlist
Previous Media
- return to previous media content in the playlist
Replay Media
- replay the same media content
Load Media
- loads a media content from playlist
- Offset:integer->insert media position number found in playlist (e.g:1,2,3)
- increment:integer (e.g:1,2,3)
Load Schedule
- loads a scheduled playlist based on schedule id
- id:int->insert schedule id
Load Schedule By Name
- loads a scheduled playlist based on schedule name
- schedule name:string->insert schedule name
Enable Audio
- controls playback of media audio
- Audio:boolean->insert true or false(e.g:true means enable audio)
Set Audio level
- sets absolute audio volume level
- Level:int->insert numbers 1 to 100
Adjust Audio level
- adjusts current audio volume
- Amount:int->insert numbers 1 to 100
zoom
- magnifies the media content
- position:string->insert zoom position X and Y coordinates (e.g:25,100)
- zoomamount:int->insert numbers 1 to x. larger number will show media at a higher magnification
- duration:int->insert number of minutes before media zoom out
resetzoom
- resets media zoom-in effect
- duration:int->insert number of minutes before media zoom out
rotatedisplay
- rotates the display based on a specified angle (in integer)
- amount:int->the angle to rotate
scaledisplay
- expand the display proportionally, up to twice the original size
- amount:int->insert the amount to scale (e.g: 1 = normal, 2 = twice as big)
execute content function
- triggers an external function (e.g. Flash content) based on the input string and parameters
- functionName:string->
- param1:string->
- param2:string->
- param3:string->
- param4:string->
load web page
- loads a specific web page based on specific query string(s)
- content url:string->
- querystring1:string->
- value 1:string->
- querystring2:string->
- value 2:string->
- querystring3:string->
- value 3:string->
- querystring4:string->
- value 4:string->
unload media
- removes all the media from a specific Media Zone widget
Events
Media Complete
- Title:string->Title of the Media
- MediaTitle:string->Title of the Media
- MediaFile:string->Media File Name
- MediaType:string->Media Type
- MediaDescription:string->Media Description
- MediaPlayoutTagsRule:string->Tag Rules
- MediaIndex:int->Media Playlist Index
Media Loaded
- Title:string->Title of the Media
- MediaTitle:string->Title of the Media
- MediaFile:string->Media File Name
- MediaType:string->Media Type
- MediaDescription:string->Media Description
- MediaPlayoutTagsRule:string->Tag Rules
- MediaIndex:int->Media Playlist Index
- IsFirstItem:int->Is First Item in Playlist
- IsLastItem:int->Is Last Item in Playlist
End Of Playlist
- Title:string->Title of the Media
- MediaTitle:string->Title of the Media
- MediaFile:string->Media File Name
- MediaType:string->Media Type
- MediaDescription:string->Media Description
- MediaPlayoutTagsRule:string->Tag Rules
- MediaIndex:int->Media Playlist Index
FlashContainer (DMP 4310, DMP 4400, Edge 300)
Actions
SetVariable
- Passes a specific value to a SWF Flash object
- Name:string->insert variable name
- Value:string->insert value for variable
RegisterPropertyListener
- Retrieves periodic updates from a specific Flash object and triggers a custom event based on the captured data
- Name:string->
- Interval:string->
- Trigger:string->
EventCalendar (All Players)
Actions
- Next page - go to the next calendar page
- Previous page - go to the previous calendar page
Events
Event Onload
- Index:string->
- Title:string->
- Location:string->
- Description:string->
- StartDate:string->
- StartTime:string->
- EndDate:string->
- EndTime:string->
Event OnClick
- Index:string->
- Title:string->
- Location:string->
- Description:string->
- StartDate:string->
- StartTime:string->
- EndDate:string->
- EndTime:string->
ItemContainer (All Players)
Actions
LoadPreviousItem
- go to the previous item on the item list
LoadNextItem
- go to the next item on the item list
LoadParentItem
- navigate up one level in the item(s) hierarchy
loadcollection
- displays all the items contained within the folder hierarchy, including items in subfolders
- collection:int->
loadpage
- displays a specific page to be loaded based on the page number
- pagenum:int->
setitemsize
- designates the specific dimensions of the item to be displayed
- width:int->
- height:int->
setitemspacing
- defines the distance between items, based on the specified coordinates
- x:int->set position X coordinate
- y:int->set position Y coordinate
Next page
- go to the next page
Previous page
- go to the previous page
MediaContainer (All Players)
Actions
LoadPreviousItem
- go to the previous item on the item list
LoadNextItem
- go to the next item on the item list
LoadParentItem
- navigate up one level in the item(s) hierarchy
Next page
- go to the next page
Previous page
- go to the previous page
Set default asset type
- defines the asset type for a particular asset (e.g thumbnails)
- Asset Type Name:string
Load Item Level From Path
- loads an item based on it’s path in a hierarchy of folders
- path:string
Load page
- loads a specific page number based on the queried integer
- page number:string->specific page number to load
Load Item From Offset
- loads an asset based on it’s offset value in a set of items
- offset:string->String that represents offset to load
- increment:int->(optional)
Load Item Level
- loads an item based on it’s path in a hierarchy of folders
- path:string->String that represents level to load
Load Item By Id
- loads an item based on the id of the item itself
- itemid:string->
Events
Item OnLoad
- itemOffset:string->
- itemId:string->
- itemParentId:string->
- itemGroup:string->
- itemMediaFile:string->
- itemMediaType:string->
- itemMediaTitle:string->
- itemCaption:string->
- itemBodyText:string->
Item OnClick
- itemOffset:string->
- itemId:string->
- itemParentId:string->
- itemGroup:string->
- itemMediaFile:string->
- itemMediaType:string->
- itemMediaTitle:string->
- itemCaption:string->
- itemBodyText:string->
Page load
- pageoffset:string->
- nextpage:boolean->
- previouspage:boolean->
- isfirstpage:boolean->
- islastpage:boolean->
TextTicker (All Players)
Actions
SetSpeed
- sets the speed of the ticker
- Speed:string->insert ticker speed (e.g:very slow,slow,fast,very fast)
SetDirection
- sets the direction of the ticker
- Direction:string->insert ticker direction (e.g:righttoleft,lefttoright)
Events
OnTickerItemAvailable
- triggers an action when there is a text ticker item
OnItemLoaded
- triggers an action when a text ticker is loaded
RSSTicker (All Players)
Events
On Channel load
- name:string->
MediaTicker (DMP 4310, DMP 4400, Edge 300)
Actions
stop the media ticker
- stops the media ticker
start the media ticker
- starts the media ticker
RSSViewer (All Players)
Actions
Next
- shows the next RSS item
Previous
- shows the previous RSS item
Load Source Feed By Index
- loads an RSS feed item by source index
- sourceIndex:int->insert RSS feed index position in RSS source list(e.g:1,2,3)
Load Source Feed By Name
- loads an RSS feed item by source name
- sourceName:string->insert RSS feed name according to RSS source
loaditem
- loads RSS item
- offset:int->insert RSS item position number in RSS feed list(e.g:1,2,3)
Events
Item loaded
- itemName:string->item name
- itemTitle:string->item name
- itemImage:string->item name
- itemDescription:string->media name
PlainText (All Players)
Actions
Update Text From Url
- loads the latest updated text from a source URL based on the XML query
- url:string->the url
- xmlQuery:string->
Set Text
- displays the text based on the user’s text entry
- Text:string->insert text to display
Replace Text
- loads a new text in place of the previous text displayed
- Text:string->old text to replace
- Text:string->new text to replace
Events
Text changed
- text:string->text
RemoteControl (DMP 4310)
Events
Note
The following buttons cannot be bound to an action as they are reserved internally by the device:
- Help button
- Volume Up button
- Volume Down button
- Power button
| Event Name | Description |
|---|---|
| Number 1 button on press | Triggers a specific event when numeric button ‘1’ is pressed |
| Number 2 button on press | Triggers a specific event when numeric button ‘2’ is pressed |
| Number 3 button on press | Triggers a specific event when numeric button ‘3’ is pressed |
| Number 4 button on press | Triggers a specific event when numeric button ‘4’ is pressed |
| Number 5 button on press | Triggers a specific event when numeric button ‘5’ is pressed |
| Number 6 button on press | Triggers a specific event when numeric button ‘6’ is pressed |
| Number 7 button on press | Triggers a specific event when numeric button ‘7’ is pressed |
| Number 8 button on press | Triggers a specific event when numeric button ‘8’ is pressed |
| Number 9 button on press | Triggers a specific event when numeric button ‘9’ is pressed |
| Number 0 button on press | Triggers a specific event when numeric button ‘0’ is pressed |
| Command on toggle | Commands:string->command |
| Info button on press | Triggers an event when the ‘Info’ button is pressed (e.g display the information menu) |
| Help button on press | Displays the IP address of the device |
| Left button on press | Navigates left or to the previous item, depending on the situation |
| Right button on press | Navigates right or to the next item, depending on the situation |
| Up button on press | Navigates up one item/directory, depending on the situation |
| Down button on press | Navigates down one item/directory, depending on the situation |
| Page down button on press | Displays the next page for a set of items in the application |
| Page up button on press | Displays the previous page for a set of items in the application |
| Volume down button on press | Reduces the device volume |
| Volume up button on press | Increases the device volume |
| channel down button on press | Navigates to the previous channel of an application |
| channel up button on press | Navigates to the next channel of an application |
| blue button on press | Triggers a specific action when the blue-coloured button is pressed |
| red button on press | Triggers a specific action when the red-coloured button is pressed |
| green button on press | Triggers a specific action when the green-coloured button is pressed |
| yellow button on press | Triggers a specific action when the yellow-coloured button is pressed |
| guide button on press | Triggers an event when the ‘Guide’ button is pressed (e.g. display the programming/system guide) |
| menu button on press | Triggers an event when the ‘Menu’ button is pressed (e.g. display the main Menu) |
| exit button on press | Exits the current operation and returns to the previous screen |
| input button on press | Triggers an event when the ‘Input’ button is pressed (e.g. display the input options available) |
| last button on press | Triggers an event when the ‘Last’ button is pressed (e.g. return to the previous menu/layout) |
| rewind button on press | Rewinds the current media being played |
| fast forward button on press | Fast-forwards the current media being played |
| skip forward button on press | Skips to the next item on the list/playlist |
| stop button on press | Stops the current media being played |
| pause button on press | Pauses the current media being played |
| play button on press | Plays the selected media |
| mute button on press | Mute the volume during media playback |
| power button on press | Toggles the power status (on/off) |
| enter button on press | Confirms the selection of an item for further action |
KeyPad (DMP 4400)
Actions
Set Text
- displays the text based on the user’s text entry
- Text:string->set text to display
Load Template By Name
- loads selected template using template name as a parameter
- templatename:string->insert template name to load
Events
Key Click/Touch
- Name:string->
Done Key Click/Touch
- Name:string->
TableListing (DMP 4310, DMP 4400, Edge 300)
Actions
NextPage
- Goes to the next page in the table listing
PreviousPage
- Goes to the previous page in the table listing
Load Page
- loads a specific page to be displayed based on the entered value (page number)
- offset:int->page to load
- increment:int->item increment
Filter TableData
- filters the table to display data based on a specific text search and column location
- Text:string->filter to display
- Columns:string->Columns to search for
query TableData
- utilizes SQL query to filter and retrieve data from a table
- query:string->query to filter
Events
| Event Name | Description |
|---|---|
| Item Click/Touch | Name:string-> |
| Row Click/Touch | Name:string-> |
| Col Click/Touch | Name:string-> |
System (All Players)
Actions
Load VE
- loads selected application
- App Id:string->insert application id to load
Load Custom
- loads selected custom application
- App Name:string->insert custom application name
SendNetworkMessage
- sends script commands over the network to the media player
- IP:string->IP address (e.g:192.168.1.2)
- Port:string->port number to connect on
- Message:string->insert the message to send
- Message2:string->insert the message to send
- Message3:string->insert the message to send
- Delimiter:string->Message delimiter
- IncludeCR:string->it appends a carriage return to the message before sending (default value = true). this value is optional.
Application (All Players)
Actions
SendHttpPost
- sends data to third party program via HTTP post
- target:string->e.g: 192.168.1.2:81
- dataname:string->name of this data
- datavalue:string->insert value for this data
SetProperty
- this action allows you to create or update a property that is scoped to the current application.
- Key:string->insert property name
- Value:string->insert property value
ResetProperties
- clears all the current application properties.
Back
- goes back to the previously loaded layout.
NextLayout
- goes to the next layout in the playlist
PreviousLayout
- goes to the previous layout in the playlist
LoadLayoutByName
- loads selected layout using layout name as parameter
- layoutname:string->insert layout name to load
LoadLayout
- loads the selected layout
- LayoutID:layout->insert layout id to load
- Duration:string->insert layout playout duration
HideComponent
- hides a widget based on the id of the widget itself
- ComponentID:string->component id to hide
- hide:boolean->component visible.
- inverse:boolean->inverse the value. This value is optional, by default is false
Capture Interactive Metric
- this action allows you to send interactive metric to Appspace
- Metric Tree Name:string->Insert metric tree name
- Metric Object:string->Insert metric object
- Extra:string->e.g. key1:value1;key2:value2
Events
On Load
- Triggers an action when an application is loaded
Layout (All Players)
Events
On Load
*TimeStart:int->
On Unload
*TimeStart:int->