Smart playlists/XSP Method - Revision history

Karellen: Updated for v20

2023-02-12T23:02:14Z

Updated for v20

← Older revision		Revision as of 23:02, 12 February 2023
Line 5:		Line 5:

	= Location of XSP Files =		= Location of XSP Files =
	The XSP ('''X'''BMC '''S'''mart '''P'''laylist) files are located in the '''[[userdata]]/playlists''' folder. The location of this folder for each platform is shown in the table below.		The XSP ('''X'''BMC '''S'''mart '''P'''laylist) files are located in the '''[[userdata]]/[[Userdata#playlists\|playlists]]''' folder. The location of this folder for each platform is shown in the table below.

	Within the /''playlists''/ folder are three subfolders - ''mixed, music'' and ''video''. Playlists must be saved in the correct subfolder.		Within the /''playlists''/ folder are three subfolders - ''mixed, music'' and ''video''. Playlists must be saved in the correct subfolder.

	After saving a XSP file, there is normally no need to restart {{kodi}}, but if the Smart Playlist Manager is active, exit out and re-enter to display the new XSP files.		After saving a XSP file, there is normally no need to restart {{kodi}}, but if the Smart Playlist Manager is active, you may need to exit out and re-enter to display the new XSP files.

	{{#lst:Userdata\|location all}}		{{#lst:Userdata\|location all}}
Line 15:		Line 15:

	= Editing XSP Files =		= Editing XSP Files =
	Smart playlists are plain text files that any text editor can create, but we recommend using an editor that can parse XML such as [[w:~~Visual_studio\|~~Visual Studio]] or [https://notepad-plus-plus.org/ Notepad++].		Smart playlists are plain text files that any text editor can create, but we recommend using an editor that can parse XML such as [https://code.visualstudio.com/Download Visual Studio Code] or [https://notepad-plus-plus.org/ Notepad++].


Line 156:		Line 156:
	{{top}}		{{top}}

	{{updated\|19}}		{{updated\|20}}

	[[Category:Karellen]]		[[Category:Karellen]]
	[[Category:Music library]]		[[Category:Music library]]
	[[Category:Video library]]		[[Category:Video library]]

Karellen at 02:19, 8 March 2021

2021-03-08T02:19:34Z

← Older revision		Revision as of 02:19, 8 March 2021
Line 156:		Line 156:
	{{top}}		{{top}}

	{{updated\|18}}		{{updated\|19}}
	~~[[Category:Index]]~~
	~~[[Category:Guides]]~~
	~~[[Category:Manual]]~~
	[[Category:Karellen]]		[[Category:Karellen]]
	[[Category:Music library]]		[[Category:Music library]]
	[[Category:Video library]]		[[Category:Video library]]
	~~[[Category:Advanced topics]]~~

Karellen: Update links

2020-11-16T20:26:27Z

Update links

← Older revision		Revision as of 20:26, 16 November 2020
Line 108:		Line 108:
	The <code><value></code> tag provides the string to be matched.		The <code><value></code> tag provides the string to be matched.

	For a list of available fields and operators see... '''[[Smart_playlists/~~Operators~~\|~~Operators~~]]'''		For a list of available fields and operators see... '''[[Smart_playlists/Rules_and_groupings\|Rules & Groupings]]'''


Line 123:		Line 123:
	* Enabled - Will show the collection that the matching movies belong to as well as the individual movies that do not belong to a set/collection.		* Enabled - Will show the collection that the matching movies belong to as well as the individual movies that do not belong to a set/collection.

	For a list of available groupings see... '''[[Smart_playlists/~~Operators~~\|~~Operators~~]]'''		For a list of available groupings see... '''[[Smart_playlists/Rules_and_groupings\|Rules & Groupings]]'''

Karellen: Page creation

2020-11-14T02:45:31Z

Page creation

New page

{{:Smart_playlists/Contents}}
{{mininav|[[Playlists]] | [[Smart playlists]] }}

= Location of XSP Files =
The XSP ('''X'''BMC '''S'''mart '''P'''laylist) files are located in the '''[[userdata]]/playlists''' folder. The location of this folder for each platform is shown in the table below.

Within the /''playlists''/ folder are three subfolders - ''mixed, music'' and ''video''. Playlists must be saved in the correct subfolder.

After saving a XSP file, there is normally no need to restart {{kodi}}, but if the Smart Playlist Manager is active, exit out and re-enter to display the new XSP files.

{{#lst:Userdata|location all}}

= Editing XSP Files =
Smart playlists are plain text files that any text editor can create, but we recommend using an editor that can parse XML such as [[w:Visual_studio|Visual Studio]] or [https://notepad-plus-plus.org/ Notepad++].

= Breakdown of XSP File =
The XSP file consists of the following:
* Two header tags, <code><name></code> and <code><match></code>
* One or more <code><rule></code> tags that define the rules to use
* A <code><limit></code> tag to limit the returned results
* A <code><group></code> tag to allow grouping of results
* An <code><order></code> tag to sort the display of the results

{{Note|All tags and attributes are case-sensitive.}}

The following example is used to explain each component of the code.

<syntaxhighlight lang=xml line='line'>
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<smartplaylist type="movies">
<name>SciFi by Year</name>
<match>all</match>
<rule field="genre" operator="is">
<value>Science Fiction</value>
<value>Sci-Fi</value>
<value>SciFi</value>
</rule>
<group>years</group>
<limit>100</limit>
<order direction="descending">lastplayed</order>
</smartplaylist>
</syntaxhighlight>

== XML Declaration ==
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
</syntaxhighlight>
Must be the first line of the XSP file and there are no variations.

== Top Level Tags ==
<syntaxhighlight lang=xml>
<smartplaylist type="movies">
</smartplaylist>
</syntaxhighlight>
Top level parent tag which also defines the media type. Only one type can be used and different types of media cannot be mixed into a single playlist.

Available types:
* Songs
* Albums
* Artists
* Movies
* TV shows
* Episodes
* Music Videos
* Mixed - used to combine Music and Music Videos.

== Name ==
<syntaxhighlight lang=xml>
<name>SciFi by Year</name>
</syntaxhighlight>
The name of the playlist. The name you enter here will be displayed in {{kodi}}.

== Match ==
<syntaxhighlight lang=xml>
<match>all</match>
</syntaxhighlight>
If two or more rules have been created add the appropriate rule matching method. If only one rule, use the default '''all'''
* '''all''' - an item must match all rules for it to be displayed in the list
* '''one''' - an item needs to match only one of the rules for it to be displayed in the list

== Rules ==
<syntaxhighlight lang=xml>
<rule field="genre" operator="is">
<value>Science Fiction</value>
<value>Sci-Fi</value>
<value>SciFi</value>
</rule>
</syntaxhighlight>
The rule determines how your titles are filtered and added to the smart playlist.

A rule can have multiple <value> entries. Multiple rules can be used in a single smart playlist.

The tag has two attributes:
* <code>field</code> - Determines which field in the database the rule is applied to
* <code>operator</code> - Specifies how rule is to be applied. All matching is done case-insensitive. See the Available Rules page for available operators

The <code><value></code> tag provides the string to be matched.

For a list of available fields and operators see... '''[[Smart_playlists/Operators|Operators]]'''

== Group ==
<syntaxhighlight lang=xml>
<group>years</group>
</syntaxhighlight>
Adds grouping to the results. The displayed list will consist of folder nodes containing matching media items.

eg Selecting group by '''genre''' will open a list of all the genres that are used by the titles that match the rules. Then select a genre to see the title list.

The '''mixed''' operator can only be used when '''Sets''' is chosen as the value. It allows combining of what is considered two classes of media - a ''set/collection'' and a ''movie''
* Disabled - Will only list the collection for movies that belong to a Set. Enter a collection to see the individual movie(s) that match the rule(s).
* Enabled - Will show the collection that the matching movies belong to as well as the individual movies that do not belong to a set/collection.

For a list of available groupings see... '''[[Smart_playlists/Operators|Operators]]'''

== Limit ==
<syntaxhighlight lang=xml>
<limit>100</limit>
</syntaxhighlight>
Used to limit the number of matches in the list. You may want to display all matches or limit to the first 100 matches, for example.

To display all items, omit the tag.

== Order ==
<syntaxhighlight lang=xml>
<order direction="descending">lastplayed</order>
</syntaxhighlight>
The order tag will determine the order of the items in the list.

The <code><order></code> tag has a <code>direction</code> attribute which can be <code>ascending</code> or <code>descending</code>.

The value can be any value that is used in the Rule field.

For '''random''' order use <code><order>random</order></code>. Random should be used with care as it can be slow on large libraries.

'''Note:'''
* The rule fields and rule operators can change between {{kodi}} versions. If unsure of available fields and operators, use the GUI method to create the start of your playlist to pre-fill in the unknown fields and operators.

{{top}}

{{updated|18}}
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]
[[Category:Advanced topics]]