What plugins can do

[NeBlackCat]

Is there a high level overview on what a plugin is able to do, anywhere?

I've seen a few on the mechanics of writing one, but not the executive summary on what can be done in a plugin.

For example, the obvious one is implementing new functionality via a new "main menu" option.

But I was wondering to what extent it's possible for a plugin to (for example) modify the behavior of other plugins (and in what way), control access to them, monitor what is going on in them, etc?

[fluffykeith]

There is no summary that I have found.

I am trying to put together an understanding. There is a lack of docs / info but if you ask here then there is always someone that knows.

My summary (and correct me / enhance it as required).

Plugin - can cause emulated keypresses, receive notifications, access the database and do any normal program stuff. So probably not much limit, except the documentation!

I think it is not possible to modify behaviour on existing plugins, apart from send them keypresses.

I am trying finding info on the classes a plugin can use. IMenu is defined in the wiki but there is no doc for UITask, notifications, or anything else, except the plugin examples.

[pastro]

There is no summary that I have found.

I am trying to put together an understanding. There is a lack of docs / info but if you ask here then there is always someone that knows.

My summary (and correct me / enhance it as required).

Plugin - can cause emulated keypresses, receive notifications, access the database and do any normal program stuff. So probably not much limit, except the documentation!

I think it is not possible to modify behaviour on existing plugins, apart from send them keypresses.

I am trying finding info on the classes a plugin can use. IMenu is defined in the wiki but there is no doc for UITask, notifications, or anything else, except the plugin examples.

I have found it easier to use javawiz's tools. He includes examples of most of the stuff you will likely want to do as well

[fluffykeith]

I was hoping to be able to create a basic plugin then if needed add in the extensions that others have done.
I've been looking at the plugin examples - and I have a few questions.

Is there an example using notifications?

Can someone give an insight into how the GbpvrUiElement fits together with the skin?

Also is the GbpvrUiElements as on http://gbpvr.com/pmwiki/pmwiki.php/Devel...UiElements
the same or is this something extra.

Is the BaseButtonUiTask the basic standard screen with a menu on the left and a list box on the right? Am I right in thinking that if you want more that that then you supply a list of GbpvrUiElement items to render.

How is one GbpvrUiElement removed to give the effect of a new screen, eg the different views in the weather plugin - assuming they partially cover each other one will need removing when the other is shown.

Am I barking up the wrong tree (or just barking - no answer required!)

Thanks for any overview you can give.

[McBainUK]

The GbpvrUiElements library is no longer supported (by me). For PVRX2 plugin development I recommended JavaWiz's excellent tool-kit: http://forums.nextpvr.com/showthread.php?t=28469

[psycik]

I was hoping to be able to create a basic plugin then if needed add in the extensions that others have done.
I've been looking at the plugin examples - and I have a few questions.

Is there an example using notifications?

Prob not, There's not much to it. Implement the interface and then see the messages come out, basically they're things like audio track started, stopped, video started, stopped. I use them for ML2.

Can someone give an insight into how the GbpvrUiElement fits together with the skin?

A GBpvrUIElement is normally a skin Placement and composite image. So a placement for specifying where (and size) and a composite image for specifying size again, and what's in it, image, text etc.

Is the BaseButtonUiTask the basic standard screen with a menu on the left and a list box on the right? Am I right in thinking that if you want more that that then you supply a list of GbpvrUiElement items to render.

Yes, it's a cut down all in one task for a simple list and button based plugin (ie subs netradio etc. It works well for that task, but if you need other windows then you tend to find it easier to start with a blank IMenuTask and the other one(?!? can't remembr name) and populate the GetRenderList by hand.

How is one GbpvrUiElement removed to give the effect of a new screen, eg the different views in the weather plugin - assuming they partially cover each other one will need removing when the other is shown.

Probably by not drawing it. In the GetRenderList you'd you a "Middle" screen, or element, or group of elements. Then depending on what youre displaying you would call up the group and display them as needed.

I'm not sure how JavaWiz does it in his tools, but i split everything into "Panels" and "Screens" my ML2 for example has two "screens" the library and the playlists - the library is made up of three panels (each panel being a list UISimpleLIst I think it's called), the playlist screen two panels with two lists.

The GBPVRUIElement tends to be for the other things on the screen, the coloured buttons and descriptions, the album art box.


Bit rambley but hopefully useful.

[JavaWiz]

At this point I believe there are basically three approaches to creating a plugin.

1) Use subs built-in helper classes and extend to suite your needs. Extend BaseButtonUiTask which implements most of the basic stuff a plugin has. The nice thing is the built in list functionality allows you to switch between Icon/List/Details and Filmstrip mode. This thread should get you started. There is also some information here.

2) Use WizTools. Wiz tools supply a list of controls that you are probably familiar with (button, list, textbox, label), that expose properties that are also familiar (enabled, visible, text, itemList,...). The constructors for each control tie the plugin to the skin.xml. It contains a tutorial and sample plugin to help you get started. It hides alot of the details for creating and showing elements in the controls themselves.


3) Roll your own. Basically implement the necessary interfaces (IMenuTask, IUiTask) and create each screen element (GBpvrUiElement) manually and all the logic needed to render and manipulate the elements.


At first it seems a bit overwhelming, but start with a simple HelloWorld type plugin, and work up from there. In a week or two it will all gel and the pieces will start to make sense.

Good luck!

[fluffykeith]

Thanks for the info.

I guess WizTools is used quite a bit and fairly mature and well tested. It does seem the sensible approach. Are there any overheads with using it for simple plugins?

Basically I have two plugins that I want to create:
1. very basic one, a few buttons on the left and on the right a text window that scrolls (a log window), plus a list window with check marks, or highlighting or something.

2. This is where I suspect I will need the low level stuff but if WixTools can do it that would be great. Essentially I want a set of icons (arbitrary shape, transparent bits a big bonus) that act as buttons preferably different on/off images that can be located in arbitrary positions on a background image. The positions can be fixed, ie they don't dynamically move.

I guess my question should really be, If I go the WizTools route will using it hide some of the detail that I may need access to?

Thanks again for all the info.

Keith

[fluffykeith]

This thread should get you started.
Good luck!

This link does not seem to work for me - it says something about permissions :confused:

The other link is very useful, thanks.

[fluffykeith]

Ah - JavaWiz - I found you documentation

I guess the skeleton example covers most things and if I want less I just delete it so I'm not creating a bloated plugin.

I've been reading bits here and there - can't play at the moment (at work!!) - but I have what is probably the most basic question. But just to confirm I have figured out at least one small bit.

In the skin part I see this kind of thing:
<Placement name="TextBox" loc="5.0, 70.0" size="20.0,5.0" />

new WizUiTextBox(skinHelper, "TextBox", "An ....

The name TextBox can be anything, eg "fred"? and the composite image part is just specifying the style used which can be specified in the WizUiTextBox constructor.

If I don't add controls to the control manager I will have a blank screen, right?

What specifies the image / color or whatever of this blank screen / background?

I think I am warming to WizTools!