Difference between revisions of "Orbiter Variables"

From LinuxMCE
Jump to: navigation, search
(New page: Category: Programmer's Guide Category: Orbiters The orbiter fills text variables during run time. This page should give an overview over the variables and their contents. =Variable...)
 
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{versioninfo}}
 
[[Category: Programmer's Guide]]
 
[[Category: Programmer's Guide]]
 
[[Category: Orbiters]]
 
[[Category: Orbiters]]
−
The orbiter fills text variables during run time. This page should give an overview over the variables and their contents.
+
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.
 +
 
 
=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=
−
==Channel Array <%=CA:xxxx%>==
+
==Cell Attributes <%=CA:xxxx%>==
−
Channel Array is filled by the PVR application
+
Cell attributes are filled by the PVR application and other datagrid filling apps.
−
===<%CA:Name%>===
+
 
 +
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
 
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 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==
 
==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
−
===<%NP%>===
+
==Miscellaneous==
−
Now Playing - Info about the currently playing media
+
===<%=B%>===
−
===<%NP_MT%>===
+
return a \t
−
Now Playing Media Type - Info about the currently playing media type
+
===<%=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

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.

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

Retrieved from "http://wiki.linuxmce.org/index.php?title=Orbiter_Variables&oldid=35200"