Revision as of 16:06, 13 October 2008

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, 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 Informatio

<%=NP%>

Now Playing - Info about the currently playing media

<%=NP_MT%>

Now Playing Media Type - Info about the currently playing media type

<%=NP_SEC%>

Now Playing Section - Info about the currently playing section

<%=NP_TIME_SHORT%>

Now Playing ??

<%=NP_TIME_LONG%>

Now Playing ??

<%=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 onscreen orbiter.

<%=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 currnet 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 ???

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