Revision as of 11:23, 10 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 - Device currently playing on?

<%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

<%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

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%>

@@ Line 1: / Line 1: @@
 [[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.
+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.
@@ Line 7: / Line 8: @@
 is the way to define a substitution.
 =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.
+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
@@ Line 19: / Line 22: @@
 ===<%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 - Device currently playing on?
+===<%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%>===
@@ Line 46: / Line 70: @@
 ===<%FBO%>===
 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
+== 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%>

Difference between revisions of "Orbiter Variables"