Difference between revisions of "Amarok/Manual/Playlist/AutomaticPlaylistGenerator"

Jump to: navigation, search
(Constraints)
m (Updated for 2.8)
 
(60 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category_Amarok]]
+
<languages/>
{{Construction}}
+
<translate>
  
= Automated Playlist Generator =
+
=== Automatic Playlist Generator === <!--T:1-->
  
The ''Automated Playlist Generator'' (APG) automatically generates playlists based on constraints you set, these constraints can be set based on song data (Author, Artist, Genre) or acess time(Last Time Played), there are also special constraints to determine how Amarok is going to look for songs. You will find the APG in your ''Media'' pane, <menuchoice>Playlists -> Automated Playlist Generator</menuchoice>.  
+
<!--T:2-->
 +
The '''Automated Playlist Generator (APG)''' automatically generates playlists based on constraints you set. These constraints can be set based on song data (artist, genre, year) or access time (last played). There are also special constraints to determine how '''Amarok''' is going to look for songs. You will find the ''APG'' in your '''Media Sources''' pane, <menuchoice>Playlists -> Automated Playlist Generator</menuchoice>.  
  
===APG Presets' toolbar===
+
==== APG Presets Toolbar ==== <!--T:3-->
  
[[File:Menuitems.jpg]]
+
<!--T:4-->
 +
[[File:Amarok-apg-presets-toolbar.png|center]]
  
This is the APG Presets' toolbar, from left to right we have the following buttons:
+
<!--T:5-->
 +
This is the '''APG Presets''' toolbar. From left to right we have the following buttons:
  
*Add new preset: Adds a blank preset that can be modified.
+
<!--T:21-->
*Edit selected preset: Opens up the ''APG Preset Editor'' window to edit the currently selected preset's constraints.
+
* {{Plus}} Adds a blank preset that can be modified.
*Delete selected preset: Removes the selected preset from the list, can '''NOT''' be undone.
 
*Import new preset: Import a preset from a .xml file, has the potential to be malformed if edited outside amarok, use the constraint tester.
 
*Export the selected preset: Export the selected preset to a .xml file that can be imported.
 
*Run constraint tester: Does nothing D:
 
*Run APG with selected preset: Loads APG with the selected preset and automatically generates a playlist.
 
  
=Setting up Presets=
+
<!--T:22-->
 +
* {{Icon|document-properties}} Opens up the '''APG Preset Editor''' window to edit the currently selected preset constraints.
  
[[File:APGpresetsMatchAllGroup.png‎‎|thumb|center|APG Preset Editor window]]
+
<!--T:23-->
 +
* {{Minus}} Removes the selected preset from the list; can ''not'' be undone.
  
Presets are sets of rules that Amarok's APG will use when generating playlists, these rules are going to be refered to as ''constraints'' from now on, every preset is determined by the constraints that make it up, groups of constraints hierachically and logically organized are called constraint trees.
+
<!--T:24-->
 +
* {{Icon|document-import}} Import a preset from a .xml file. Has the potential to be malformed if edited outside '''Amarok'''; use the constraint tester.
  
==Constraints==
+
<!--T:25-->
 +
* {{Icon|document-export}} Export the selected preset to a .xml file that can be imported.
  
Constraints are the building blocks of constraint trees, they are simple statements that the APG will use to add songs to the playlist it generates, to add a constraint to the currently selected preset's constraint tree use the ''Edit selected preset'' option from the APG Presets toolbar and click the <menuchoice>''Add new''</menuchoice> option on the ''APG Preset Editor'' window, note that this will add the constraint under the selected item (constraint or constraint group).
+
<!--T:27-->
 +
* {{Icon|go-next}} Loads '''APG''' with the selected preset and automatically generates a playlist.
  
Note that you can add many different kinds of constraints, each of them works in a different way inside the tree.
+
==== Working with Presets ==== <!--T:6-->
  
===Constraint Types===
+
<!--T:7-->
 +
[[File:APGpresetsMatchAllGroup.png|400 px|center|thumb|APG Preset Editor window]]
  
Amarok's APG supports several types of constraints, these are:
+
<!--T:8-->
 +
Presets are sets of rules that '''Amarok''' '''APG''' will use when generating playlists. These rules are going to be referred to as ''constraints'' from now on; every preset is determined by the constraints which create it. Groups of constraints hierarchically and logically organized are called constraint trees.
  
*''Match Tags'' constraints: The most important constraints, these can be set to virtually any information regarding the file, supported settings include: artist name, album name, genre, year, last time played, bpm, sample rate and score.
+
===== Constraints ===== <!--T:9-->
*''Playlist Duration'' constraints: These constraints set the running time (in HH:MM:SS format) that the playlist should have.
 
*''Playlist Length'' constraints; These constraints determine how many songs should be in the playlist.
 
*''Checkpoint'' constraints; Checkpoint constraints work by telling amarok where to start/stop looking for songs.
 
