Overview

How to create hyperlink (start) parameters to use on buttons such as in Basic Home screens to open My Films with specific options.

Introduction

As of MediaPortal 1.2.0, a new property 'hyperlink parameter' has been added to the button control to open plugins with specific parameters or options.  See Open Plugins with a Parameter for details.

You may use hyperlink parameters to start My Films using several parameters or options.These are referred to as 'start parameters' and are used most often on Basic Home skin controls/buttons and in Basic Home Editors. However, they can be used on any button control in a skin XML file, such as to create a direct link from Moving Pictures or TV Series to My Films.

Developers wishing more information on integrating My Films start parameters in their plugin should see: Developer API.

Start Parameters

My Films provides a user-friendly interface to create start parameters for you. In Setup just click the StartParams button at the top of the Setup window:

Creating Start Parameters

Once you select the Start Params option, the following pop up window will display:

The parameters are basically the same as the options you can select in My Films setup for Default View and filter.

1. Load MyFilms Data - you must first load My Films data in to the Parameter creator!
2. Select the parameters you wish to add to your <hyperlinkParameter> tag:
   1. Config Selection: from the drop down list, select the config you wish to open on starting My Films
   2. View Selection: from the drop down list, select the view (e.g. "Year", "Category", "Country") you wish to open when starting My Films (if you are creating a global link for a skin be careful not to select a custom view you created that users may not have)
   3. Value to Filter movies: select a value to filter movies from the drop down list. The values in the list will vary depending on the view you select.
   4. Search Expression: search and select only films which match the search expression entered, e.g. 'Pixar' 
      Note:  searches are 'confined' to the films found by view and filter options if they exist.
   5. Layout: select the layout you prefer from the drop down list: e.g. List, Big Icons, Small Icons, Filmstrip, Coverflow
3. Create Start Parameters - click the button to generate your startup parameters
4. Resulting Start Parameters - displays the startup parameters you selected in step 2 above
   Example: config:Dadeo|view:Category|viewvalue:Animation|layout:1|search:Pixar

Now you can copy and paste the parameters to the <hyperlinkParameter> for your button:

• <hyperlinkParameter>config:Dadeo|view:Category|viewvalue:Animation|layout:1|search:Pixar</hyperlinkParameter>

Note: Users can also use the Start Parameters option to generate parameters to add to a Basic Home Editor field.

Related

• Skinning My Films