← Older revision

Revision as of 12:31, 10 July 2011

Line 44:

Now, let's start creating our first WDTVext plugin: '''Example.plugin.js'''

Now, let's start creating our first WDTVext plugin: '''Example.plugin.js'''

−

=== Example Plugin ===

+

== Example Plugin ==

−

==== Basic Plugin Skeleton ====

+

=== Basic Plugin Skeleton ===

Every Plugin strats with some basic plugin constructor:

Every Plugin strats with some basic plugin constructor:

Line 79:

All occurances of '''ExamplePlugin''' are of course to be substituted with the name of your plugin.

All occurances of '''ExamplePlugin''' are of course to be substituted with the name of your plugin.

−

==== Page Control ====

+

=== Page Control ===

−

===== Global Page Methods =====

+

==== Global Page Methods ====

−

====== Page.Top.getParam() / Page.Top.setParam() ======

+

===== Page.Top.getParam() / Page.Top.setParam() =====

This can be used in any function you create to read or write @@variables. The @@variables are referenced '''without''' @@!

This can be used in any function you create to read or write @@variables. The @@variables are referenced '''without''' @@!

Line 91:

</pre>

</pre>

−

====== Page.redraw() ======

+

===== Page.redraw() =====

Call this with argument '''true''' to force a page redraw:

Call this with argument '''true''' to force a page redraw:

<pre>

<pre>

Line 97:

</pre>

</pre>

−

===== onPageCreated =====

+

==== onPageCreated ====

This is called when a new page is created. This is the place where we add our extra content to display some cool output on the screen. So we are going to add two text lines to the menu page (fill this code into the above at the mentioned space).

This is called when a new page is created. This is the place where we add our extra content to display some cool output on the screen. So we are going to add two text lines to the menu page (fill this code into the above at the mentioned space).

Line 123:

'''@@exampleText''' and '''@@exampleKey'''. Since we haven't set those variables yet, we see... nothing! ;)

'''@@exampleText''' and '''@@exampleKey'''. Since we haven't set those variables yet, we see... nothing! ;)

−

===== onPageEnter =====

+

==== onPageEnter ====

Ok, having text elements we can't see isn't worth much... let's change that.

Ok, having text elements we can't see isn't worth much... let's change that.

Line 144:

Now we should see '''villa_home.xml''' as white text in upper left screen.

Now we should see '''villa_home.xml''' as white text in upper left screen.

−

===== onPageLeave =====

+

==== onPageLeave ====

Same as onPageEnter but when page is left.

Same as onPageEnter but when page is left.

Line 164:

</pre>

</pre>

−

===== onPageKey =====

+

==== onPageKey ====

Things are starting to get interesting with this event now.

Things are starting to get interesting with this event now.

Line 188:

−

===== onPageTimer =====

+

==== onPageTimer ====

The onPageTimer event gets called every ~500ms. You can use this to handle periodic events.

The onPageTimer event gets called every ~500ms. You can use this to handle periodic events.

Line 218:

</pre>

</pre>

−

==== Menu Control ====

+

=== Menu Control ===

On for the menus. Here I will show you how to create new menu items and manipulate existing ones. First we will link the '''Video''' mainmenu item directly to it's childs ('''Local Drives''') child '''Folders'''. So on entering Video on main menu will bring up the movie brower instantly. (Note: you won't be able to access all other items under '''Video''' then, like youtube, mediaservers, etc...)

On for the menus. Here I will show you how to create new menu items and manipulate existing ones. First we will link the '''Video''' mainmenu item directly to it's childs ('''Local Drives''') child '''Folders'''. So on entering Video on main menu will bring up the movie brower instantly. (Note: you won't be able to access all other items under '''Video''' then, like youtube, mediaservers, etc...)

−

===== Global Menu Methods =====

−

===== doBuildMenus =====

+

==== doBuildMenus ====

All the magic of creating new menu items happens in this function. So let's start with this.

All the magic of creating new menu items happens in this function. So let's start with this.

Line 240:

Line 239:

</pre>

</pre>

−

====== Menu.Top ======

+

===== Menu.Top =====

Globaly access menu item properties. These are accessed as shown in the the above example code. To find out the right title (they are case sensitive!), it's useful to write a some logging/displaying code as i've shown with the markup file name in the page section (using '''onMenuSelect()''').

Globaly access menu item properties. These are accessed as shown in the the above example code. To find out the right title (they are case sensitive!), it's useful to write a some logging/displaying code as i've shown with the markup file name in the page section (using '''onMenuSelect()''').

−

====== new Menu() ======  

+

===== new Menu() =====

Let's create a new menu item now. This is going to be a quite simple reboot option.

Let's create a new menu item now. This is going to be a quite simple reboot option.

Line 255:

Line 254:

the parameters are '''Menu( name, title, image, focusedImage, visible)'''.

the parameters are '''Menu( name, title, image, focusedImage, visible)'''.

−

====== addChild() ======

+

===== addChild() =====

Now we add a submenu item to which will actually reboot the wdtv when selected.

Now we add a submenu item to which will actually reboot the wdtv when selected.

Line 274:

Line 273:

−

===== onMenuSelect =====

+

==== onMenuSelect ====

−

===== onMenuDeselect =====

+

==== onMenuDeselect ====

← Older revision		Revision as of 13:14, 6 April 2015
Line 279:		Line 279:
	==== onMenuDeselect ====		==== onMenuDeselect ====

		+
		+	== Repository ==
		+	If you want to maintain your plugin in the WDTVExt web repository, you MUST supply some meta-info inside your script.
		+
		+	/*
		+	# meta-name="OSD Notice"
		+	# meta-desc="Plugin to display short OSD notices"
		+	# meta-author="recliq"
		+	# meta-date="2011-07-18"
		+	# meta-version="1.0.0"
		+	# meta-type="wdtvext"
		+	# meta-url="http://forum.wdlxtv.com"
		+	# meta-filename="OSDNotice.plugin.js"
		+	*/

	== Reference ==		== Reference ==

@@ Line 196: / Line 196: @@
 <pre>
 ExamplePlugin.prototype.onPageTimer = function(page) {
+    // return if there's no page, important or may cause crashes when omitted !!
      // again we want this only to execute on main menu...
      if(page.markupFileName == "villa_home.xml"){

@@ Line 4: / Line 4: @@
 = Develop - WDTVExt Plugins =
-<b styple="color:red">WDTVExt is not available for firmware fersion higher than 1.02.21!</b><br>
+<b style="color:red">WDTVExt is not available for firmware versions higher than 1.02.21!</b><br>
 WDTVExt allow to add custom plugins/extensions to WDlxTV 1.02.21 firmware.<br>
 These plugins are written in [https://developer.mozilla.org/en/JavaScript/Guide JavaScript].

DevelopWDTVExtPlugin - Revision history

Recliq at 13:14, 6 April 2015

Recliq at 13:03, 13 January 2015

Recliq at 12:31, 10 July 2011

Recliq at 12:26, 10 July 2011