*''Prevent Duplicates'' constraints; These constraints prevent amarok from electing the same tracks, songs from the same artist, or the same album.
 
  
Note that you can change how constraints work in various manners, one of them is setting the fuzzy-exact slider, this slider determines how closely the constraint is going to be followed.
+
<!--T:10-->
 +
Constraints are the building blocks of constraint trees. They are simple statements that the '''APG''' will use to add songs to the playlist it generates. To add a constraint to the currently selected preset constraint tree click the {{Icon|document-properties}} button in the '''APG Preset toolbar''' and click the <menuchoice>Add new</menuchoice> option on the '''APG Preset Editor''' window. Note that this will add the constraint under the selected item (constraint or constraint group).<br /><br />
 +
Many different kinds of constraints can be added; each works in a different way inside the tree.
  
Another way to modify constraints that is present mainly on ''Match Tags'' ones is the option to set the option box at the left of the value to: ''contains'' (which will consider any songs that have the according text in their tag), ''matches'' (which will consider songs whose corresponding match exactly the one in the text box), ''starts with'' and ''ends with''.
+
===== Constraint Types ===== <!--T:11-->
  
You can also edit the way value-based (such as the Length constraints and the playcount Match Tag constrain) behave by changing the option close to the text to settings such as ''fewer than'', ''equals'' and ''more than''.
+
<!--T:12-->
 +
'''Amarok''' '''APG''' supports several types of constraints:
 +
{| <!--}-->
 +
! Constraint !! Description</translate>
 +
|-
 +
<translate>
 +
<!--T:28-->
 +
| <menuchoice>Match Tags</menuchoice> || The most important constraints, because they can be set to virtually any information regarding the file, including: artist name, album name, genre, year, last played, and score.</translate>
 +
|-
 +
<translate>
 +
<!--T:29-->
 +
| <menuchoice>Playlist Duration</menuchoice> || Set the running time (in HH:MM:SS format) that the playlist should have</translate>
 +
|-
 +
<translate>
 +
<!--T:30-->
 +
| <menuchoice>Playlist Length</menuchoice> || Determine how many songs should be in the playlist</translate>
 +
|-
 +
<translate>
 +
<!--T:31-->
 +
| <menuchoice>Checkpoint</menuchoice> || Tell '''Amarok''' where to start and stop looking for tracks</translate>
 +
|-
 +
<translate>
 +
<!--T:32-->
 +
| <menuchoice>Prevent Duplicates</menuchoice> || Prevent '''Amarok''' from selecting the same tracks, songs from the same artist, or the same album
 +
