Difference between revisions of "Orbiter Variables"
(Added some more variables - Someone better look thru them and fix any description error) |
|||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{versioninfo}} | ||
[[Category: Programmer's Guide]] | [[Category: Programmer's Guide]] | ||
[[Category: Orbiters]] | [[Category: Orbiters]] | ||
| Line 4: | Line 5: | ||
=Variable Definition= | =Variable Definition= | ||
| − | Each time text has to be displayed, this text can be substituted by a variable. | + | Each time text has to be displayed or used in a designobj or command parameter, this text can be substituted by a variable. |
| − | <% | + | <%= %> |
is the way to define a substitution. | is the way to define a substitution. | ||
| + | |||
=Defined Variables= | =Defined Variables= | ||
==Cell Attributes <%=CA:xxxx%>== | ==Cell Attributes <%=CA:xxxx%>== | ||
| Line 12: | Line 14: | ||
Variables starting with CAV return a value of that specific variable. Variables starting with CAT return the text of that specific variable. | Variables starting with CAV return a value of that specific variable. Variables starting with CAT return the text of that specific variable. | ||
| − | ===<%CA:Name%>=== | + | ===<%=CA:Name%>=== |
Name of channel | Name of channel | ||
| − | ===<%CA:Info%>=== | + | ===<%=CA:Info%>=== |
Title of current broadcast | Title of current broadcast | ||
| − | ===<%CA:Synopsis%>=== | + | ===<%=CA:Synopsis%>=== |
Long synopsis of current broadcast | Long synopsis of current broadcast | ||
| − | ===<%CA:Time%>=== | + | ===<%=CA:Time%>=== |
Start time of current broadcast? | Start time of current broadcast? | ||
| − | ===<%CA:Date%>=== | + | ===<%=CA:Date%>=== |
Start date of current broadcast? | Start date of current broadcast? | ||
| − | ==Now Playing | + | ==Now Playing Information== |
| − | ===<%NP%>=== | + | ===<%=NP%>=== |
| − | Now Playing - Info about the currently playing media | + | Now Playing - Info about the currently playing media (title) |
| − | ===<%NP_MT%>=== | + | ===<%=NP_MT%>=== |
Now Playing Media Type - Info about the currently playing media type | Now Playing Media Type - Info about the currently playing media type | ||
| − | ===<%NP_SEC%>=== | + | ===<%=NP_SEC%>=== |
| − | Now Playing Section - Info about the currently playing section | + | Now Playing Section - Info about the currently playing section/chapter/track |
| − | ===<%NP_TIME_SHORT%>=== | + | ===<%=NP_TIME_SHORT%>=== |
| − | Now Playing | + | Now Playing - Current position in track HH:MM:SS |
| − | ===<%NP_TIME_LONG%>=== | + | ===<%=NP_TIME_LONG%>=== |
| − | Now Playing | + | Now Playing - as above plus total time of track |
| − | ===<%NP_SPEED%>=== | + | ===<%=NP_SPEED%>=== |
Now Playing - Current speed | Now Playing - Current speed | ||
| − | ===<%NPD%>=== | + | ===<%=NPD%>=== |
| − | Now Playing - Device | + | Now Playing - The Current Media Player device referenced by device -106. |
| − | ===<%NP_R%>=== | + | ===<%=NPDT%>=== |
| + | Now Playing Device Template - The Current Media Player device template referenced by device -106 | ||
| + | ===<%=NP_R%>=== | ||
Now Playing - Screen ID of the remote playing media? | Now Playing - Screen ID of the remote playing media? | ||
| − | ===<%NP_PR%>=== | + | ===<%=NP_PR%>=== |
Now Playing - DesignObj ID of the remote popup? | Now Playing - DesignObj ID of the remote popup? | ||
| − | ===<%NP_RNF%>=== | + | ===<%=NP_RNF%>=== |
Now Playing - Screen of remote | Now Playing - Screen of remote | ||
==Other== | ==Other== | ||
| − | ===<%LANIP%>=== | + | ===<%=LANIP%>=== |
Local IP address | Local IP address | ||
| − | ===<%RIP%>=== | + | ===<%=RIP%>=== |
Router IP address | Router IP address | ||
| − | ===<%RSI%>=== | + | ===<%=RSI%>=== |
Ripping Status Information | Ripping Status Information | ||
| − | ===<%LUV%>=== | + | ===<%=LUV%>=== |
Last Update Version | Last Update Version | ||
| − | ===<%!varname%>=== | + | ===<%=!varname%>=== |
Returns 0 if the variable is 1, otherwise a 1 is returned | Returns 0 if the variable is 1, otherwise a 1 is returned | ||
| − | ===<%E%>=== | + | ===<%=!%>=== |
| + | The device # of the orbiter rendering this instance of this screen. | ||
| + | |||
| + | ===<%=E%>=== | ||
Current Entertainment Area | Current Entertainment Area | ||
| − | ===<%MD%>=== | + | ===<%=MD%>=== |
Location info of current MD | Location info of current MD | ||
| − | ===<%OS%>=== | + | ===<%=OS%>=== |
Operating System | Operating System | ||
| − | ===<%CLOCK%>=== | + | ===<%=CLOCK%>=== |
Time - This is not constantly updated but only, when things change | Time - This is not constantly updated but only, when things change | ||
| − | ===<%MT%>=== | + | ===<%=MT%>=== |
Media Type | Media Type | ||
| − | ===<%MTB%>=== | + | ===<%=MTB%>=== |
Media Type Browse options | Media Type Browse options | ||
| − | ===<%MB_USERS%>=== | + | ===<%=MB_USERS%>=== |
Media Browse Private User | Media Browse Private User | ||
| − | ===<%FBO%>=== | + | ===<%=FBO%>=== |
Media File Browse Options | Media File Browse Options | ||
==Miscellaneous== | ==Miscellaneous== | ||
| − | ===<%B%>=== | + | ===<%=B%>=== |
return a \t | return a \t | ||
| − | ===<%N%>=== | + | ===<%=N%>=== |
return a \n | return a \n | ||
| − | ===<%ND%>=== | + | ===<%=ND%>=== |
Size of selected device | Size of selected device | ||
| − | ===<%DSDR%>=== | + | ===<%=DSDR%>=== |
Default Storage Device for Ripping | Default Storage Device for Ripping | ||
| − | ===<%DSDRN%>=== | + | ===<%=DSDRN%>=== |
Default Storage Device for Ripping Name | Default Storage Device for Ripping Name | ||
| − | ===<%SKIN%>=== | + | ===<%=SKIN%>=== |
Return the current skin | Return the current skin | ||
| − | ===<%SIZE%>=== | + | ===<%=SIZE%>=== |
Return the current size | Return the current size | ||
| − | ===<%SG%>=== | + | ===<%=SG%>=== |
Return the time this screen was generated | Return the time this screen was generated | ||
| − | ===<%LS%>=== | + | ===<%=LS%>=== |
Last selected floorplan object | Last selected floorplan object | ||
| − | ===<%SD%>=== | + | ===<%=SD%>=== |
All selected floorplan objects | All selected floorplan objects | ||
| − | ===<%STE%>=== | + | ===<%=STE%>=== |
Selected Telecom Extension | Selected Telecom Extension | ||
| − | ===<%R%>=== | + | ===<%=R%>=== |
Current Room | Current Room | ||
| − | ===<%U%>=== | + | ===<%=U%>=== |
| − | + | Current PK_Users value assigned to this orbiter (The current user using it.) | |
| − | ===<%UN%>=== | + | |
| + | ===<%=UN%>=== | ||
Current Users Name | Current Users Name | ||
| − | ===<%X%>=== | + | ===<%=X%>=== |
Current X coordinate ?! | Current X coordinate ?! | ||
| − | ===<%Y%>=== | + | ===<%=Y%>=== |
Current Y coordinate ?! | Current Y coordinate ?! | ||
| − | ===<%XS%>=== | + | ===<%=XS%>=== |
Difference between last X and new X? | Difference between last X and new X? | ||
| − | ===<%YS%>=== | + | ===<%=YS%>=== |
Difference between last Y and new Y? | Difference between last Y and new Y? | ||
| − | ===<%S%>=== | + | ===<%=S%>=== |
Last object | Last object | ||
| − | ===<%SID%>=== | + | ===<%=SID%>=== |
ID of current screen | ID of current screen | ||
| − | ===<%O%=== | + | ===<%=O%=== |
Current object | Current object | ||
| − | ===<%TS%=== | + | ===<%=TS%=== |
Current object | Current object | ||
| Line 126: | Line 134: | ||
Variables starting with A return the attributes of the specified attribute????? No idea. | Variables starting with A return the attributes of the specified attribute????? No idea. | ||
== E Variables == | == E Variables == | ||
| − | If the variable starts with an E it is an extender. i.e. ETIME returns a <%TIME%> | + | If the variable starts with an E it is an extender. i.e. ETIME returns a <%==TIME%> |
== T Variables == | == T Variables == | ||
The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234 | The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234 | ||
== V Variables == | == V Variables == | ||
Return the virtual device by the ID following V, i.e. V1234 returns the virtual device 1234 ??? | Return the virtual device by the ID following V, i.e. V1234 returns the virtual device 1234 ??? | ||
| + | == DD Variables == | ||
| + | Return the device data for the orbiter, i.e. DD100 returns the device data with PK = 100 | ||
== D Variables == | == D Variables == | ||
Return the name of the Device by the ID following D, i.e. D123 returns device 123 description. | Return the name of the Device by the ID following D, i.e. D123 returns device 123 description. | ||
Latest revision as of 21:29, 15 September 2014
| Version | Status | Date Updated | Updated By |
|---|---|---|---|
| 710 | Unknown | N/A | N/A |
| 810 | Unknown | N/A | N/A |
| 1004 | Unknown | N/A | N/A |
| 1204 | Unknown | N/A | N/A |
| 1404 | Unknown | N/A | N/A |
| Usage Information | |||
The orbiter fills text variables during run time. This page should give an overview over the variables and their contents. All the variables can be found in the Orbiter.cpp.prep source code, as well as in the source code of the <PVR>_Plugin sources.
Contents
- 1 Variable Definition
- 2 Defined Variables
- 2.1 Cell Attributes <%=CA:xxxx%>
- 2.2 Now Playing Information
- 2.3 Other
- 2.4 Miscellaneous
- 2.4.1 <%=B%>
- 2.4.2 <%=N%>
- 2.4.3 <%=ND%>
- 2.4.4 <%=DSDR%>
- 2.4.5 <%=DSDRN%>
- 2.4.6 <%=SKIN%>
- 2.4.7 <%=SIZE%>
- 2.4.8 <%=SG%>
- 2.4.9 <%=LS%>
- 2.4.10 <%=SD%>
- 2.4.11 <%=STE%>
- 2.4.12 <%=R%>
- 2.4.13 <%=U%>
- 2.4.14 <%=UN%>
- 2.4.15 <%=X%>
- 2.4.16 <%=Y%>
- 2.4.17 <%=XS%>
- 2.4.18 <%=YS%>
- 2.4.19 <%=S%>
- 2.4.20 <%=SID%>
- 2.4.21 <%=O%
- 2.4.22 <%=TS%
- 2.5 GD Variables
- 2.6 K Variables
- 2.7 A Variables
- 2.8 E Variables
- 2.9 T Variables
- 2.10 V Variables
- 2.11 DD Variables
- 2.12 D Variables
- 2.13 B Variables
- 2.14 all other =
Variable Definition
Each time text has to be displayed or used in a designobj or command parameter, this text can be substituted by a variable.
<%= %>
is the way to define a substitution.
Defined Variables
Cell Attributes <%=CA:xxxx%>
Cell attributes are filled by the PVR application and other datagrid filling apps.
Variables starting with CAV return a value of that specific variable. Variables starting with CAT return the text of that specific variable.
<%=CA:Name%>
Name of channel
<%=CA:Info%>
Title of current broadcast
<%=CA:Synopsis%>
Long synopsis of current broadcast
<%=CA:Time%>
Start time of current broadcast?
<%=CA:Date%>
Start date of current broadcast?
Now Playing Information
<%=NP%>
Now Playing - Info about the currently playing media (title)
<%=NP_MT%>
Now Playing Media Type - Info about the currently playing media type
<%=NP_SEC%>
Now Playing Section - Info about the currently playing section/chapter/track
<%=NP_TIME_SHORT%>
Now Playing - Current position in track HH:MM:SS
<%=NP_TIME_LONG%>
Now Playing - as above plus total time of track
<%=NP_SPEED%>
Now Playing - Current speed
<%=NPD%>
Now Playing - The Current Media Player device referenced by device -106.
<%=NPDT%>
Now Playing Device Template - The Current Media Player device template referenced by device -106
<%=NP_R%>
Now Playing - Screen ID of the remote playing media?
<%=NP_PR%>
Now Playing - DesignObj ID of the remote popup?
<%=NP_RNF%>
Now Playing - Screen of remote
Other
<%=LANIP%>
Local IP address
<%=RIP%>
Router IP address
<%=RSI%>
Ripping Status Information
<%=LUV%>
Last Update Version
<%=!varname%>
Returns 0 if the variable is 1, otherwise a 1 is returned
<%=!%>
The device # of the orbiter rendering this instance of this screen.
<%=E%>
Current Entertainment Area
<%=MD%>
Location info of current MD
<%=OS%>
Operating System
<%=CLOCK%>
Time - This is not constantly updated but only, when things change
<%=MT%>
Media Type
<%=MTB%>
Media Type Browse options
<%=MB_USERS%>
Media Browse Private User
<%=FBO%>
Media File Browse Options
Miscellaneous
<%=B%>
return a \t
<%=N%>
return a \n
<%=ND%>
Size of selected device
<%=DSDR%>
Default Storage Device for Ripping
<%=DSDRN%>
Default Storage Device for Ripping Name
<%=SKIN%>
Return the current skin
<%=SIZE%>
Return the current size
<%=SG%>
Return the time this screen was generated
<%=LS%>
Last selected floorplan object
<%=SD%>
All selected floorplan objects
<%=STE%>
Selected Telecom Extension
<%=R%>
Current Room
<%=U%>
Current PK_Users value assigned to this orbiter (The current user using it.)
<%=UN%>
Current Users Name
<%=X%>
Current X coordinate ?!
<%=Y%>
Current Y coordinate ?!
<%=XS%>
Difference between last X and new X?
<%=YS%>
Difference between last Y and new Y?
<%=S%>
Last object
<%=SID%>
ID of current screen
<%=O%
Current object
<%=TS%
Current object
GD Variables
Variables starting with GD return the graphical object by that ID. i.e. GD1234 returns graphic 1234?
K Variables
Variables starting with K return the variable by the name following the K. i.e. KSYNOPSIS returns the contents of the variable SYNOPSIS? q: Anyone has a list of these variables?!
A Variables
Variables starting with A return the attributes of the specified attribute????? No idea.
E Variables
If the variable starts with an E it is an extender. i.e. ETIME returns a <%==TIME%>
T Variables
The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234
V Variables
Return the virtual device by the ID following V, i.e. V1234 returns the virtual device 1234 ???
DD Variables
Return the device data for the orbiter, i.e. DD100 returns the device data with PK = 100
D Variables
Return the name of the Device by the ID following D, i.e. D123 returns device 123 description.
B Variables
something with Icons???
all other =
Returns content of said variable