|} <!--{-->
  
Another way to change constraint behavior is to check the ''invert'' checkbox on them, this makes them behave the opossite way, a ''Match Tag: artist contains <name>'' becomes ''Match Tag: artist not contains <name>''.
+
<!--T:13-->
 +
Note that you can change how constraints work in various manners, such as setting the fuzzy-exact slider, which determines how closely the constraint is going to be followed.
  
 +
<!--T:33-->
 +
Another way to modify constraints that is present on <menuchoice>Match Tags</menuchoice> with a textbased tag is found in the line below the <menuchoice>Field</menuchoice> option box. In the text field to the right you write the text to be matched and in the option box at the left of the value you can select <menuchoice>contains</menuchoice> (which will consider any songs that have the according text in their tag), <menuchoice>matches</menuchoice> (which will consider songs whose corresponding tag match exactly the one in the text box), <menuchoice>starts with</menuchoice> and <menuchoice>ends with</menuchoice>.
  
 +
<!--T:34-->
 +
Similarly, you can also edit the way value-based constraints (such as the <menuchoice>Playlist Length</menuchoice> constraints and the playcount <menuchoice>Match Tag</menuchoice> constraint) behave by changing the option close to the text to settings such as <menuchoice>fewer than</menuchoice>, <menuchoice>equals</menuchoice> and <menuchoice>more than</menuchoice>.
  
 +
<!--T:35-->
 +
Another way to change constraint behavior is to check the <menuchoice>invert</menuchoice> checkbox on them, this makes them behave the opposite way, a "Match Tag: artist contains '''''name'''''" becomes "Match Tag: artist not contains '''''name'''''".
  
 +
===== Constraint Groups ===== <!--T:14-->
 +
 +
<!--T:15-->
 +
Constraint groups can be added from the <menuchoice>Add new</menuchoice> option from the '''APG Preset Editor''' window, constraints under a group are logically linked, the same applies to groups under groups.
 +
There are currently two kinds of constraint groups: "Match all" groups and "Match any" groups. "Match all" groups require that all the constraints under them are met by the song. "Match any" groups require that at least one of the constraints under them are met by the song. To add a constraint under a specific group highlight it on the preset editor and use the <menuchoice>Add new</menuchoice> option.
 +
 +
==== Using your Presets ==== <!--T:16-->
 +
 +
<!--T:17-->
 +
Once you set up a preset, you just have to select it on the '''APG Presets''' panel in the '''Automated Playlist Generator (APG)''' and click {{Icon|go-next}} the toolbar to run '''APG''' with the selected preset. You will then have a playlist matching your criteria, like this:
 +
 +
<!--T:18-->
 +
[[Image:Generatedlist.jpeg|thumb|300 px|thumb|center|Playlist generated by the constraint tree below.]]
 +
[[Image:Generatingtree.jpeg|thumb|400 px|center]]
 +
 +
 +
<!--T:19-->
 
{{Prevnext2
 
{{Prevnext2
| prevpage=path/to/article | nextpage=path/to/article
+
| prevpage=Special:myLanguage/Amarok/Manual/Playlist/DynamicPlaylists | nextpage=Special:myLanguage/Amarok/Manual/Various
| prevtext=previous section | nexttext=next section
+
| prevtext=Dynamic Playlists | nexttext=Various
| index= Amarok/Manual | indextext=Back Menu
+
| index=Special:myLanguage/Amarok/Manual | indextext=Back to Menu
 
}}
 
}}
 +
 +
<!--T:20-->
 +
[[Category:Amarok2.8]]
 +
[[Category:Multimedia]]
 +
[[Category:Tutorials]]
 +
</translate>

Latest revision as of 16:27, 1 July 2013

Other languages:
English • ‎dansk • ‎polski • ‎português do Brasil • ‎čeština

Automatic Playlist Generator

The Automated Playlist Generator (APG) automatically generates playlists based on constraints you set. These constraints can be set based on song data (artist, genre, year) or access time (last played). There are also special constraints to determine how Amarok is going to look for songs. You will find the APG in your Media Sources pane, Playlists -> Automated Playlist Generator.

APG Presets Toolbar

Amarok-apg-presets-toolbar.png

This is the APG Presets toolbar. From left to right we have the following buttons:

  • Icon-list-add.png Adds a blank preset that can be modified.
  • Icon-document-properties.png Opens up the APG Preset Editor window to edit the currently selected preset constraints.
  • Icon-list-remove.png Removes the selected preset from the list; can not be undone.
  • Icon-document-import.png Import a preset from a .xml file. Has the potential to be malformed if edited outside Amarok; use the constraint tester.
  • Icon-document-export.png Export the selected preset to a .xml file that can be imported.
  • Icon-go-next.png Loads APG with the selected preset and automatically generates a playlist.

Working with Presets

APG Preset Editor window

Presets are sets of rules that Amarok APG will use when generating playlists. These rules are going to be referred to as constraints from now on; every preset is determined by the constraints which create it. Groups of constraints hierarchically and logically organized are called constraint trees.

Constraints

Constraints are the building blocks of constraint trees. They are simple statements that the APG will use to add songs to the playlist it generates. To add a constraint to the currently selected preset constraint tree click the Icon-document-properties.png button in the APG Preset toolbar and click the Add new option on the APG Preset Editor window. Note that this will add the constraint under the selected item (constraint or constraint group).

Many different kinds of constraints can be added; each works in a different way inside the tree.

Constraint Types

Amarok APG supports several types of constraints:

Constraint Description
Match Tags The most important constraints, because they can be set to virtually any information regarding the file, including: artist name, album name, genre, year, last played, and score.
Playlist Duration Set the running time (in HH:MM:SS format) that the playlist should have
Playlist Length Determine how many songs should be in the playlist
Checkpoint Tell Amarok where to start and stop looking for tracks
Prevent Duplicates Prevent Amarok from selecting the same tracks, songs from the same artist, or the same album

Note that you can change how constraints work in various manners, such as setting the fuzzy-exact slider, which determines how closely the constraint is going to be followed.

Another way to modify constraints that is present on Match Tags with a textbased tag is found in the line below the Field option box. In the text field to the right you write the text to be matched and in the option box at the left of the value you can select contains (which will consider any songs that have the according text in their tag), matches (which will consider songs whose corresponding tag match exactly the one in the text box), starts with and ends with.

Similarly, you can also edit the way value-based constraints (such as the Playlist Length constraints and the playcount Match Tag constraint) behave by changing the option close to the text to settings such as fewer than, equals and more than.

Another way to change constraint behavior is to check the invert checkbox on them, this makes them behave the opposite way, a "Match Tag: artist contains name" becomes "Match Tag: artist not contains name".

Constraint Groups

Constraint groups can be added from the Add new option from the APG Preset Editor window, constraints under a group are logically linked, the same applies to groups under groups. There are currently two kinds of constraint groups: "Match all" groups and "Match any" groups. "Match all" groups require that all the constraints under them are met by the song. "Match any" groups require that at least one of the constraints under them are met by the song. To add a constraint under a specific group highlight it on the preset editor and use the Add new option.

Using your Presets

Once you set up a preset, you just have to select it on the APG Presets panel in the Automated Playlist Generator (APG) and click Icon-go-next.png the toolbar to run APG with the selected preset. You will then have a playlist matching your criteria, like this:

Playlist generated by the constraint tree below.
Generatingtree.jpeg



This page was last edited on 1 July 2013, at 16:27. Content is available under Creative Commons License SA 4.0 unless otherwise noted.