# The Amarok Handbook

This documentation was converted from the KDE UserBase Amarok/Manual page.
&FDLNotice;
2018-05-21
2.9.0

&amarok; is a free, versatile and powerful music player for &Linux;. The latest 2.x release series, often referred to as Amarok 2, is cross-platform (can be used on many platforms, including &Linux;, &MacOS; and &Microsoft; &Windows;) and implements a completely reworked code base that will enable it to incorporate exciting new features as the release matures. The current stable release is version 2.4.

KDE
multimedia
player
audio
ogg
mp3
wav
music
sound

## Amarok: Rediscover your music!

Amarok 2.8 default layout

&amarok; is the premier Free, Open Source Music application. More than simply a music player, &amarok; helps you rediscover your music. The innovative interface gives you unprecedented control over your collection, and extends your reach to music everywhere. Use our Quick Start Guide to get going quickly, or search out more in-depth information in this handbook.

## Quick Start Guide

Congratulations on installing &amarok;, the most advanced music discovery software available. &amarok; will help you explore your music, and enjoy it as never before. Also, you can tour different sources of music, radio stations and audio books online. In this guide, we'll show you how to let &amarok; find your collection, play it for you, and also how to use &amarok; to find things online. We'll assume that you know nothing about &amarok;, but do know how to use menus, a mouse, and your keyboard.

1. Getting started

   1. Starting Amarok

   2. Closing Amarok

2. The Amarok window

   1. Default layout of the Amarok window

   2. Using the Amarok window to manage and play your music

3. The Music Collection

   1. The Media Sources Pane

   2. Setting up a collection

   3. Adding Media Devices to the Collection

   4. Ripping a CD into the collection

   5. Accessing other media sources

   6. Streams and Podcasts

   7. Using the Content Browser

      1. Hiding or expanding information

      2. Changing the order of tracks and albums

      3. Deleting items from the collection

4. Playlists

   1. The Playlist pane

   2. Adding music to a playlist

   3. Using the Toolbar

   4. Manipulating playlists

      1. Removing a track

      2. Using the Playlist tools at the bottom

   5. Saving and retrieving your favorite playlists

5. The Context View

   1. Default layout

   2. Customizing the Context pane

6. How to deal with problems

7. Glossary

### Getting started

#### Starting Amarok

If you already know your way around your operating system, you probably also know how to start &amarok;, and you can continue. Else, continue reading.

##### From Plasma

If you are running the Plasma Workspace, you can start &amarok; by either:

- pressing on Kickoff and then Multimedia Amarok.

- invoking KRunner (&Alt;F2 by default), entering `amarok` and then pressing &Enter;.

##### From the file manager

Open a multimedia file that &amarok; is known to play.

#### First Time

The first time you use &amarok;, a dialog box will come up asking you to specify your locale:

Next, a First Start dialog box will come up asking you to specify where your music is located. If you have a music directory already configured in your system, &amarok; should detect it and ask you to use it:

If you select No in this dialog, you will be presented with another one which allows you to select your music folder:

See Setting Up a Collection

Once you have selected the folder where your music is, &amarok; will scan the folder and sub-folders, creating the collection. This can take some time, depending on the number of tracks and the speed of the location.

#### Closing Amarok

If you want to close &amarok;:

- Type &Ctrl;Q when you are in the &amarok; window, or

- Select the Quit option in the &amarok; menu, or

- Right-click on the blue wolf icon in the System Tray at the bottom of your screen. You will be presented with the following:

If you close the &amarok; window by clicking Close on the window border, &amarok; will continue to run in the background and only show the blue wolf icon in the System Tray:

If you log out of your session or shut down your computer without quitting &amarok;, some of your settings will not be saved.

### The Amarok window

The &amarok; window is designed to let you rediscover your music. So, it gives you as much information about your music as possible. While many users will enjoy the default layout, it is fully customizable.

#### Default layout of the Amarok window

Upon installation, &amarok; will look like this:

Amarok 2.8, newly installed

Amarok 2.8, newly installed

The &amarok; window has four main parts:

1. under the top-level menus is the Toolbar which lies above three panes:

2. your Media Sources (music collection and other media) in the left pane,

3. the Context pane in the center, and

4. the Playlist in the right-hand pane.

#### Using the Amarok window to manage and play your music

Playing music using &amarok; usually takes two steps:

1. Create a playlist by selecting some of the tracks in your collection, which you will find listed in the Media Sources pane, and send your music to the Playlist pane.

2. Play the music in your playlist, using the Playlist pane and/or the Toolbar.

Also, you may want to transfer some of your music to a mobile music player, such as an iPod. The next sections will explain how.

### The Music Collection

#### The Media Sources pane

The Media Sources pane is the place where you browse and display your complete collection of music. This includes the tracks on your local hard disk, as well as those on any external devices or media connected to your computer, such as audio CD, USB devices, media players, network disks or Internet sources.

#### Setting up a collection

Do you have music tracks in mp3, Ogg or FLAC format on your computer? Begin by telling &amarok; where to find those files, so it can create your collection. In the top-level menu: Settings Configure Amarok Local Collection.

Configure Collection Dialog, as of version 2.8

Configure Collection Dialog, as of version 2.8

A tree-view of your home directory is shown above. Click the check box where your music is stored; usually home Music. Then choose Fully Rescan Entire Collection. This will take some time, so do not be alarmed if &amarok; seems slow for a while. Once the scan is complete, it is best to quit &amarok; using the top-level &amarok; menu, or &Ctrl;Q, and then restart it. Your newly-added music should show up under the Local Collection section.

More about configuring your collection here.

The set of multimedia formats recognized by &amarok; is not restricted to those mentioned above; is controlled by the Phonon back end.

#### Adding Media Devices to the Collection

Underneath the search bar near the top of the Media Sources pane you see the different devices and/or content categories within the Content Browser. If you insert an Audio CD in the CD drive it will appear in the Media Sources pane, along with media players, thumb drives, and other USB devices. After an external device has been mounted, it will show automatically within the Media Sources pane.

Below is a screenshot showing three connected sources with music: Audio CD, mp3 player, and the Local Collection.

#### Ripping a CD into the collection

If you don't have any music files on your computer, it's easy to rip them (copy the tracks from your CDs to your collection). Just pop in a CD, and right-click on the banner of the CD device in the Content Browser to play, or copy to your collection, which will rip and tag your tracks (see image below). If you copy music from an audio CD to your Local Collection, the message bar at the bottom of the &amarok; window will indicate that it is busy copying. The ripping may take several minutes. Once the rip is complete, the message in the message bar disappears and the music appears in the content browser of your Local Collection. If the ripped music does not appear in your Media Sources pane it's best to quit &amarok; from the &amarok; top-level menu, or &Ctrl;Q, and then restart it. Now you should see it in your collection. The screenshot below shows how you move tracks from your audio CD, iPod or other device to your collection, using the context (right-click) menu.

In the above context menu, you can also see the choice to Edit Track Details. Use this option if you have a track that needs a tag edited. This becomes important when you rip music to .WAV format, losing some of the tags. If quite a bit of your collection needs tagging, consider dedicated tagging software, such as

- Picard

- EasyTag

- Kid3

Correct tagging is important to help &amarok; show your tracks in the appropriate albums and proper sort order. Learn more about ripping and tagging.

#### Accessing other media sources

You might have wondered why the Media Sources pane is not called the 'Collections' pane. &amarok; gives you access to much more music than just your collection -- Internet shops, audio books, podcasts, music files stored outside your collection, and previously stored playlists. The &amarok; breadcrumb navigation is the key to all of this. The starting icon for the breadcrumb navigation is the home folder icon at the extreme top left of the Media Sources pane. This icon expands and contracts as you browse through the Media Sources pane, allowing you to easily navigate your collection by clicking your desired folder in the breadcrumb bar.

If you click the &amarok; home folder you see the Media Sources pane on the left below, containing icons to available resources. If you click Files (left image below, second item from the bottom), you will see something similar to the image on the right, below. Notice how the breadcrumb bar expands and how the content of the selected folder is shown in the Media Sources pane (right image below). Clicking the > symbols among the breadcrumbs allows you to view the folders available at that level of the folder structure. The &amarok; file browser gives you access to your entire file system, even outside your Local Collection.

Media Sources pane | Files icon clicked
--- | ---

The functions of the icons in the &amarok; Home folder (left above) are:

Icon | Name | Action
--- | --- | ---
| Local Music | Your &amarok; collection
| Internet | Internet shops such as Magnatune, Jamendo and Last.fm. First configure your internet resources in: Settings Configure Amarok Internet Services
| Playlists | Saved playlists -- see also Playlists. Also playlists on media devices
| Files | Your file system
| Podcasts | Access to Podcasts via RSS feed

Clicking Local Music in the root of Media Sources (image above) or in the breadcrumb bar returns you to your collection, showing you a list of all the available resources, artists, albums and tracks that you have previously defined as part of your collection. The breadcrumb bar indicates that you are viewing Local Music.

#### Streams and Podcasts

There are two ways to listen to streams.

- If you have a favorite station, get the stream URL and add it: Playlist Add Stream. If you then save your playlist, later you can find it again in Playlists, as a Saved Playlist.

- Browse through the scripts available in our Script Manager, Tools Script Manager up to Amarok 2.4.0, after 2.4.1 Settings Configure Amarok Scripts. There are some excellent collections available, which will show up in the Internet section of your Media pane.

Podcasts have their own section in the Media pane, above. If you have an RSS or Atom feed URL, click the and add it there. If you have an OPML file to import, that choice is available also. Use the context (right-click) menus to Add to playlist, Configure, Remove Subscription, Update Channel, or mark an episode as New. If you are interested in browsing through a large collection of podcasts, check out the Podcast Directory available through the Script Manager, referred to above.

More about configuring Amaroks Internet Services here.

#### Using the Content Browser

The hard disk of your computer, audio CDs, external devices and the Internet are the basic resources for your collection. After your collection has been set up, it is likely that your collection will hold a large number of albums and tracks, much more than can be shown on a single window.

How to change the display of your collection, below:

##### Hiding or expanding information

The area of the Media Sources pane below the search bar is called the Content Browser. Three media sources are indicated in the image of a Content Browser below: CD, Local Collection and a Media Player:

Clicking the banner for a device (the blue bar for the Sansa above) shows or hides the content of that device. The direction of the arrow on the right indicates whether the contents for that device is hidden or shown. The content on a particular device can, in turn, be hidden or shown using the same principle, clicking on the appropriate artist or album. An arrow pointing down on the left of an artist or an album indicates that the contents has been expanded. An arrow pointing right indicates that more content for that category is available but currently hidden. In the image above, the information for Mike Oldfield - The Songs of Distant Earth CD has been expanded, showing the individual tracks. On the other hand, the albums and tracks in the Local Collection are hidden. By clicking these arrows you also can expand or hide information.

##### Changing the order of tracks and albums

The order in which tracks are sorted in the Content Browser can be customised by using the button at the top of the Media Sources pane:

The Collection sort options for version 2.8

The Collection sort options for version 2.8

The sort order is indicated on the top left of the Media Sources pane, just below the Search text box. The default order is Artist / Year - Album. The display order of the Content Browser can be temporarily switched between the user-defined sort order (described above) and a Merged view in which artists are listed alphabetically, no matter on which media the music is stored. To toggle the Merged view, click the icon at the top right-hand of the Media Sources pane:

To search your collection, type your search term into the Search bar at the top of the Local Music section. Not only can you search by artist, album or track name, but any part. You might create a nice playlist by searching for winter, for instance, or merely find a track when you only remember one word of the title. You can also search by rating, playcount, even filetype. See Search in Collection for more details.

##### Deleting items from the collection

You can delete any item from your collection by right-clicking on it and choosing the bottom item Move Tracks to Trash. A confirmation dialog will appear, preventing the accidental deletion of any tracks. More than one item can be selected with &Ctrl;click.

### Playlists

#### The Playlist pane

Now that &amarok; has scanned your collection of music, you want to listen to it. So use the Playlist pane to create a playlist containing the selection of tracks you want. This is where you play your music, streams, or podcasts.

You can sort your playlist by title, album, artist, genre and many others. For instance you can sort your tracks by year first, then by artist and so on.

The search box lets you search or filter your tracks. The and icons near the top of the Playlist pane lets you skip to the next or previous track containing the letters you have chosen. The button lets you filter your tracks by artist, album, &etc;

The layout of the Playlist can be changed through the top-level menu: Playlist Playlist Layouts.

#### Adding music to a playlist

There are five ways to add music to the playlist.

Pop-up Dropper when adding a single track

Pop-up Dropper when adding a single track

1. Choose some of your music in the content browser and drag it to the right. If you drag it over the Context pane you will see the Pop-Up Dropper, also known as PUD. The image above shows PUD in action. PUD provides three options: Add to Playlist, Replace Playlist, and More.... The option highlighted in the gray area (Add to Playlist in this image) is the active one. Dropping the album there adds it to the playlist in the Playlist pane. Choose one of the other options to do something else with your selection. Dragging it over More... brings up a new menu of choices in PUD.

2. Drag your selection all the way onto the Playlist pane on the right-hand side of the &amarok; screen.

3. Double-click the album/track to append to the playlist, doesn't start to play.

4. Middle-click the album/track to append it to the playlist and play immediately.

5. Right-click the album or track. In your right-click menu, you will find similar choices. The image below shows the context menu that appears after an item has been right-clicked. Select Add to Playlist.

#### Using the Toolbar

The Toolbar at the top of the &amarok; screen provides a simple interface to control the playing of music in the Playlist.

Click the round icon on the left to start your music playing, and click it again to pause. On the right is the volume and mute control; click on the center of the icon to mute. Use your mouse scroll wheel to control the volume, or drag/click your mouse on the outside ring of the volume icon.

Once a track or stream begins to play, the Artist / Album / Track title slowly alternates in bold in the center. On the right is the next track, which you can click to start it playing immediately. Once a track has played it will be on the left, so you can click on the title to go back to it. The progress bar in the middle of the Toolbar indicates the time elapsed (left hand) and time remaining (right hand) for the track that is currently playing.

If you'd rather see a more traditional toolbar, you can select Slim Toolbar from the View menu.

#### Manipulating playlists

You may want to delete albums or tracks from your playlist, rearrange the displayed items for each track or rearrange the display order of tracks.

##### Removing a track

You can remove any track or album from your playlist by:

1. Right-click on the item in the playlist and choose the option Remove from playlist.

2. Drag the item to be deleted over the Context pane to activate PUD. Several options will appear over the Context pane. Drag the item to the area marked Delete from playlist. See the image below that shows a track being dragged onto the Remove option in PUD.

3. Selecting the track or tracks and use your Delete key. Multiple tracks can be selected using &Shift; or &Ctrl;.

Pop-up Dropper when removing a track

Pop-up Dropper when removing a track

Undo your delete by pressing &Ctrl;Z or by clicking the arrow in the Playlist Toolbar at the bottom of the Playlist pane (see below).

##### Using the Playlist tools at the bottom

At the bottom of the Playlist pane are seven icons:

Icon | Action
| Clear playlist of all albums and tracks.
| Save your playlist. If you do not rename, saves the date as a name.
| Undo your last edit to playlist.
| Redo your last undo to playlist.
| Highlight the track currently playing. Useful for long playlists.
| Set the play mode: repeat tracks, random order, prefer rarely played, &etc;
| Edit the playlist queue; which are tracks played first before the playlist resumes.

These buttons provide convenient alternatives to several keyboard actions.

#### Saving and retrieving your favorite playlists

The disk icon, in the popup which can be called from the bottom of your Playlist pane, allows you to save the current &amarok; playlist. This enables you to recall a particular selection of music from your collection at any time. Playlists only contain pointers to the music you selected, not the music itself. So if your playlist is pointing to music on an external device, it must be connected and mounted, otherwise the music cannot be played. There are three places to store playlists:

1. outside &amarok; on your computer file system,

2. in your &amarok; playlist database

3. on an portable media device.

Clicking the disk icon at the bottom of the Playlist pane stores your playlist in the &amarok; playlist database. To save to disk, click and hold, then scroll to that choice.

Current playlist saving options

Current playlist saving options

By default, your saved playlist has a name composed of the date and time when you saved it (see image below). Right-click the playlist name to rename it. Right-clicking on a playlist name also allows you to add it to your existing playlist in the Playlist pane, or to replace your existing playlist.

### The Context View

The power of &amarok; is in the Context pane (in the center of the default &amarok; window), where you can install various applets to help you enjoy and explore your music. Most of this additional information is obtained from the Internet, so a connection is important to get the most out of your Context pane. By default, three applets are preset: Current Track, Lyrics and Wikipedia.

#### Default layout

The default Context pane shows the following items: CurrentTrack, Analyzer, Wikipedia and Lyrics. Depending on the screen size the Lyrics might not be visible, but clicking on the button at the bottom will make it visible. When nothing is playing, the CurrentTrack applet will show the last played tracks and information about the Local Collection

The default view as of Amarok 2.8

The default view as of Amarok 2.8

#### Customizing the Context pane

At the bottom of the Context pane are four buttons for the default applets. On the right of these buttons you see , clicking on it will show allowing you to remove these applets. Click the applets to add them to the pane. Drag the labeled buttons to re-order the applets you have, and click again to save your selections.

This makes the Context pane extremely flexible, maximizing the possibility of a custom display that fits your preferences. More here.

### How to deal with problems

#### Some of the music is being rapidly skipped over

You may not have installed the necessary codecs. More about that here:

FAQ: What Media Types Does Amarok Support.

Please refer to your distribution.

#### After my iPod has been mounted, it is not shown in the Content Browser

This should not happen. Check that the device has been properly mounted. Simply typing `mount` in a console will show you all mounted devices.

#### After I have updated my collection, the additions are not shown in the Content Browser

From the top-level menu Tools Update Collection. If they don't show up, quit &amarok; from the &amarok; menu, or use &Ctrl;Q to quit. Once you restart &amarok;, your collection should show your updates.

#### Amarok cannot find the lyrics of the songs that I play

Possibilities:

1. The lyrics are not available in the sites checked on the Internet. You may wish to add more sites via the script menu.

2. The track numbering system within an album in your collection is not correct.

3. The title of your song contains special characters with a cedille, accent, &etc; that do not show in your track title; therefore the lyrics script applet cannot find a match for your title. Check your tags and track numbering system with a tagger such as Picard.

#### My question isn't answered here

More complex issues are covered in this handbook, including Troubleshooting and Common Problems, and the Amarok FAQ.

### Glossary

#### Breadcrumbs

This is a way of navigating a hierarchical file structure; on &amarok; near the top of the Media Sources pane. Starting at the Home folder level, it shows how deep one has navigated into the file system. When you have gone to a particular place in the file system, you will see all folders at a higher level. In &amarok; the > links between folder levels allow you to find out what alternative folders are available at a particular level. The breadcrumbs are an efficient mechanism to navigate the whole file system on your computer.

#### Collection

All the sound files that &amarok; has compiled in the database. Your collection may vary in size and composition of music tracks, depending which external devices (such as audio CDs or portable players with music) are connected and mounted on your computer.

#### Collection Browser

This is in the Media Sources pane for your Local Music section and shows you the list of the music that you have in your collections. The Collection Browser allows you to search and sort your track lists by various id3 tags.

#### Playlist

A selection of tracks from your collection that you wish to play. Some portable music players have predefined playlists that are likely to differ from your &amarok; playlists.

#### Script

&amarok; plugin to extend functionality. Scripts are available from Settings Configure Amarok Scripts. Add more lyrics sources, more streaming stations, save covers to your album folders, burn CDs from playlists, &etc;

#### Scrobble

To scrobble a track means that as you listen to it, the title of the track and artist are sent to a Web site such as Last.fm, where the information is added to your profile.

#### Stream, streaming

Like 20th-century radio stations, Internet radio stations send out streams of content. One can find music, news, commentary and opinion. Many streams can be accessed through &amarok;, either through scripts such as Cool Streams, or individually added by menu, Playlist Add Stream.

#### Tags

The information about each of the tracks you listen to, &eg; album name, track title, composer, artist, year, &etc; There is a standard called ID3 for including this information on audio CDs. You can edit the tags of individual tracks within &amarok; if the file permissions are correct.

## The Amarok Window

When you open &amarok;, this is what you will see, once &amarok; has fully loaded:

Default startup window

Default startup window

### Window Layout

&amarok; is organized in four main areas, the toolbar and three panes:

| The Main Toolbar
| The Slim Toolbar
| The Media Sources pane
| The Context pane
| The Playlist pane

### Toolbar

#### Introduction

The Toolbar is used to manage the currently playing song. You can switch between the main and slim Toolbar using the View menu in the Menubar. The Menubar can optionally be hidden; use &Ctrl;M to hide or re-display.

The Toolbar can be undocked and moved anywhere on your screen, and even used without the rest of the &amarok; window displayed. To undock the Toolbar you should first make sure that the View Lock Layout menu item is unselected. Now you can grab the toolbar at its left edge and drag it anywhere. To get it back just drag it into its old position while the layout is still unlocked.

#### Main Toolbar

This is the default Toolbar. It has a / button on the left and displays the song title, album and artist in the center-top.

The previous and next track are shown on either side of the song title. Clicking one of them will make &amarok; skip to that track.

A Progressbar with the already played time on the left and remaining time on the right shows the current position in the song. If you have Moodbars enabled, and .mood files for your tracks, this is where they will be displayed. More about the Moodbar later.

By using the slightly transparent and buttons next to the text you can add the current song to your loved tracks on last.fm or add a position marker.

On the right is the volume-control button. A blue circle around the button shows the current volume. The volume is 0 at the bottom and increases clockwise. Change volume by clicking on the volume circle or by using the scroll wheel while the mouse hovers the button. The sound can also be completely muted by clicking on the speaker in the center.

#### Slim Toolbar

The Slim Toolbar has the same functionality as the Main Toolbar, but is more compact. Additionally the Slim Toolbar has a button to stop playing so the current song will be restarted when you press again. All buttons concerning the current track are on the left and only the volume control on the right side. Here the volume is controlled by clicking on the button and dragging the slider or using the scroll wheel while the mouse is hovering the button.

### The Media Sources pane

The Media Sources pane on the left by default is where you access your local collection as well as other services: Local Music on top, which is the primary interface to your local collection and connected media such as mp3 players and CDs.

There is a section for all Internet Services that you have enabled. Here, you can browse listings of radio stations and podcasts; listen and/or subscribe to them, interact with your last.fm account, purchase music from online stores such as our new Amazon mp3 store, Magnatune and download independent artists' music from Jamendo and more.

The Playlists section allows you to create and manage Dynamic Playlists, access your Saved Playlists as well as the Automatic Playlist Generator.

The Files section displays an integrated file browser and the Podcasts section offers you access to your podcast subscriptions.

#### Navigation Menu

The Navigation menu consists of the Filter bar, Bookmark button and Breadcrumbs navigation bar.

##### The Filter Bar

The Filter Bar filters the content according to the text in the box.

##### Bookmarks

To access this feature, click on the icon above the Filter bar.

Menu Item | Description
--- | ---
Bookmark Media Sources View | Adds the current Media Sources view configuration to the bookmark list.
Copy Current View Bookmark to Clipboard | Copies bookmark to the system clipboard.
Bookmark Manager | Displays a list of all available bookmarks in a new window, with options to edit them.
Bookmark List | Lists all your bookmarks for faster selection.

#### Local Music

Displays the music from your default collection folder, sorted as specified. Both the regular (non-merged) view and Merged view of the same collection are shown, with the same sorting. Click the icon to toggle between views.

Regular non-merged view Regular non-merged view | Merged view Merged view

Click the icon to change the sorting criteria, using the following menu:

Menu Item | Description
--- | ---
Artist/Album | Shows the collection sorted by artists and album names. If two entries have the same artist they will be sorted by album.
Album/Artist | Shows the collection sorted by album and artist names.
Genre/Artist | Shows the collection sorted by genre and artist. If two entries have the same genre they will be sorted by artist.
Genre/Artist/Album | Shows the collection sorted by genre, artist and album. If two entries have the same artist they will be sorted by album.
Levels | Designate the window cascade order of your elements.
Show Years | Check if you want years to be displayed.
Show Track Numbers | Check if you want track numbers to be displayed.
Show Cover Art | Check if you want cover art to be displayed.

#### Internet

Shows your internet collection, added and configured in Settings Configure Amarok...Plugins. More about configuring Internet Services. There are some scripts which add Internet Services; see Scripts for more information.

Menu Item | Description
--- | ---
Cool Streams | Lists quality radio streams.
Jamendo | Connects with Jamendo, a growing free music database.
Last.fm | Connects with Last.fm; embedding the site experience in &amarok;.
Librivox.org | Connects with Librivox, an extensive collection of free audio books.
Magnatune.com | Connects with Magnatune, a great online music store.
MP3 Music Store | Connects with Amazon MP3 Store, an online music store.
Podcast Directory | Shows a large list of podcasts. If you choose to subscribe, the podcast menu will be automatically updated.

#### Playlist

Media Sources Playlists menu:

Menu Item | Description
--- | ---
Dynamic Playlists | Dynamically updating parameter-based playlist; more on this here.
Saved Playlists | Saved and imported playlists; more on this here.
Automated Playlist Generator | Creates playlists by specific criteria; more on this here.

#### Files

The &amarok; file browser helps you add music to your collection, or simply play tracks from your hard drive.

Navigate through your files using the icon buttons: (previous), (next), (up), (home), or (places), very similar to a web browser menu; or click on anywhere in the breadcrumbs to go directly to that level.

If you would rather search or filter for something rather than navigating to it, use the filter field to find the desired content. Partially type the name of the file and it will be displayed as in this example.

#### Podcasts

Lists your subscribed podcasts; from here you can listen, organize, add, import or unsubscribe podcasts.

Menu Item | Description
--- | ---
Add Podcast | Add a podcast URL: RSS 1.0/2.0 or Atom feed.
| Add a folder to the podcast navigation menu.
Visible Sources | Selects what category of podcasts you can view.
Merged View | Displays the podcasts in a merged or unmerged view.
| Checks all podcasts for updates and downloads any available.
| Imports an OPML file from your hard drive.

### The Context pane

The Context pane is a panel to which you can add various applets which offer information and media on the current music. A connection to the Internet is required for the most useful use of these little applications, which will fetch lyrics, information, photos, and even guitar or bass tabs, depending on which applets you choose to display.

#### Using the Context pane

Context pane when not playing

Context pane when not playing

Pictured is the Context pane when no track is playing. If it is hidden, use View Context to display it. The pane is divided in two parts:

- The applet panel itself, where you can interact with some of the applets, such as editing lyrics or changing settings.

- The lower portion of the panel, where you can expand and collapse applets and manipulate them in various ways once you click the Configure Applets icon .

##### Configuring Applets

Once you click in the lower portion of the Context pane changes slightly; each applet tab gets an icon that you can click to remove it, and a list of applets appear. To add new applet, simply click on the applet, and it will appear in the pane, ready to be used. To change the applet display order, click the tabs and drag them around the bar.

#### Applets

There are several applets available to dock in your Context pane; below is a description of each.

Applet | Icon | Description
Current Track |  | Information about the current track. You may rate it by clicking on the stars, add a position marker, or edit track metadata. When not playing, the applet displays collection information and Recently Played Tracks, which allows you to view the tracks and add them to the playlist.
Similar Artists |  | Fetches artists similar to the currently playing one, with a short description and options to find them in your collection, or on Last.fm, and add to your current playlist.
Upcoming Events |  | Displays upcoming events that involve the current artist or group. You can set a venue locale to be watched by entering the applet settings and narrowing it down under the Favorites section.
Wikipedia |  | Wikipedia page for the track or artist. Also browse other Wikipedia links, and use the back button to go back to the starting page.
Labels |  | View, add and edit Labels for the current song. To add a Label just type it in the text box and press &Enter;. Suggested Labels are user-contributed tags from Last.fm.
Tabs |  | Fetches and displays guitar and bass tabs (if available). Not editable.
Lyrics |  | Displays the lyrics of the song that is currently playing. Add or change lyrics scripts in the Script Manager.
Albums |  | View albums from the current artist or band that are available in your local Collection.
Photos |  | This applet queries Flickr.com for pictures of the band you're listening to. Open the settings to add more keywords to your query (&eg;: live in tokyo).>
Analyzer |  | This is a new applet in version 2.8. It provides basic audio visualizations. A right click on it allows to configure the applet settings.
Info |  | Information about the current media source. Allows you to navigate through internet services such as Librivox.org.

### The Playlist pane

&amarok; offers excellent playlist management for all of your songs and other audio files. Here you see a short playlist, sorted by album.

&amarok; Playlist pane

&amarok; Playlist pane

#### Basic Playlist Manipulation

Playlist Pop Up Dropper menu

Playlist Pop Up Dropper menu

Adding music to your playlist is a simple drag-and-drop, right-click or double-click operation.

Two playlist-related options will be shown in the Context pane in the center (the Pop-Up Dropper, or PUD) when performing a drag-and-drop operation to add music to your current playlist. You can either use Add to Playlist, which will append the songs you have selected, or Replace Playlist, which will replace all the contents of the playlist with your selection.

Alternatively, dragging-and-dropping your selection into a position in the Playlist pane also works.

Right-clicking on a track, album, or selected group will bring up a context menu from which you can Add to Playlist, or Replace Playlist.

Double-clicking a selection or pressing &Enter; while a track is selected in the Media Sources pane will perform the same as Add to Playlist.

Middle-clicking an item will append it to the playlist and begin playing from the start of the playlist.

If you tell the file browser to open a supported multimedia file, &amarok; will append the selected file to the current playlist. Some multimedia files contain playlists themselves or may have playlist files associated by name (&eg; wav with cue). If &amarok; detects such an association, it may add several items to the playlist.

#### Context menu

Right-clicking on any song or album in the playlist will bring up the Playlist context menu.

##### Queue/Dequeue Track

Queuing a track will temporarily modify the play order without modifying the actual playlist order by setting the user-selected track as the next track.

As many tracks as required can be queued, and the order of queuing is indicated by a green circle with the determined order. Choose the tracks by &Shift;Click for a block of tracks, or &Ctrl;Click for individual tracks. The order in which the tracks are selected is the determined order.

Tracks can be dequeued by opening the context menu and selecting the Dequeue Track option.

More about the Queue Manager.

##### Stop Playing After This Track

Choosing this option allows a track to finish, after which &amarok; will stop playing . It will be indicated by the stop icon in place of the track number. Selecting this option on a track already marked will unmark it. Only one track in the playlist may be so marked.

##### Remove From Playlist

This removes the selected track from the current playlist.

##### Add Position Marker

Adding a position marker is only available for the currently playing track. This will add a bookmark in the seek bar at the top of the &amarok; interface.

##### Show in Media Sources

This displays the track selected in the Media Sources pane, which is on the left by default.

##### Album

Playlist album menu

Playlist album menu

These are per-album options which will affect the entire album the track belongs to, rather than the track itself. The options are largely the same as the album menu in the Media Sources pane.

##### Edit Track Details

This option brings up the Edit Track Details dialog for the selected tracks.

#### Searching the Playlist

Playlist searching options

Playlist searching options

&amarok; offers powerful searching capabilities for playlists. Simply enter your query for a song into the text box labelled Search playlist and it will match your keywords up against the match criteria you specify in the options menu — for instance, you can choose to search only by Albums and not Artists, or choose to match both of them.

Playlist search bar

Playlist search bar

Pressing the icon moves the selection to the previous search result, and moves to the next result, all without losing focus on the search input box.

The icon in the search field will clear your query.

Enabling Show only matches from the menu will cause your playlist to display only the tracks matching the query.

More about Playlist filtering here.

#### Sorting Levels and Bookmarking

Playlist sorting and bookmarking toolbar

Playlist sorting and bookmarking toolbar

##### Sorting Levels

Menu for adding a sorting level

Menu for adding a sorting level

&amarok;'s robust sorting abilities offer the ability to sort not only by one field of a track, but by many combined in a series of levels.

There are many different modes by which a sorting level can act. For instance, songs can be sorted by their Genre and then their Album.

A sorting level can be added by clicking the right-pointing triangle, which will bring up the menu for adding another sorting level.

Clicking the small triangle on the right of the sorting level's name will cause items in the playlist to switch between ascending and descending order, which is indicated by the direction in which the triangle is pointing — up or down, respectively.

To remove a sorting level, click the name of the sorting level that precedes the one you wish to remove. Multiple sorting levels can be removed — provided that they are all lower in the hierarchy — by clicking on the ancestor of all of them. If you wish to clear all sorting levels, you can click the playlist icon to the left of the first right-pointing arrow.

##### Bookmarking

Bookmarking menu

Bookmarking menu

The bookmarking menu provides options to save your current playlist layout. Clicking Bookmark Playlist Setup will add your playlist layout to the layout bookmarks, which can be viewed in Bookmark Manager.

Copy Current View Bookmark to Clipboard copies an &amarok; playlist layout URL to the clipboard, which can be used for backing up your playlist layout.

#### Playlist Functions

Playlist bottom bar

Playlist bottom bar

The bottom bar of the Playlist pane provides various additional options for manipulation of your playlist.

Icon | Action
| Empty playlist of all playlists, albums and tracks.
| Save your playlist. Right-click to rename it, default is the date as a name. Left-click to bring up the Save Playlist menu, to save your playlist file onto the hard drive instead of the database.
| Undo your last edit to playlist.
| Redo your last undo to playlist.
| Scrolls playlist to the track which is currently playing and highlights it — useful for a large playlist.
| Set the play mode: repeat tracks, random order, prefer rarely played, &etc;
| Edit the playlist queue; tracks played first before the playlist resumes. More about the Queue Manager.

##### Save Playlist menu

Save playlist menu

Save playlist menu

Left-click to bring up the Save Playlist menu, to save your playlist file onto the hard drive instead of the database.

##### Track Progression

Track progression menu

Track progression menu

The Track Progression menu enables you to modify the order in which &amarok; progresses through the tracks in your playlist.

The top half of the menu specifies repeat options — whether songs should be repeated by track, by album or by playlist; whereas the bottom half specifies the order in which the tracks play in — in random order or by favor. Only one type of progression may be selected, &eg; you cannot select both random track and repeat playlist.

###### Favor

Playlist favor menu

Playlist favor menu

Favor is an innovative method to determine the next track to be played when using the random selection mode. The next track to be played can be determined depending on their score (a measure of how often they are played), their user-given rating, or if they have not been recently played.

## Configuring Amarok

On first start, some basic configuration is done; see also Quick Start Guide: Getting Started. But there is more under the hood.

To access the Configuration Menu, go to Settings Configure Amarok... and see the following dialog:

General configuration options

General configuration options

### General

In the screenshot above, see some General Options you can set. Depending on the distribution, the default settings can vary. When hovering over the options with the mouse pointer, a tooltip will show to explain the individual settings.

General options:

Option | Tooltip
--- | ---
Show tray icon | Check to enable the &amarok; system tray icon.
Automatically retrieve cover art | Check to enable the automatic retrieval of cover art from the internet.
Enable context applets collapse animations | Check to enable animations when context applets collapse.
Automatically scroll playlist to current track | Check to make the playlist scroll so the current track is always visible.
Show Moodbar in progress slider | The Moodbar makes it possible to navigate in your music visually. Please note that this feature requires the external Moodbar Generator tool, or a script.
Moodbar style | Choose the mood display style.

When you enable the Moodbar, be aware of the following requirements: the Moodbar will only display if your tracks have been tagged with moods. For more about the Moodbar, refer to: Moodbar.

### Local Collection

Local Collection configuration

Local Collection configuration

This dialog shows your file system in a tree structure, called Collection Folders. Selecting a folder always includes its subfolders. These folders will be scanned for media to make up your collection. You can right-click on a folder to individually rescan it, if it was previously selected.

Collection options:

Option | Tooltip
--- | ---
Fully Rescan Entire Collection | Rescan your entire collection. This will not delete any statistics.
Import | Imports ratings and/or statistics from older &amarok; versions, the batch scanner, or media players.
Scan folders recursively (requires full rescan if newly checked) | If selected, &amarok; will read all subfolders.
Watch folders for changes | If selected, the collection folders will be watched for changes. The watcher will not notice changes behind symbolic links.
Importing Music: Transcode tracks | Whether &amarok; should transcode tracks when they are copied or moved to Local Collection.

#### Import Statistics

This option allows you to import statistics, &eg; ratings and scores from either

- an older &amarok; 1.4.x version (from SQLite, MySQL or PostgreSQL databases)

- from iTunes

It does not import statistics from an &amarok; 2.x database, so if you want to merge an older 2.x database version, you will need to do this by hand.

### Metadata

This dialog will allow you to configure the settings for metadata handling. This is a separate page starting with Amarok 2.7

Metadata options:

Option | Tooltip
--- | ---
Write statistics to file | Check to write play-changing statistics as tags back to the audio files.
Write covers to file, maximum size... | Check to write changed covers back to the audio files. This will replace existing embedded covers. Select a value from the drop-down list to set the maximum size of the cover.
Enable character set detection in ID3 tags | If checked, Amarok will use Mozilla's Character Set Detector to attempt to automatically guess the character sets used in ID3 tags. If your tags are correct, it is more safe to leave this option turned off.

#### Statistics Synchronization

This dialog will allow you to keep statistics of your collections synchronized. Make sure to only check collections between which you want to synchronize metadata.

Statistics Synchronization options:

Option | Tooltip
--- | ---
Synchronize Rating | Check to synchronize ratings between collections.
Synchronize First Played | Check to synchronize first played dates between collections.
Synchronize Last Played | Check to synchronize last played dates between collections.
Synchronize Playcount | Check to synchronize playcounts between collections.
Synchronize Labels | Check to synchronize labels between collections.

### Playback

Playback configuration dialog

Playback configuration dialog

Configure the playback options, as well as the KDE multimedia framework &phonon;.

Option | Tooltip
--- | ---
Fadeout on stop | If checked, &amarok; will slowly fade the volume of the playing track on stop or at the end of the playlist, or stop playback immediately.
Fadeout on pause | If checked, &amarok; will slowly fade the volume of the playing track on pausing the current track.
Fadeout duration | The length of the fadeout, in milliseconds.
Inhibit automatic suspend if playing | If checked, &amarok; will prevent the computer from being suspended will a track is playing.
Pause playback on suspend | If checked, &amarok; will pause playing of the current track when the computer is about to suspend.
Resume playback on start | If checked, &amarok; will resume playback where you left it the last session -- just like a tape-player.

#### Configuring Phonon

&phonon; is the multimedia framework used by &amarok;. It was created to allow KDE 4 to be independent of any single multimedia framework such as GStreamer or VLC and to provide a stable API for KDE 4's lifetime. As an added bonus, it simplifies development by providing a simple API that works across different platforms such as Windows and OS X.

The result of all this for you, the user, is that you can choose the multimedia framework that works best for you. This is usually pre-configured by your distribution.

Playback problems in &amarok; are typically not &amarok; issues, but rather &phonon; issues, as &amarok; doesn't handle sound directly anymore.

##### Device Preference tab

Depending on your OS and distribution, you may need to use ALSA, OSS, PulseAudio, or something else as your default playback device. Find one that works for you with the Test button and apply to all types of output. If you would like different types of output to go with different devices, this is possible as well.

##### Speaker Setup tab

Should you wish to change the standard speaker setup, here is the place to do it.

##### Backend tab

Depending on your operating system you may see options such as Gstreamer, VLC, or DS9 (Windows) here. The recommended phonon-backend for &Linux; users is VLC or Gstreamer.

If you don't see VLC or Gstreamer, install the package for it. For most distributions the package for VLC, for example, would be phonon-backend-vlc.

Each backend comes with its own codecs, so depending on the backend you choose you will need to also download the codecs, as most distributions don't ship them for legal reasons.

### Notifications

Notifications configuration dialog

Notifications configuration dialog

Option | Tooltip
--- | ---
Use On-Screen Display | Check to enable the On-Screen Display. The OSD briefly displays track data when a new track is played. Once checked, the OSD will be visible on your screen and you can drag it to the location you prefer.
Duration | The time in milliseconds for which to show the OSD. The value must be between 500 ms and 10000 ms.
Screen | Allows you to choose the screen that should display the OSD if you have a multiscreen setup. Default is 0.
Translucent | Check to enable translucency if supported by your desktop system.
Font scale | (choose the size of the font in the OSD)
Don't show when a fullscreen application is active | Do not show On-Screen Display if another application is focused and running in fullscreen mode.
Use custom colors | Check to enable custom colors for the On-Screen Display text.
Text color | Click to select the color of the OSD text.
Use system notifications | Check to use the system notification. This can vary depending on your desktop system and/or distribution.

### Database

External Database configuration dialog

External Database configuration dialog

The default database is already set to use embedded MySQL. For most users there is no need to configure an external database, as there is no change in performance. If you want to share your database or use it remotely, you can configure an external MySQL database.

&amarok; expects the external database and user account to already exist. The user also requires full access to the database. You MUST restart &amarok; after changing these settings.

If your database is not already set up, you can use the SQL commands in the field at the bottom to do so, after replacing the password with the correct one.

Option | Tooltip
--- | ---
Use external MySQL Database | Check to enable the use of an external database.
Server | Enter the name of the existing MySQL server.
Port | Enter the port number to access the server. Default is port 3306.
Username | Enter the username to access the database with full access privileges.
Password | Enter the password for the default user.
Database | Enter the name of the database. Default preset is amarokdb.

You can find more information about the External Database here.

### Plugins

Plugins configuration dialog

Plugins configuration dialog

Plugins configuration controls Collections, Internet Services, and Local Collection Backends.

#### Collections

&amarok; offers you access to the following Collections, if they are available:

Collection | Description
--- | ---
AudioCD Collection | AudioCD collection plugin for &amarok;
DAAP Collection | DAAP collection plugin for &amarok;
iPod, iPad & iPhone Collection | Plugin to use iPod-like devices as collections in &amarok;
MTP Collection | MTP collection plugin for &amarok;
Universal Mass Storage Collection | UMS/USB collection plugin for &amarok;
UPnP Collection | UPnP collection plugin for &amarok;

#### Internet Services

&amarok; offers by default the following Internet services:

Service | Description | Needs configuration
--- | --- | ---
Ampache | Use an external music server | Yes, Ampache server needed
gpodder.net | Podcast service. See also gpodder.net | No
Jamendo | Listen to free music published under Creative Common licenses. See also Jamendo.com | No
Last.fm | A popular internet radio service, streaming only for subscribers. See also Last.fm | Yes, personal information to scrobble
Magnatune Store | Preview and buy music from a non-evil record label. See also Magnatunes.com | Only for downloads
MP3 Music Store | Access the Amazon MP3 Store directly from Amarok | Yes
mp3tunes | A personal mp3 locker. See also mp3tunes.com | Yes
Podcast Directory | Browse and subscribe to a huge choice of podcasts | No

Other service are available through scripts.

#### Local Collection Backends

&amarok; offers you access to the following Local Collection Backends, if they are available:

Devices | Description
--- | ---
Local Files & USB Mass Storage Backend | Local Collection folders on local and pluggable disks
NFS Share Backend | Local Collection folders on remote NFS shares (Network File System)
SMB (Windows) Share Backend | Local Collection folders on remote Samba (Windows) shares

#### Ampache configuration

If you have access to a remote Ampache music server, click and enter the necessary information. You can configure access to more than one Ampache server. For more information see the Ampache section in what follows.

#### Last.fm configuration

While streaming is free with Last.fm's own online player for residents of the US, the UK and Germany, it only works in &amarok; for paid subscribers. Scrobbling is free, however, provided you enter your Last.fm username and password by clicking . &amarok; allows you to store the password in the secure KDE Wallet. If you decline the use of Kwallet, your password will be stored in clear text instead.

#### Magnatune Store configuration

Listen to the music offered by Magnatune for free and buy it directly through &amarok;. Click to add your membership credentials if you are a member and/or add your email address to re-download music you previously have downloaded from Magnatune.

To download, you then go to the Media Sources pane, select the Internet section and click on the Magnatune Store. It will then download the catalog where you can search and select the music you want to buy.

#### MP3 Store configuration

Access the Amazon MP3 Store directly from &amarok;.

The Amazon MP3 Store needs to know what country you are located in because it offers different items depending on your location. The following countries are allowed:

- France

- Austria, Germany, Switzerland

- Japan

- United Kingdom

- United States (default)

NOTE: Changing the country invalidates your shopping cart. If your country is not in the list, you cannot use the Amazon MP3 Store because it is not supported by Amazon.

#### mp3tunes configuration

If you have a personal mp3tunes locker, click and enter your username and password. You will then be able to access your online locker.

### Scripts

Scripts configuration dialog

Scripts configuration dialog

Script Configuration in &amarok; covers Generic, Lyrics, and Scriptable Service scripts. Scripts are added in the Manage Scripts dialog.

#### Generic scripts

Generic scripts add functionality to &amarok;. The Amarok Script Console is available by default; other scripts which add CD burning, cover image storage, games, and many other choices are available. If installed, these scripts will show up in the Tools menu.

#### Lyrics scripts

A variety of lyrics scripts are available; Ultimate Lyrics is provided by default. Your chosen lyrics scripts will provide the lyrics shown in the Lyrics applet in the Context pane.

#### Scriptable Services scripts

Scriptable services, if enabled, will show up in the Internet Services in the Collections pane. Many collections of streams are available, in many languages, and from many sources.

#### Manage Scripts

At bottom of the configuration dialog are two options:

- Automatically update built-in scripts

Automatically download and install updates for the built-in scripts from the &amarok; website if available. Enable if you usually have a working Internet connections, and want your scripts automatically updated. This will not update user-supplied scripts from KDE-apps.org.

- Manage Scripts button

Browse, install and uninstall user-supplied scripts; also search, sort and rate the scripts in the Amarok Add-on Installer.

##### Add-on Installer

Amarok Script Manager

Amarok Script Manager

Using the Add-on Installer, one can install the latest user-contributed &amarok; scripts. There are also options to search, sort and rate the scripts.

The Install Scripts and Uninstall buttons can be used to manage scripts. One can install script packages of type amarokscript.tar, amarokscript.tar.bz2, amarokscript.tar.gz

##### Script Information

Learn more about a script using the button.

A script can also be executed directly in the Amarok Script Console. This is activated by selecting the Script Console and confirm the selection by hitting either the OK or the Apply button. To deactivate the Script Console deselect it and confirm again.

### Changing Layouts

#### Changing the Amarok Window Layout

The visibility of each of the three &amarok; panes is indicated in the View menu (part of the top-level menu). If you unlock the layout, each of the three panes will show two clickable boxes. These two boxes allow you to rearrange or customize the layout of your &amarok; window. Clicking the X closes that particular pane. Having been closed, a pane can be activated again by checking the appropriate box in the View menu. Clicking Reset Layout will of course reset the layout back to the default look.

##### Undocking Amarok panes

Clicking the hollow symbol on the left of the cross causes that panel to be undocked, so it will appear as a separate window on your desktop. Repeating this action on the undocked pane will dock it again inside your &amarok; window. You can drag the panes inside your &amarok; window to reorder them. You may stack the panes, or even put one or two of them covering the others, selectable by tabs.

##### Lock and save Amarok window layout

If you are satisfied with the layout inside your &amarok; window, you can lock this layout by clicking the appropriate item in the View menu. Be aware that if you want to be sure your layout is preserved when you shut down your session with &amarok; still open, quit &amarok; first by either choosing Amarok Quit, or by typing &Ctrl;Q.

#### Changing the Toolbar

You can also choose between two layouts of the Toolbar by clicking the appropriate item in the View menu:

Main Toolbar
Slim Toolbar

More about the Toolbar here.

#### Changing the Playlist layout

To access the Playlist Layout Editor, go to Playlist Playlist Layouts Configure Playlist Layouts... and you will see the above editor window. On the left you can see the preset layouts; clicking on those allows you to see how the configuration is done on the right. Clicking on the Preview button allows you to see the applied layout in the Playlist pane.

##### Modifying a default layout

To modify one of the default layouts, first make a new copy of it: simply click on and save it under a new name. To generate a new layout, click on

A layout consists of 3 elements: the Album Head, the Album Body (with a special album body for Various Artist tracks) and the Single Tracks configuration, selectable in the tabs in the middle of the editor. To add an item, simply drag it from the selector on top and drop it in the layout tab elected below. To show the album cover, just check the Cover field.

In addition, you can also add:

Menu Item | Description
--- | ---
Show inline playback controls | playback controls will appear below the line of the playing track.
Show tooltips | Tooltips showing ID3 tag information will be shown on hovering over a track.

###### Item layout configuration

Each of the added items can then have its own layout configured: hovering over the item shows a wrench, clicking on this wrench will let you access a configuration dialog for that item. The example below shows you the configuration dialog for the Album item:

You can then decide of the total width of the item (100% is the total width of the line, so if you use a custom width and have more than one item on a line, you need to reduce that width per item), its alignment, the font weight and whether the tag should be shown with a prefix or suffix.

###### Example: single line layout

Example: to generate a single line layout without grouping you only add items in the Single Track element.

###### Playlist layout storage

The playlist layouts will be stored in xml format in `$HOME/.kde/share/apps/amarok/playlist_layouts` (might be `$HOME/.kde4/share/apps/amarok/playlist-layouts` for some distributions).

## Organization

Organizing your music makes it easier to find what you want. &amarok; offers you several tools to assist.

First, organize your collection of music, both local and remote:

- Collection

  - Collection Scanning

  - Search in Collection

  - Organize Collection

  - Remote Collections

    - Ampache

    - DAAP

    - Samba

    - UPnP

  - External Database

  - Working with Media Devices

The Cover Manager organizes your album covers, the Tag Editor helps &amarok; categorize your tracks, and transcoding allows you to transfer tracks to your devices in encoding they can play.

- Cover Manager

- Tag Editor

- Transcoding

### Collection

&amarok; organizes your music in the Collection.

- Collection Scanning

- Search in Collection

- Organize Collection

- Statistics Synchronization Between Collections and with Last.fm

- Remote Collections

  - Ampache

  - DAAP

  - Samba

  - UPnP

- External Database

- Working with Media Devices

#### Collection Scanning

Every time &amarok; is displaying a collection the information about tracks and albums needs to come from a source.

The source can be an portable device, an Internet service or a database.

For tracks that are in Local Collection folders &amarok; is using a database to have fast access to the required meta-information.

At first this information needs to be loaded into the database which is usually done by scanning the Local Collection directories for audio files.

This process is called collection scanning.

It is useful to understand the scanning process in order to work better with &amarok;.

##### Incremental Scan / Update Collection

The so-called incremental scan will check the collection directories for updates.

This is done every minute if Watch folders for changes is enabled (on by default) but can also be triggered manually by selecting Update Collection from the menu.

The incremental scan will just check the modification date of every folder in the collection against the last known modification time.

This has a couple of implications:

- You can trigger a rescan of one directory by modifying its time (such as using `touch /path/to/directory` in the console).

- If files inside a directory are changed the scanner will not notice, because changing a file updates its modification time but not the time of the parent folder. On the other hand most programs that modify the files save them atomically by using a temporary file which is then renamed. Such procedure does update directory modification time and thus triggers directory rescan.

- If the collection folders are on a very slow partition the process of checking all the modification times can take some time. Usually this information is cached by the operating system but with large collections that might not be possible. In such a case the scanner might appear to scan continuously. With collections above thousands of directories or when collections are stored on a network drive or an NTFS partition it is recommended to switch off the Watch folders for change option.

If you have problems with deleted tracks still appearing in the collection, or you want to update album covers (which are not updated by a mere Update collection) then you can use the Full rescan option in the settings dialog.

Full rescan will not care about modification dates. It will not delete statistics of existing files; it will, however, delete statistics of tracks that disappeared from the currently mounted collection folders. Because of that it is adviseable to perform the Full rescan only with all Local Collection folders mounted if you move the tracks between mounts. Full rescan also updates play count if the one stored in file tags is greater, rating if the song is unrated and file tags mention rating and score (under the same circumstances).

##### Progress bar / scanning time

The progress bar will show the progress of the scanning.

Up to 50% the scanner will scan the file system and just buffer the result.

Times above 50% indicate that the scanner is committing the results to the database.

Usually the second step is much faster than the first so don't be surprised if the progress bar seems to jump.

Up to 50% aborting the scan is possible. After 50%, the committing of the files cannot be stopped.

The scanning time depends on your disk speed and other factors.

Usually the first scan is a lot slower than subsequent scans where the files are cached by the operating system.

A scan of 10000 files should take around three minutes on a modern computer. 50000 files should be around 13 minutes. Of course with an SSD (solid state drive) this will be much faster.

##### Backup of collection

With the default settings &amarok; is storing all the collection information in a directory called `~.kde/share/apps/amarok/mysqle/` . It can be a good idea to make a backup of this directory from time to time, especially when you didn't enable the writing back of statistics information.

##### About unique ids

&amarok; is tracking files by an id that is either stored in the audio track or computed using file metadata, tag metadata and first few kilobytes of the file.

This id helps &amarok; to identify tracks that are moved to other locations so that statistics information (rating, score, playcount, first & last played) are not lost.

Currently &amarok; will not import tracks with duplicate unique ids.

This leads to the surprising behavior that copied tracks still appear only once in &amarok;.

In some circumstances even different tracks can end up with the same unique id. Such a problem can be seen by the debug output (start &amarok; with the --debug option in a console) while scanning.

##### About Albums

The scanner can only read single tracks but &amarok; will display those sorted by album and compilation (an album without one specific artist). &amarok; can't rely on the directory in which the files are located, since directory organizational schemes vary so widely.

The scanner is therefore doing the following:

- Tracks without an album artist or an artist (or a composer in case of a classical track) are placed in a compilation.

- Tracks that have the compilation flag set or an album artist other than various artists will be placed in an album.

- Tracks that have the compilation flag set to 0 are placed in a compilation.

- Albums called Best Of, Anthology, Hit collection, Greatest Hits, All Time Greatest Hits and Live are always regarded as an album.

- If we end up having tracks with several different artists left over they are placed inside a compilation, or else we make one album out of them.

This process is quite complicated. However usually the outputs of the scanner can help in figuring out why the tracks are sorted as they are.

In such a case try executing (on a command line) `amarokcollectionscanner -r ~/your/music/directory`

Look for compilation tags and tracks with different artist and albumartist tags.

You can remove the compilation tag from mp3 files with the following command: `id3v2 -r TCMP your filename here`

#### Search in Collection

Search Collection lets you specify complex filters to search for specific tracks in your collection. Use the edit box in the Media Sources pane or click the button right next to the edit box. Alternatively you can simply press &Ctrl;F to activate the search bar.

##### Edit Box

When you type in the input field, &amarok; will search for the text in all available tags such as artist, album and title. Your view of the collection will update automatically to display only the matches of the search.

Pressing &Enter; after searching will populate your playlist with all of the found search items and clear the search box. This is a great way to quickly add hundreds or thousands of tracks to a playlist instantly!

To search in a specific tag, type `tag:value` into the search bar. Operators like > and < can be used to create more general conditions. Several conditions can be used together by separating them by a space character. For time conditions, use the following abbreviations: d=day, w=week, m=month, y=year.

##### Tags

The following tags can be searched:

- Album

- Artist

- Bitrate

- Composer

- AlbumArtist

- Genre

- Playcount

- Rating

- Sample Rate

- Score

- Title

- Track

- Year

- BPM

##### Additional searchable fields

Along with tags, the following can also be searched:

- Comment

- Filename

- Disc number

- Length

- Filesize

- Format

- Added (to Collection)

- First played

- Label

- Last modified

##### Operators

Numerical tags can use the following operators to create a condition:

- Equal: :

- Less than: <

- Larger than: >

##### Examples

If you search without specifying a tag, &amarok; will search in all important text tags:

More complex patterns can be used to get better results:

#### Edit Filter Dialog

If you prefer to build your searches more programatically, drag down the icons for the search terms you want, and drag to change search-term order. You may search by: Simple text, Title,

Artist name, Album Artist Name, Album Name, Genre, Composer, Comment, Filename,

Year, Track Number, Disc Number, BPM,

Length, Bit Rate, Sample Rate, File Size,

Format, Added to Collection, Score, Rating,

First Played, Playcount, Label, Last Modified.

You can also add OR and AND here.

Select a term and check Invert condition to exclude items matching this term from the results. Choose AND or OR for all terms in this search. If you choose AND, all search-terms must be present.

If OR, any matches will show up.

Of course, clicking removes your selections.

#### Organize Collection

While organizing your collection in &amarok; is a straight-forward task, you will be manipulating the actual files on your hard drive. Please be sure you have a backup of your files before you begin.

With the Organize Files dialog of &amarok; you can easily manage the media files on your hard drive. When you change the naming scheme of media files, you will organize them, which is very powerful. To access the Organize Files dialog, right-click Local Collection Organize Files in the Media Sources pane and the menu interface will pop-up.

Using this option will move the files to a new location, so you not only need appropriate rights for both the origin and the destination location, but also enough space, usually the double of the total file size to have the action perform smoothly. If you are unsure, do NOT use this option.

Context menu to Organize Collection dialog

Context menu to Organize Collection dialog

If the option Organize Files does not appear, you may have Merged View on (toggled by ). In order to safely organize your files, you need to see your collections separated, not merged.

##### Organizing Files Interface

After selecting the option Organize Files you will first see an additional option that allows you to move the files to a new location, as well as transcode them at the same time. Depending on the codecs you have installed on the system, some format options might not be available and will be grayed out:

First screen when choosing the Organize Files option

First screen when choosing the Organize Files option

For more information about Transcoding, please see the Transcoding section.

After clicking on the Move button on top of the screen, the following interface will show:

Organize Tracks dialog

Organize Tracks dialog

##### Contents

Interface Item | Description
--- | ---
Collection Folder | The default collection folder. Set multiple folders in Settings Configure Amarok.
Token Bar | Drag and drop multiple tokens here to change the naming scheme of your media files. Only available in Basic view.
Format Presets | When you have created your naming scheme, save it as a preset by clicking Save Preset. Remove presets by clicking Remove Preset.
Replace Spaces With Underscores | If checked, converts spaces in filenames to underscores.
Ignore 'The' in Artist names | If checked, artists' names starting with 'The' will instead be styled ', The'.
VFAT Safe Names | If checked, replaces characters that are incompatible with MS-DOS or VFAT file systems with underscores. Most people can leave this option enabled.
Restrict to ASCII | If checked, all non-ASCII characters will be replaced with underscores. Do not check this option if you have non-English characters in your tags. Most people can leave this option unchecked.
Custom Character Replacement | Replace the tag expressions you write under the Replace box with character strings you write in the With box. Useful if there are mis-spellings in CDDB.
Destination Preview | Shows the original naming scheme of your media files and how they will look after the changes are applied (not available since ver. 2.4.2).
Overwrite Destination | If checked, overwrites files of the same name without asking for further confirmation (not available since ver. 2.4.2).

##### Advanced Contents

The code version of the Token Bar, which allows you to code the name format of media files. Activate it by pressing Advanced... in the interface menu. To change back click Basic....

Enclose conditional inclusion arguments such as CD number in braces, like this:

`%artist%/%album%{/Disc %discnumber%}/%track% %title%`

Note: formerly, the coding was `%token`, as of 2.4 it is `%token%`.

#### Statistics Synchronization Between Collections and with Last.fm

Beginning with version 2.7, &amarok; allows syncing the play-related metadata and statistics of the tracks (such as rating or play count) between any of your collections which show up in Media Sources Local Music and with the Last.fm web service, if you choose to use Last.fm.

##### Manual Syncing

At any time, you can start manual synchronization from Tools Synchronize Statistics...

From here, you can start a synchronization between the collections you select here, which will default to what you have configured in the &amarok; Metadata configuration.

###### Conflicts and Syncing Statistics Dialog

When syncing, &amarok; will show a dialog window which states the conflicts and statistics of the syncing that has recently been in progress. In this window you will be able to see three tabs: Matched Tracks, Unique Tracks and Excluded Tracks.

Matched Tracks

  This tab will show all the tracks that &amarok; has found in more than one collection, and reflects conflicts. When tracks are grouped, you can see two types of background: light green, and light red. A light green background indicates the new or updated field, whilst a light red background will indicate the old/overwritten field. You do not need to solve all conflicts listed here; the particular field of the listed tracks are not going to be synced if you do not resolve the conflict.

Unique Tracks

  These are tracks found in only one collection. You can use it as a difference view. Track dragging is supported here.

Excluded Tracks

  These are tracks that are not synced because of different reasons, such as identical metadata, so as not cause to disorder in the database.

##### Synchronizing with Last.fm

If you have the Last.fm plugin enabled and configured correctly with your Last.fm account, you can choose to also synchronize your &amarok; play counts, ratings and labels with your Last.fm Library. The sync takes some time, but you may continue using &amarok; while it is syncing. Please note that Unattended Synchronization (which will be explained later on) is not possible with Last.fm, and synchronization from Last.fm to &amarok; needs to be initiated manually.

###### Spelling Auto-Correction

Last.fm enables by default a feature that will auto-correct common misspelling during the sync. It can happen that even if you scrobble many track plays, it does not show up in Matched Tracks as Last.fm knows the track under a slightly different name.

You can disable this feature on the Last.fm site, and changes will be applied also to your past scrobbles. You have two options:

Off

  Tracks are matched properly, but if you change your tags after some time, your play-count will be split in two tracks.

On

  You can play-count the tracks even if tags are changed after some time, but you will have to use Last.fm preferred spelling.

##### Unattended Syncing

Please note the dialog will only appear in the case of iPods.

When you connect a device that is able to sync with your collections, a pop-up like this will appear.

For unattended syncing to start, you only need to click Yes in the pop-up. &amarok; will work in the background, so the metadata in your device including ratings, first/last played times, play counts and labels will be synced with other collections configured to participate in the synchronization, and tracks recently played on the device will be scrobbled to Last.fm, if it is enabled. The process will not ask for user interaction unless any conflict is found in the middle.

#### Remote Collections

Often it is very useful to share your media files across the network, especially if you want to use it on different computers. This can be done in different ways:

- Ampache

- DAAP

- Samba

- UPnP

##### Ampache

&amarok; is able to play music from an Ampache media server. If you want to install a server, see here for more information.

##### Ampache Client

Activate the Ampache service using Settings Configure Amarok Plugins. Click on the icon to open the configuration dialog.

Select Add Server:

Configure the service with the data entered on the server:

Now the Ampache service should appear in Media Sources Internet.

##### Digital Audio Access Protocol (DAAP)

DAAP is a protocol to share media over a network. It was first used for the iTunes music player, but is used widely now. The current state is that the DAAP-plugin won't work with a recent iTunes, the Firefly media server is known to work.

##### Client

&amarok; will show the tracks from the server in the Media Sources Local Music pane if you enable the DAAP Collection in Settings Configure Amarok Configure Plugins Collections. If the collection is not showing up, click the icon to be sure you are not in Merged View.

##### Samba

Samba is a free implementation of the SMB/CIFS protocol which is used to share files and printers in a network. Most modern file managers like &dolphin; and Nautilus support this protocol.

##### Client

You need to mount the share to use it in &amarok;. To do this, you need to install the package smbfs. Use the command

`sudo mount -t cifs //host/share /mount-point/`

to mount the share. After that you can use it like a local folder and add it to your local collection.

##### Server

The easiest way is to use your file manager. On Debian-based distributions like &ubuntu; you can install a &dolphin; extension to manage shares using

`sudo apt-get install kdenetwork-filesharing`

Open the properties of a folder in &dolphin; and switch to the Share tab.

To share the folder, just check the Share with Samba (Microsoft Windows) field and set the share name under the Name field. Check the Allow Guests checkbox to allow anonymous users access to the folder.

The folder should now be accessible to the network. Please see the Client section for details on how to use it in &amarok;.

##### Universal Plug and Play (UPnP) / DLNA

UPnP is a set of protocols to share media on the network. It is also supported by a wide range of residential gateways and Network Attached Storage devices. UPnP support is now commonly marketed as DLNA.

&amarok; has a built-in UPnP media share client so it can play tracks shared on the network. To enable it, use Settings Configure Amarok Plugins Collections and check the box by the UPnP Collection plugin.

When a media share is discovered it will be shown in Local Music.

The UPnP feature depends on KDE's UPnP media server support. As of now (2015) there is no working UPnP kio-slave available.

#### External Database

&amarok; 2.2 and above support an external MySQL database as a backend.

##### Install MySQL-Server

First you need to install an MySQL server. On Debian-based distributions like Ubuntu you can use

`sudo apt-get install mysql-server mysql-client`

to install it. You will be asked to specify a password for the root-account for the database. The mysql-client package is needed in order to execute some of the commands in this document, but it's not fundamental to the use of &amarok;.

##### Configure Database

Connect to the local database using

`mysql -u root -p`

You will be prompted for the password for MySQL's root user. You will get the

    mysql>

prompt.

Create a new user amarokuser with the password amarokpass using the

`CREATE USER 'amarokuser'@'localhost' IDENTIFIED BY 'amarokpass';`

command. Amarok needs its own database, which is created with

`CREATE DATABASE amarokdb;`

Give the new user access to the database by entering the

`GRANT ALL ON amarokdb.* TO 'amarokuser'@'%' IDENTIFIED BY 'amarokpass';`

command, where % is a wildcard to allow all hosts to connect to the database. Now use the

`FLUSH PRIVILEGES;`

statement to reload various internal caches used by MySQL. Finally

`exit`

closes the MySQL prompt.

By default the server can only be accessed by the local host. To change this you need to edit the file `/etc/mysql/my.cnf` and adjust the address near bind-address to the one your server listens on the network. 0.0.0.0 listens on all interfaces. After that you need to restart the server using

`sudo service mysql restart`

##### Configure Client

Open the configuration dialog by clicking Settings Configure Amarok Database. Enable the checkbox and enter the user data.

You need to restart &amarok; so that the changes take effect.

##### Migrating from MySQL Embedded to MySQL Server

If you want to maintain the statistics, &etc; that you have in the embedded MySQL database from before &amarok; 2.2, you can do the following:

First, start &amarok; 2.2+ at least once to give the database a chance to update to the latest schema version.

Next, kill the running MySQL service

`sudo /etc/init.d/mysql stop`

and start a MySQL daemon from your `~/.kde4/share/apps/amarok` directory (--defaults-file MUST be the first option!):

`/usr/sbin/mysqld --defaults-file=`pwd`/my.cnf --default-storage-engine=MyISAM --datadir=`pwd`/mysqle --socket=`pwd`/sock --skip-grant-tables`

The skip-grant-tables means you can use any password or username to connect to it. 'localhost' will not work, the MySQL client will try to use a &UNIX; socket. Using 127.0.0.1 as the host makes it work. Some systems may restrict this access through apparmor or SE&Linux;. They can be temporarily disabled with

`sudo /etc/init.d/apparmor stop`

Now, run mysqldump, passing in the -S option to specify the local socket. This will dump your old embedded DB out to a SQL file.

`mysqldump -S sock amarok > amarok.mysql`

You can then restart your MySQL service and load this SQL file into your MySQL server. You'll have needed to already run the GRANT statement above and create an &amarok; database (CREATE DATABASE amarok;):

`sudo /etc/init.d/mysql stop mysql -u amarokuser -p amarok < amarok.mysql`

You may need to re-scan your collection in &amarok; after completing this.

#### Working with Media Devices

Use &amarok; to play music from media devices such as MTP devices, iPods, and generic USB devices.

##### Connecting Media Devices

Connect your media device using the USB cable. The device notifier applet in &kde; will automatically pop up with a list of all available media devices. Click on the icon to access your device.

##### Play Music from the Media Device

Or just wait until your device shows up in &amarok;, which will take anywhere from a few seconds to a minute or more, to scan the device for music tracks. Until then the vfat volume will show 0 tracks.

After the scan, &amarok; will display all the music tracks available in the Media Device, which you can then move to the Playlist to play them, or copy or move to your Local Collection.

##### Managing the Media

Menu Item | Description
--- | ---
Add to playlist | Adds all the selected tracks from the media device to the current &amarok; playlist.
Replace the playlist | Clears the current &amarok; playlist and adds instead all the selected tracks from the media device.
Configure Device | Opens a dialog box to edit configuration options for the device.
Disconnect Device | Disconnects the device from the computer.
Copy to collection | Copy all the selected tracks to the Local collection or to any other media devices connected.
Move to collection | Move all the selected tracks to the Local collection or to any other media devices connected.
Move to trash | Moves all the selected tracks from the media device to the trash.
Delete tracks | Deletes all the selected tracks from the media device.
Organize Files | Organizes tracks based on the configuration for the device.
Edit track details | Opens a dialog box to edit details of the selected tracks from the media device.

##### Troubleshooting Media Device support

As of Amarok 2.8, the following devices should work with Amarok:

- Generic Media Players connected through the UMS protocol.

- iPods/iPhones, depending on their support by the libgpod library. The status depends on the version of this library installed on your system, please refer to the libgpod support listing on their homepage.

- limited support for devices using the MTP protocol, the support for new Android devices is currently implemented for the next Amarok version.

### Cover Manager

The Cover Manager is a tool to manage the cover art images of your collection. It allows you to change covers easily, fetch all missing covers and browse them. You can find Cover Manager in Tools Cover Manager.

When scanning the local music library, &amarok; tries to find corresponding covers for albums. At this point, &amarok; only searches them from the file system, not from the Internet. If none are found in your files, &amarok; uses a placeholder image like this for the album cover:

If an album is missing a cover or the current one is incorrect, you can fetch one from the Internet with Cover Manager.

#### Browsing Covers

With Cover Manager, browsing covers is easy. You can view covers for any artist by selecting from list on left, or use the search box to find the right album. On the status bar, you can see how many covers are currently listed and how many albums are missing covers. You can also set the Cover Manager to only show albums with or without covers. By right-clicking on cover art and selecting Display Cover you can view the cover image at the original size.

#### Fetching Missing Covers

If there are albums with missing covers, you can try to automatically fetch them all from the Internet. Just select Fetch Missing Covers from the top of the window and Cover Manager will try to find covers. If there are many albums missing covers, the process may take some time.

#### Changing Cover Art

If there is an album with an incorrect cover, you can fetch new one from the Internet. Right-click on the cover and select Fetch Cover. A dialog window for finding a new cover will open. &amarok; automatically tries find the correct album art by searching with the artist name and album name. Usually this works very well, as with the example, and you will most likely see a correct cover on results as in the example. If no correct cover is found, you can try to enter a custom search phrase or change the source of images by clicking on Configure... You can select where to search, including Last.fm, Google Images, Yahoo! Image Search or Discogs. After finding a cover for album, just click OK and the changes will be applied.

You can also use a image from your hard drive as an album cover. If you want to store the image in the Album folder, name it `cover.jpg` or `cover.png` for best results. As before, right-click on the incorrect image and click on Set Custom Cover.

If you don't like the cover art at all, you can unset it by right-clicking on the image and selecting Unset Cover.

You can find this menu without Cover Manager too. Just right-click on the album or song from your playlist or collection and hover the Album item.

### Tag Editor

The built-in Tag Editor allows to show and change meta data of music files. To open the editor just right-click on one or more selected songs, albums, or genres, in either your collection or your playlist, click on Edit Track Details and choose the Tags tab.

#### Edit Tags Manually

Change the proper line to the required value and click Save & Close. Clicking Cancel discards all unsaved changes.

##### Tags

Tags are metadata such as the track number or the artist of the track contained in the file. A very common kind of tag is the ID3 tag.

Here is a list of tags supported by &amarok;:

Tag | Description
--- | ---
Title | The title of the track.
Artist | The artist or band of the track.
Composer | The composer of the track.
Album Artist | The artist or band of the album.
Album | The album title.
Disc Number | The disc number of the album; important in a multi-CD album.
Genre | The genre of the track. This can be a custom genre, but usually one of the predefined ones is used.
Beats Per Minute | The tempo of the track.
Track | The number of the track on the album.
Year | The year in which the track or album was published.
Comment | A text comment for the track.

##### Edit Single Track

In this mode you can change all supported tags of the chosen file.

##### Edit Several Tracks

Several tracks can be selected by clicking on the artist, album, or genre in the your collection or by selecting several tracks in the playlist using the &Ctrl; (non-sequential) or &Shift; (sequential) key.

##### All At Once

More general tags can be set for a group of tags at once. It works just like the single-track-mode, but the title and track number tags are locked.

##### Track By Track

This mode is pretty similar to the single-track-mode, except for the ability to switch between the selected tracks using the Next and Previous buttons. It is activated by clicking on the checkbox Per Track on the bottom of the window.

#### Get Tags from MusicBrainz

&amarok; 2.8 has the ability to guess tags from the MusicBrainz database. Click the Get Tags from MusicBrainz, wait a moment for the database to be searched for matches, and then Update Tags, or Cancel.

If you have the packages libofa and ffmpeg installed, and &amarok; is compiled with them, Musicbrainz will be able to use fingerprinting (the MusicDNS service) to search for albums and tracks without good filenames or existing tags.

MusicBrainz Tagger dialog

MusicBrainz Tagger dialog

#### Guess Tags From Filename

It is also possible to tag tracks using information in the filename. This is a very convenient feature when dealing with lots of files with a consistent naming scheme.

Some tracks need to be edited manually, because special characters like single quotes are omitted in file names. A preview helps to create the correct pattern.

##### Options

There are also several options to format the result. These are self-explanatory.

##### Basic

In the basic view you get a drag-and-drop menu to create the pattern in the filename.

##### Example

Filename: 01-The Beatles-Hey Jude.mp3

Tracknumber: 01

Artist: The Beatles

Title: Hey Jude

##### Advanced

In the advanced view you can create a pattern using markers in a string.

##### Example

Filename: 01-The Beatles-Hey Jude.mp3

Tracknumber: 01

Artist: The Beatles

Title: Hey Jude

### Transcoding

Transcoding allows you to encode media files to a variety of formats while copying or moving them to a collection (Local Collection, USB Universal Mass Storage Collection and iPod, iPad & iPhone Collection support transcoding as of &amarok; 2.8). A word of warning: be careful when you use this feature, as you are working with actual files on your hard drive. Have a backup!

#### Interface

The Transcoding dialog will appear whenever you copy or move tracks to one of the collections that support transcoding. You can also transcode tracks within the Local Collection by using the Organize files functionality.

#### Transcode Tracks Dialog

If you choose to copy or move files to a supported collection, the following dialog will pop up:

Menu Item | Description
--- | ---
Copy | Selected media files will be copied to your collection without re-encoding.
Encoder list | List of all your installed codecs; choose among them to be able to transcode. If this list is empty, you need to install FFmpeg.
Transcode all tracks | Transcode every selected track to the chosen codec
Transcode only when needed for playability | Only transcode tracks which need to be transcoded to play in the destination system
Transcode only if source and destination formats are different | Transcode only if source and destination file formats are different
Remember this choice for the next time | Save the preference for the current destination collection. This includes the copy/transcode preference and transcoding parameters.
Cancel | Exits the Transcode Tracks dialog.

#### Custom Encoding

Whether to save space, to make your files readable by a portable music player or a particular software program, &amarok; can handle it. Choose a codec from the list and a custom setting and click Transcode.

Menu Item | Description
--- | ---
Transcode | Begins encoding with the selected codecs and parameters. In case of the Local Collection the Organize tracks dialog will pop up. More about Organize tracks.
Cancel | Exits the Transcode Tracks dialog.

#### Saving Transcoding Preferences

As mentioned in the Remember this choice for the next time description, &amarok; can remember transcoding preference per each of your collections. The preference can be changed any time in the Configure Local Collection Configure Amarok dialog page for the Local Collection and in the configure dialogs of iPod, iPad & iPhone and Universal Mass Storage collections.

#### Pro Tip: Strip Audio out of Video Files

&amarok;'s transcoding capabilities can be used to extract audio from video files while copying or moving them into a collection. Just select video file(s) in Amarok embedded file browser, right-click and choose Copy to Collection. Standard Transcode Tracks dialog will appear. Choose one of the encoders, hit Transcode and transcoding will begin.

### Script Manager

The Script Manager contains the options required to extend the functionality of &amarok; through custom scripts. It is reached from the Settings menu, Configure Amarok Scripts. Scripts can be installed from downloaded script packages, or from the Manage Scripts button which can fetch and install the latest user-contributed scripts from the Internet.

Please refer to Configuring Amarok -> Scripts for more information.

## Playlist

The Playlist is a powerful part of &amarok;. One can drag in some tracks, but there is a lot more available.

- Saved Playlists

- Playlist Filtering

- Queue Manager

- Dynamic Playlists

- Automatic Playlist Generator

### Saved Playlists

Saved playlist is a traditional type of playlist. Saved playlists work like &amarok;'s current playlist, saved in the &amarok; database or your file system for later use. It can be fun to use them at events when you have specific songs you want played.

Creating a saved playlist is very easy with the exact songs and order that you want. For every day use, sometimes it is faster to use Dynamic Playlists or the Automatic Playlist Generator when you have less specific needs for specific tracks and progression.

To browse and manage your saved playlists, go to Playlists Saved Playlists on the menubar.

#### Managing saved playlists

##### Saving a Playlist

You can save your current playlist into the &amarok; database by clicking the save icon ( ) at the bottom of the Playlist view. You can browse playlists in the &amarok; database by going to Playlists Saved Playlists in the Media Sources pane and expanding the Amarok database section. You will find them in your filesystem here: `~/.kde(4)/share/apps/amarok/playlists`.

##### Exporting a Playlist

You can export your current playlist to your file system by clicking Playlist Export Playlist As... from the top menubar. From the opening save dialog, you can change the name, location and type of the playlist. Then just click on Save. Remember, playlist files don't contain any music data. If you want to listen the content of the playlist on another computer, you'll need to bring your music with you unless that computer already has the tracks.

##### Importing a Playlist

You can import a playlist file into &amarok; just by copying it to any directory that &amarok; knows as part of your music collection. When &amarok; detects a new playlist on any folder of your collection, it will add it to the Playlist Files on Disk section of Playlists Saved Playlists in the Media Sources pane. If the playlist doesn't appear right away, you can update the collection manually by clicking Tools Update Collection. If instead of importing the playlist, you want to just listen it, open it with Amarok Play Media... from menubar. Selected playlist will be added to the current playlist.

### Playlist Filtering

The Search playlist function in &amarok; is very powerful, as it allows you to search for different tracks by various constraints. The search results limits what you can actually see, which makes it easy to queue up wanted tracks, or remove them from the playlist.

#### Edit Box

When you type something in the Search playlist field, &amarok; will search in your playlist and mark matching tracks, artists and so forth.

##### Examples

The first track that matches the current search will be highlighted as in this example:

#### Search Preferences

This is a small drop down menu with options for the search field, if you need more than simple search. You can choose which types of searching you want to use in your Search playlist. Check the boxes according to what you need for your search.

##### Check boxes

Name | Description
--- | ---
Tracks | &amarok; will search for text from tag: Track Titles
Albums | Search for text from tag: Album titles
Artists | Search for text from tag: Artist
Genre | Search for text from tag: Genre
Composers | Search for text from tag: Composer
Rating | Search the rating of all songs in your playlist
Years | Search for year of publication
Show only matches | When this box is marked &amarok; will display only the tracks that match the current search

##### Show only matches - example

### Queue Manager

Tracks are loaded in the Playlist. In normal track progression, when a song is over, the next one played is the one below the just-played one. The Queue is one way to change the order in which the songs are played.

#### How to Create a Queue

It is very easy to make a Queue; just select one or more tracks and move in the center of &amarok;, to the Pop-Up Dropper (PUD), or right-click and scroll to Queue Track.

As you select or add songs to the Queue each of them takes a number. The number indicates the order in which songs will play.

##### Example

First, select the track

First, select the track

Then right-click for context menu

Then right-click for context menu

Or queue track by dragging to the PUD

Or queue track by dragging to the PUD

Queued tracks in playlist

Queued tracks in playlist

#### How to Edit the Queue

If you want to make any changes in the Queue you can use the Queue Editor. Start the Queue Editor from the menu in Playlist Edit Queue.

##### Queue Editor

Button | Description
--- | ---
| Move selected track ahead in the list.
| Move selected track below in the list.
| Remove selected song from the Queue.
| Remove all songs from the Queue.

### Dynamic Playlists

Some media players are designed to load the entire collection of music in a single playlist, then play it in random order, or search/ sorted, then queued. With a larger collection, this way of managing your playlist isn't efficient. &amarok;'s Dynamic Playlist is a better way to explore your music.

The Dynamic Playlist is reached from Playlists Dynamic Playlists in the Media Sources pane.

#### How the Dynamic Playlist works

The dynamic playlist is a list that grows while you listen to your music.

It will keep a certain number of songs in front of the currently played song and it will clean up the playlist by removing old songs.

The songs that will be added to the front of the playlist are determined by the currently selected dynamic playlist.

#### Using a Dynamic Playlist

To enable dynamic playlists, click the button in the Dynamic Playlist pane. A bar will be displayed at the top of the Playlist pane announcing that it is enabled. Select which dynamic playlist to use from the list of options by double clicking it. The currently selected dynamic playlist is bolded.

You can adjust the number of songs before and after the currently playing song to be displayed in the playlist with the Previous and Upcoming fields. You can prevent the same track appearing in the current playlist more than once using the button. The Repopulate button allows you to generate a new set of tracks. This can be used together with a high Upcoming setting to generate fixed playlists for export.

#### Defining Dynamic Playlists

Each dynamic playlist is built of biases. A bias defines a particular constraint on the behaviour of the dynamic playlist, and new items to be added to the playlist are selected at random from a list of all songs which match the biases. Biases may either be a single bias (&eg; the Search bias) or a grouping of other biases (&eg; the Match All bias). Some examples playlists are included, and you can define a new playlist with the button.

To change the name of a playlist, either use the button or right click on it and select Rename playlist. A bias can be edited with the same button or by right-clicking and selecting Edit bias, and for biases which have sub-biases, a new sub-bias can be added by right clicking and selecting Add new bias.

##### Biases

Because multiple biases may be defined, &amarok; may at times return an empty playlist. This occurs if it is given a set of impossible-to-fulfill conditions. To avoid this and to better understand each available bias, along with any options it takes, please see below:

Search

  This bias matches tracks found by a given search query. It uses the same search string used in the collection browser. You may also use the Match meta tag bias to match tags in the same way as the collection search editor.

Random

  This bias matches any track, entirely at random.

And

  This group bias matches tracks which match all sub-biases.

Or

  This group bias matches tracks which match any sub-biases.

Partition

  This group bias matches tracks from the sub-biases in proportion. The edit window for this bias has sliders for each sub-bias to adjust the proportions. For example, with two sub-biases with their proportion sliders set equal, half of the playlist will match one bias and half the other.

  Note: The dynamic playlist is internally working with more tracks than you can see, so after clicking Repopulate the list might not contain a 50:50 distribution of songs. However as you continue listening to music you will see that in the end it actually matches.

If Else

  This group bias matches tracks from the first sub bias unless there are no matching tracks found, in which case it matches tracks from the second sub-bias. See the example Album Play playlist for an example of this in use.

Match Meta Tag

  This bias matches tracks which meet certain conditions on a tag. The selection interface is the same as the search filter editor in the collection browser. Select a tag type from the drop-down and fill in the constraint. (Hint: You can use a number of these in an And bias.)

Album Play

  This bias matches tracks related to the previous item in the playlist by album. You can select the details of the bias from the drop-down menu. For example, Track directly follows previous track in album is used in the example Album Play playlist to ensure full albums are played in order.

Quiz Play

  This bias matches tracks for which the first character of a given tag (title, artist or album) is the same as the last character of the same tag for the previous tag. For example, with artist selected, you could have the following series: Led Zeppelin -> Nine Inch Nails -> Santana, &etc;

EchoNest similar artist

  This bias matches tracks which are similar according to EchoNest, either to the previous track or to any track in the playlist. This allows you to play a set of consistent tracks simply by adding a single track to the playlist and turning on the dynamic playlist, rather than defining all the match rules yourself.

Last.fm similar

  This bias performs the same function as the EchoNest bias, but uses Last.fm to determine similarity. You can also choose similarity to the previous track or to the previous artist.

Last.fm weekly top artist

  This bias matches tracks which are on the weekly charts from Last.fm for a given time period.

#### A dynamic playlist in use

#### Using your Dynamic Playlist

To enable the dynamic playlist you have created simply check the On box in the upper-left corner of the pane. To regenerate the entire playlist at any time, click Repopulate, to the right of On.

The default number of items in the playlist is your 5 previous plays plus 10 upcoming items. With the currently playing track, this makes 16 items in the playlist at any given time. The number of tracks can be changed right below the On checkbox.

Below that is the dropdown menu for loading saved playlists, the button to save playlists, and the button to delete them.

#### A dynamic playlist in use

### 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

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

- Adds a blank preset that can be modified.

- Opens up the APG Preset Editor window to edit the currently selected preset constraints.

- Removes the selected preset from the list; can not be undone.

- 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 to a .xml file that can be imported.

- Loads APG with the selected preset and automatically generates a playlist.

#### Working with Presets

APG Preset Editor window

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 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 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.

Playlist generated by the constraint tree below.

## Various

Topics which didn't fit elsewhere, such a Moodbar, Amarok on other platforms, troubleshooting, common problems, and the FAQ:

- Moodbar

- ReplayGain

- Amarok on other Desktops and Operating Systems

  - Non-KDE Desktops

  - Amarok on Windows

  - Amarok on OS X

- Troubleshooting and Common Problems

- FAQ

### The Moodbar

The Moodbar shows you the mood of a track, which you can then use to figure out when something interesting happens in the song.

In order for &amarok; to display moodbars for your music, you will need the Moodbar program (see below for downloads and binary packages).

The Moodbar package requires GStreamer and various plugins depending on the filetypes you use (see Supported filetypes). You will not need the phonon-backend-gstreamer package to create .mood files.

There are two parts to the new Moodbar implementation: the Moodbar package, which contains a program that takes a music file and generates a .mood file, and support code in the &amarok; source, which runs the binary and displays the Moodbar. The Moodbar package depends on the GStreamer libraries. Without the Moodbar package, &amarok; cannot generate the moodbars for your music.

As an alternative, there is a new script which will create moodbar files for tracks in an &amarok; playlist; this is an exception to the above. The script needs nothing but &amarok; to work, but it only creates the .mood files as they are played in the Playlist.

The Moodbar is due to the work of Gavin Wood and Simon O'Keefe, who designed the algorithms; their original paper is here.

#### Summary of Requirements

- The Moodbar binary, in your PATH (it should be listed upon running `which moodbar` from a console) — Remember to configure the Moodbar package with proper path, &eg; build and install with commands `./autogen.sh --prefix=`pkg-config --variable=prefix gstreamer-1.0` && make && sudo make install`

- The GStreamer 1.0 library and plugins for the formats you want Moodbar to be able to analyse. (An earlier GStreamer 0.10 based version is also still available for some distributions)

- The Fastest Fourier Transform In The West (fftw.org) FFTW library version 3.0 or above (at least single-precision floating point version - libfftw3f) — If your platform does not provide this for you or you need to compile your own version, remember to configure the FFTW package with `./configure --enable-single`

- A version of &amarok; with a Use moods option in the General section of the configuration screen. This means 1.4.4 or higher in the 1.4 series or 2.2.2 or higher in the 2.x series.

Systems with package managers should automatically install the GStreamer plugins and FFTW along with the Moodbar package if available; this information is provided mostly for people who want or need to compile from source or manually install packages, or where the distribution specific instructions are outdated and no updated moodbar package is yet available.

#### Usage

Currently .mood files must be generated manually. &amarok; cannot do it for you. To do this for your entire collection, use the Moodbar File Generation Script described below.

To enable the display of moodbars in &amarok;, activate it in the configuration: Settings Configure Amarok General Show Moodbar in Progress Slider. Moodbars should now appear in the track sliders in the player window and Playlist; there will also be a mood field that you may add to your playlist layouts.

#### Installation

##### Source Downloads

Latest release: moodbar-0.1.4.tar.gz — this is the Moodbar source package, which contains the Moodbar program (which generates .mood files from music files), and a GStreamer plugin that does the work. The Moodbar package needs GStreamer 1.0.* installed, plus the 1.0.* version of various plugins. Be sure to install the Moodbar package into the same prefix as GStreamer — follow the instructions in the summary of requirements chapter. The 0.1.4 is a a fork of original 0.1.2 sources, updated to use GStreamer 1.0. The old 0.1.2 sources are not reliably available online any more, but packages might be still available for some distributions.

If you find any bugs, please submit a bug report at bugs.kde.org.

##### Debian packages

This section contains old instructions for the GStreamer 0.10 based moodbar version 0.1.2, they might be outdated.

A package for Moodbar is now available in Debian unstable. Simply run `apt-get install moodbar` . You will likely also want to install gstreamer0.10-plugins-ugly, gstreamer0.10-plugins-good, and gstreamer0.10-plugins-bad for format support.

##### Kubuntu and Ubuntu packages

This section contains old instructions for the GStreamer 0.10 based moodbar version 0.1.2, they might be outdated.

A package for Moodbar is available in the official package repository; just ensure the universe section is activated (which should be default anyway). Just install the package moodbar with your preferred package manager (Kpackagekit, Aptitude, Adept, Synaptic). You will likely also want to install gstreamer0.10-plugins-ugly, gstreamer0.10-plugins-good, and gstreamer0.10-plugins-bad for format support.

Or, to install, paste this into Firefox or &konqueror; and hit &Enter;.

`apt://moodbar,gstreamer0.10-plugins-ugly,gstreamer0.10-plugins-good,gstreamer0.10-plugins-bad?section=universe?refresh=yep`

##### Gentoo ebuilds

This section contains old instructions for the GStreamer 0.10 based moodbar version 0.1.2, they might be outdated.

Moodbar is available in Portage, simply `emerge moodbar` Unofficial ebuilds are no longer required.

##### RPM builds

This section contains old instructions for the GStreamer 0.10 based moodbar version 0.1.2, they might be outdated

If you are a rpm-based distro user, you can build a .rpm using rpmbuild with latest

gstreamer-plugins-moodbar.spec. The binary package will be soon available for PLD-linux distro.

##### Fedora

This section contains old instructions for the GStreamer 0.10 based moodbar version 0.1.2, they might be outdated.

In Fedora 7 and higher (up to 16 as of this writing) Moodbar is available in the default repositories. Simply install it with your PackageKit GUI or with the following yum command:

`yum install moodbar`

##### openSUSE packages

GStreamer 1.0 based version 0.1.4 is available in KDE:Extra repository for openSUSE Leap 42.3 and later. An earlier GStreamer 0.10 based version 0.1.2 is also still available in the main repository for some openSUSE versions.

For details on how to add repositories, see the openSUSE wiki.

1-Click Install for openSUSE - just choose your version and installation procedure will do the rest:

- openSUSE Tumbleweed

- openSUSE Leap 15.0

- openSUSE Leap 42.3

##### Mandriva packages

This section contains old instructions for the GStreamer 0.10 based moodbar version 0.1.2, they might be outdated.

First of all, you need to add PLF repositories, so visit easyurpmi.zarb.org and add them to your repositories list.

Then simply install the following packages:

- gstreamer0.10-moodbar

- gstreamer0.10-plugins-ugly

- gstreamer0.10-plugins-good

- gstreamer0.10-plugins-bad

##### Arch &Linux;

This section contains old instructions for the GStreamer 0.10 based moodbar version 0.1.2, they might be outdated.

There is a PKGBUILD for Moodbar in the Arch User Repository (AUR) available here.

For more information about the AUR and working with PKGBUILDs, see the AUR User Guidelines.

##### FreeBSD

This section contains old instructions for the GStreamer 0.10 based moodbar version 0.1.2, they might be outdated.

There is a port: audio/gstreamer-plugins-moodbar here.

To install the port: `cd /usr/ports/audio/gstreamer-plugins-moodbar/ && make install clean`

To add the package: `pkg_add -r gstreamer-plugins-moodbar`

#### Moodbar File Generation Script

Here is a simple bash script that will add .mood files to your entire collection. It adds mood files for all files matching the extensions in the current directory and all subdirectories, so it's best run from the base of your music directory.

     #!/bin/bash
     DIR=${1:-.}
     LAST=~/.moodbar-lastreadsong
     C_RET=0
     control_c()        # run if user hits control-c
     {
       echo "" > "$LAST"
       echo "Exiting..."
       exit
     }
     if [ -e "$LAST" ]; then
       read filetodelete < "$LAST"
       rm "$filetodelete" "$LAST"
     fi
     exec 9< <(find "$DIR" -type f -regextype posix-awk -iregex '.*\.(mp3|ogg|flac|wma)') # you may need to add m4a and mp4
     while read i
     do
       TEMP="${i%.*}.mood"
       OUTF=`echo "$TEMP" | sed 's#\(.*\)/\([^,]*\)#\1/.\2#'`
       trap 'control_c "$OUTF"' INT
       if [ ! -e "$OUTF" ]
         moodbar -o "$OUTF" "$i"
       fi
     done <&9
     exec 9<&-
     exit $C_RET

Copy and paste the above into a text file named moodbar.sh in your music directory and run the following commands:

`cd /path/to/music bash moodbar.sh`

Alternatively if the above does not work, you may try:

`chmod +x moodbar.sh ./moodbar.sh`

This may take a very long time for large collections! Note that the moodbars will not appear in &amarok; until &amarok; rescans the collection. The generated `mood` files will be dotfiles (&ie;, prefixed with a full stop), or hidden files - so keep this in mind if you can't find any generated mood files.

Based on the above script, an alternative for multicore CPUs:

     #!/bin/bash
     NUMCPU="$(grep ^processor /proc/cpuinfo | wc -l)"
     find . -type f -regextype posix-awk -iregex '.*\.(mp3|ogg|flac|wma)' | while read i ; do
            while [ `jobs -p | wc -l` -ge $NUMCPU ] ; do
                    sleep 0.1
            done
            TEMP="${i%.*}.mood"
            OUTF=`echo "$TEMP" | sed 's#\(.*\)/\([^,]*\)#\1/.\2#'`
            if [ ! -e "$OUTF" ] ; then
                    moodbar -o "$OUTF" "$i" &
            fi
     done

#### Troubleshooting

- If the Moodbar executable gives you a bus error, that almost always means it can't decode (or can't find) your file. Take a look at the supported file types below for ideas on which GStreamer plugins to install. You can also try the command below to test whether GStreamer can decode your file:`gst-launch-1.0 filesrc location=[file] ! decodebin ! fakesink`

- If you are using the ffmpeg plugin to decode mp3s, you may also receive mysterious bus errors. The solution is to stop using the ffmpeg plugin, as it is extremely buggy — use mad instead.

- If the Moodbar executable tells you that it can't find an element — &ie;, it gives an error message like

      Could not create element of type fftwspectrum, please install it.

  — that usually means that you either don't have the required plugins installed (see the plugin list here), or that you didn't install the Moodbar package in the same prefix as GStreamer. If libmoodbar.so and libgstdecodebin.so are not in the same directory, then Moodbar is not installed in the same prefix as GStreamer. Please read the INSTALL file for instructions on how to configure the moodbar package correctly. Alternatively, if you know what you're doing, it may be easier for you to take a look at the `GST_PLUGIN_PATH` environment variable.

- If you're wondering why the Moodbar isn't working, either not working at all or not working for a particular file, run the command below, where [file] is a music file:`moodbar -o test.mood [file]` To generate a test image preview, one can use the commandː`gst-launch-1.0 filesrc location=[file] ! decodebin ! audioconvert ! fftwspectrum ! moodbar height=50 max-width=300 ! pngenc ! filesink location=mood.png`

- If you have multiple versions of GStreamer installed, make sure all of the required plugins are installed for version 1.0.* -- different versions cannot use each other's plugins.

#### Supported Filetypes

You will need various Gstreamer plugins to enable Moodbar to analyze your files. Here is a list of the plugins you will need; make sure to install the 1.0.* version of each plugin:

Filetype | Required Plugin | Note
--- | --- | ---
All | gstreamer-1.0.*, gst-plugins-base, gst-plugins-good
mp3 | gst-plugins-mad (in gst-plugins-ugly) | ffmpeg plugin has problems; do not use for mp3
ogg | gst-plugins-vorbis, gst-plugins-ogg
flac | gst-plugins-flac
mp4 | gst-plugins-faad, gst-plugins-bad
musepack | gst-plugins-musepack
wma | gst-plugins-ffmpeg

#### Screenshots

Moodbar in progress slider in Amarok 2

Moodbar in progress slider in Amarok 2

### Replay Gain

Replay gain will automatically adjust the volume of the currently played song, relative to other songs, as determined by the person who encoded the audio file. To enable replay gain, see Settings menu.

To handle this, &amarok; relies on metadata embedded in the audio file:

1. If no replay gain information is embedded, &amarok; will not adjust the volume

2. If replay gain information is found, it will be written into &amarok;'s database

During playback, &amarok; will only look into its own database for this information. Updates to the metadata of the file will not always get written into the database during a collection update (&eg; replay gain is deleted from file).

This can lead to unexpected behavior: Songs from the same artist play at different volume levels &etc;

#### Is replay gain being used?

To figure out if the volume problem is caused by replay gain or bad encoding:

- Disable replay gain processing (see above)

- Start &amarok; in debug mode and search for gain- related output:

``amarok -d --nofork | grep gain``

If replay gain is active for the played song, the output will be

Using gain of -10.28 with relative peak of -1

#### View replay gain information

For .flac files, metaflac can be used to view embedded replay gain data:

``metaflac --list Millencolin\ -\ Balanced\ Boy.flac``

Among other things, this will show something like this:

METADATA block #2

type: 4 (VORBIS_COMMENT)

is last: false

length: 390

vendor string: reference libFLAC 1.2.1 20070917

comments: 14

comment[9]: REPLAYGAIN_REFERENCE_LOUDNESS=89.0 dB

comment[10]: REPLAYGAIN_TRACK_GAIN=-1.55 dB

comment[11]: REPLAYGAIN_TRACK_PEAK=0.75894165

comment[12]: REPLAYGAIN_ALBUM_GAIN=-4.19 dB

comment[13]: REPLAYGAIN_ALBUM_PEAK=0.98712158

To view this tracks information within the &amarok; database:

``select id, title, albumgain, albumpeakgain, trackgain, trackpeakgain from tracks where title like "Balanced%";``

Will show:

+-------+------------------+-----------+---------------+-----------+---------------+

| id | title | albumgain | albumpeakgain | trackgain | trackpeakgain |

+-------+------------------+-----------+---------------+-----------+---------------+

| 10459 | Balanced Boy | 0.53 | -5.60297 | 0.44 | -5.60297 |

Note the difference in loudness levels

#### Delete replay gain information

First, delete the metadata from the file:

``metaflac --remove-replay-gain Millencolin\ -\ Balanced\ Boy.flac``

After that, update your &amarok; collection. If it is still using replay gain, update the database entry:

``update tracks set albumgain=-1,albumpeakgain=-1,trackgain=-1,trackpeakgain=-1 where id=10459``

Restart &amarok; and the log output should now show the updated values being used.

Feel free to try and mess with the values manually to improve volume levels.

### Amarok on other platforms

&amarok; is intended for the KDE desktop, but it works on other platforms as well. Although it takes some effort, Amarok can run on these configurations:

| Non-KDE Desktops
| Windows
| OS X

#### Amarok on Non-KDE Desktops

Although &amarok; is one the most well-known KDE applications, it can run on other desktop environments too.

This section shows how &amarok; can be used on non-KDE &Linux; desktops. These are examples; there may be more.

##### GNOME

To configure the proxy for &amarok; on GNOME, modify and add this to `~/.kde/share/config/kioslaverc`

    [Proxy Settings][$i]
    ProxyType=1
    httpProxy=http://username:password@proxyserver:port/
    httpsProxy=http://username:password@proxyserver:port/
    ftpProxy=http://username:password@proxyserver:port/

##### Enlightenment

The &amarok; systray icon does not work by default with E17. So, one should disable the Show tray icon from General Options in &amarok;'s preferences.

##### XFCE

To launch &amarok; faster, enable Launch KDE services on startup by going into Settings Sessions and Startup Advanced and checking the option.

##### Fluxbox

If &amarok; is taking to long to load, add `exec kdeinit` to `~/.fluxbox/startup`.

##### LXDE

In case &amarok; starts slowly in LXDE, you can add kdeinit to the startup applications using the lxsession-edit command.

#### Amarok on Windows

This pages needs screenshots for the Amarok 2.8 version

As you already know, a normal Windows install doesn't use KDE, so if you want to install &amarok;, you can't just download the &amarok; package. You must install a compatible compiler first. Here is described how to download, install and run &amarok; in the Windows operating system.

##### How to download

If you run into any difficulties, please visit the Amarok on Windows wiki page where the latest links will be kept updated. Otherwise, use the latest at the following links:

##### How to install

The installation is very simple, just run the downloaded .exe file.

If you want to update be sure to remove your current install.

###### Step 1

First, review on the license terms.

###### Step 2

Second, choose the install location.

If you want to change the default location, select Browse... and choose a new location.

###### Step 3

Wait a few minutes while the installation finishes.

###### Step 4

When the installation is done, dismiss the window with Close. Your &amarok; installation has finished.

##### Running Amarok

When the installation finishes, you'll find an &amarok; shortcut on your desktop. To run &amarok;, just click the shortcut.

#### Amarok on &MacOS; X

Current Macports 2.1.3 only ships an outdated Amarok 2.6.0 version

&amarok; can be installed and used on the &MacOS; X.

##### Installation using MacPorts

To install &amarok; on &MacOS; X, first one needs to install MacPorts from here. Once MacPorts is installed one needs to run the following command in the terminal:

`sudo port install amarok`

The `port` command will fetch all the dependencies, compile, build and install them. This process may take quite some time, four to five hours in a recent install.

##### Screenshots

The following screenshot shows &amarok; running on the &MacOS; X:

##### Other resources

If you run into difficulties, there is a troubleshooting page here.

### Troubleshooting and Common Problems

If you work through the procedures here, but don't have success, please come into IRC (irc://irc.libera.chat/amarok), post on Discuss under the Amarok category, or write to the Amarok list.

#### Problems installing

##### Bad packaging

Occasionally, users will encounter bad packaging from the distributions; either from the wrong version of a component being included, or some needful part being left out. For some reason, this often happens with MySQL dependencies. Bug reports in these cases should be made to your distribution, not to bugs.kde.org.

##### Difficulties building from source

For those who wish to help out by testing the newest &amarok; versions, a local build is advised. Use this excellent guide: Compiling Amarok from GIT Locally; a Full Summary. Detailed information about git can be found here: Techbase GIT Tutorial.

If you have built successfully before, and now are encountering errors, try removing `CMakeCache.txt` and try again. If that still errors out, remove the entire Build folder and build completely fresh.

The URL to pull from git has recently changed. Run ``git remote set-url origin git://anongit.kde.org/amarok`` if you still using the old URL. Please ping us if you find the old link in our documents so we can update it everywhere.

#### Problems starting up

##### Playlist errors

The current playlist can occasionally get corrupt, which will prevent &amarok; from starting. This can be fixed by simply removing the current playlist file in the &amarok; directory, `$HOME/.kde/share/apps/amarok/current.xspf` . Note that on some systems, this may be `.kde4` rather than `.kde`.

##### Database issues

If the database is corrupt and this is preventing &amarok; from starting, you can move the database to a backup location (or simply delete it). This will cause &amarok; to rebuild the database from scratch. Move the `$HOME/.kde/share/apps/amarok/mysqle` folder to a backup location (such as `$HOME/.kde/share/apps/amarok/mysqle~`) and restart &amarok;.

##### Other issues and backing up settings

If the above two items do not help, or you otherwise need to restore &amarok; to a clean configuration, you can move to a backup location (or delete) the &amarok; directory at `$HOME/.kde/share/apps/amarok` and the &amarok; config files at `$HOME/.kde/share/config/amarok*` (there may be two or three files matching this pattern). Again, the directory may be `.kde4` rather than `.kde`.

#### Problems Scanning, Sorting files

&amarok; scans your music files on first startup, and will keep your collection up-to-date automatically, if you chose Settings Configure Amarok Collection Watch folders for changes.

If you don't want &amarok; scanning for changes, uncheck that, and use Tools Update Collection whenever you make changes to your collection.

More about Amarok collection scanning here.

##### Corrupt tags

Some folks notice that &amarok; seems to be missing some files. One of the causes can be corrupt tags, which you can check using the tagging application kid3. More about tagging here.

To find the bad file(s), run `amarokcollectionscanner` from the console. Details here.

##### Inability to write tags

If &amarok; is not saving changes to tags, you may have permissions problems. Ensure that your user has write permissions to your music. For example, `chown -R youruser Music/` to change ownership to your user, or `chmod -R +w Music/` to add write permissions to the owner.

##### Incorrect Sorting (Various Artists)

Sometimes people report that tracks are in Various Artists when they should not be, or are sorted into Unknown Album. What separates Various Artists albums and tracks and albums sorted under their artists is the Album Artist tag. When you click Show under Various Artists in the context (right-click) menu, that tag will be emptied if it is filled. The opposite happens to a file in Various Artists when you choose Do not show under Various Artists, but the Album Artist tag will be auto-filled from the Artist tag.

If there is no Album tag, and no Album Artist tag, &amarok; will put the track into Unknown Album in Various Artists. If you want them sorted otherwise, tag them the way you want them sorted. If you don't know some of the information, try out the new MusicBrainz function in the tag editor, or use a tagging application.

##### Duplicate Tracks

Sometimes Amarok pops up following dialog during (perhaps initial) collection scan:

This most probably means that an identical file ended up twice in your collection at different places. You can use Amarok's File Browser to check the files individually, usual action is to remove one of the duplicate files. If you are sure that the tracks are not (or shouldn't be) duplicates, there may be several reasons why &amarok; thinks they are:

1. The files are bit-by-bit identical

   - You can use for example `md5sum` command to verify that

   - You can edit metadata of one of the files from within &amarok; File browser to differentiate them somehow, perhaps by editing (album) artist, year, composer or a comment

2. The files have the same Amarok AFT unique id

   - This is often a result of running amarok_afttagger and then creating multiple copies of a tagged file; tag reader such as Kid3 or MP3Diags can be used to verify this, look for `Amarok 2 AFTv1` string in tags

   - You can use `amarok_afttagger` command-line utility to reset unique id of one of the tracks: `amarok_afttagger --newid --verbose path/to/one/of/the/tracks.mp3`

   - Alternatively, you can remove the unique id from one of the tracks, loosing the track-even-if-changed-from-outside functionality: `amarok_afttagger --delete --verbose path/to/one/of/the/tracks.mp3`

3. (for Amarok before v2.7.0-96-g216c18b) The files have the same MusicBrainz id

   - Released versions up to &amarok; 2.7 treated MusizBrainz id embedded in tags (filled in by MusicBrainz-enabled tagger such as Picard) as unique identifiers of tracks. However, MusicBrainz changed the semantics of the id to mean recording id since it was originally implemented in &amarok;, which means that you may get false duplicates for example for tracks that appear on the original album and the Best of one. See bug #315329 for more info

   - You can use any advanced tag reader to verify this (look for `MusicBrainz` string in tags) and to remove the MusicBrainz id from one of the tracks

   - As an alternative solution, you can use `amarok_afttagger` to add &amarok; AFT id to one of the tracks because &amarok; will then prefer its own id rather than the MusicBrainz one: `amarok_afttagger --newid --verbose path/to/one/of/the/tracks.mp3`

#### Problems playing files

##### Amarok skips over tracks, or appears to play them without sound

If the files you are attempting to play are in mp3 format, please see instructions for enabling mp3 support on your distro, here. Note that one piece of software being able to play mp3s on your system does not necessarily mean &amarok; has had the required codecs installed.

##### No sound, or bad sound

For more general sound issues, first check what Phonon backend you are using in Settings Configure Amarok Playback Configure Phonon Backend. Consider switching to a different backend; VLC and GStreamer backends should be available from your distribution. Both the Gstreamer or VLC backends are recommended, if your distribution is still shipping other backends do not use them.

Also check whether the backend standalone software can play the files correctly; if not this is an issue with that software and you may find information in their help files. In other words, can Gstreamer or VLC play the same file? Will it play in Dragon, which also uses phonon?

If it seems to be a PulseAudio problem, and you want to provide a log to the PulseAudio developers, the troubleshooting page is here.

#### Problems with collections on iPod &etc;

##### Amarok show no cover-images or images are lost when transferring to device

Most likely the wrong version of libgpod4 is installed. On Debian and it's derivatives like Kubuntu the default is libgpod4-nogtk, which comes without support for covers. Simply install the variant libgpod4: `sudo apt-get install libgpod4` The package libgpod4-nogtk can then be removed without problem. From Kubuntu Quantal Quetzal on (released as 12.10) this package has been removed and the default is libgpod4.

#### Crashes and bugs

- How to run &amarok; from the command line: `amarok --debug --nofork`

- &amarok; crashes, but Dr. Konqi doesn't pop up — run in gdb with the following command: `gdb --args amarok --debug --nofork` In gdb's console, type `run` to start &amarok;, reproduce the crash, and then in gdb type `thread apply all bt` to generate the backtrace.

- Filing bugs: If triggered, Dr. Konqi will provide an option to report a bug and do most of the work for you. If not, you will need to submit the bug manually at bugs.kde.org. For crash bugs, paste the backtrace from gdb as a comment.

- How to get personal support with problems: IRC (#amarok on Libera Chat IRC), Discuss, Mailing list

### Frequently Asked Questions

#### What is Amarok?

&amarok; is an audio player. More information can be found in a summary of its features and the screenshot gallery. To get started using &amarok;, see the Quick Start Guide. The &amarok; Handbook is here.

#### What are the differences between Amarok 2 and the previous versions?

&amarok; 2 is a nearly complete code-rewrite so the codebase has little to do with &amarok; 1.4. If you are missing a feature, please file a wish in Bugzilla.

Here you have a short list of some new features:

- Maybe the biggest new feature is the Service Framework, which integrates networked music sources directly into &amarok;. This includes online music stores, media servers, Web music lockers, and more. Thanks to it you'll get easy access to music provided by Magnatune, Jamendo, Last.fm, MP3Tunes Locker, Ampache and many others. Expect more big (and small) names to join during the 2.x lifecycle. See Internet Media Sources for more.

- Another exciting feature is the Context pane, occupying the central place of the &amarok;'s window, replacing the old Context Browser from the 1.x series. It displays contextual information about the music you play, like the album cover, track rating, labels, lyrics, artist information, related songs and artists, guitar and bass tabs and others. Thanks to the Plasma technology it uses, the Context pane can provide very rich content, like AJAX, video and animations, all in an eye-catching fashion. More about the Context pane.

- To accompany the Context pane, we developed a new, space efficient playlist. In order to preserve horizontal space, it groups the track name, artist, album name and cover art together, and allows further grouping by album names. Plus you can rearrange it to your heart's content! If you prefer the old 1.4 playlist, you can have that too. See Changing the Playlist layout for more.

- Another great gem is the video support. Watching your music videos inside &amarok; feels great!

- We can't forget the Dynamic Playlists, which extend the old Dynamic Playlists. They allow you to define an automatically populated playlist, based on specific probability driven criteria called biases. The Dynamic Playlists is joined by the new Automatic Playlist Generator, used to generate lists for specific purposes and of a specified length. See Dynamic Playlists and Automatic Playlist Generator for more information.

There are many more great features like advanced scripting, dynamic collections, usability improvements, improved media devices handling, a new podcast manager, support for more software platforms, and others.

#### Installation

##### Can I use Amarok without KDE?

&amarok; requires parts of KDE to be installed to run, but will run fine in Gnome or other desktop environments, including Windows and OS X. For &amarok; to run, kdelibs and kdebase-runtime need to be installed.

For some features to work correctly, such as the on-screen display, your window manager must be configured to support the relevant freedesktop.org standards. More about running &amarok; on other platforms here.

##### Why does Amarok use KDElibs?

We are committed to supporting &amarok; on all platforms. We use KDElibs and Qt because they provide an excellent development environment. Aside from &Linux; and BSD, &amarok; works on Windows and MacOS, and there are installers available, but unfortunately we don't have (yet) the resources to offer full support for those operating systems. Almost all of our developers use free operating systems, and those have priority for us. We do however welcome Windows and OS X developers willing to help, and improve &amarok; on those platforms.

#### General usage

##### How can I control Amarok from the keyboard?

Keyboard shortcuts are available; see our Keybinding Reference page for more information.

To control &amarok; from the console, type `amarok --help-all` for a current complete list of available control commands.

##### Where can I get support for Amarok?

There are several options. Often times problems you have with the initial install of &amarok; are best answered by experts of your particular &UNIX; or &Linux; distribution. You may seek help from fellow users and developers at the Discuss server under the Amarok category and the Amarok IRC channel at irc.libera.chat channel #amarok.

Note that bugzilla is not a place to seek support. Please do enter a bug if you are serious about helping fix a bug in &amarok; itself.

##### How do I report a bug?

If you find a bug in &amarok;, please submit it to the KDE bugzilla instance. To make a complete bug report, please always include the following information:

- The exact &amarok; version (the version can be found in Help About Amarok). You should not report bugs for &amarok; versions older than the current stable release as we do not provide backport fixes.

- The exact KDE and Qt version, even if you do not run &amarok; in KDE (Help About KDE)

- The exact Phonon backend. You can find this information in the Diagnostics (Help Diagnostics)

- Whether the bug is reproducible. Please do not report bugs that you can not reproduce as these are almost impossible to fix.

- Exact steps how to reproduce the bug

If any of these information is missing the bug report is not complete. Please also be prepared to answer questions from the developers or bug triagers and eventually test other settings.

#### Questions about the Playlist

More about the Playlist here.

##### When I start Amarok, I see an empty playlist. How do I actually get tracks in there?

Use the Media Sources on the left side to navigate to the desired artist/album/track. Then drag the files into the Playlist part on the right. You can use Dynamic Playlists or the Automatic Playlist Generator to populate your playlist. You can also drag files in from any file manager, such as &dolphin;. You may also double-click a track, artist or genre in your Media Sources or file-system, or right-click and Add to Playlist or Replace Playlist.

##### How do I remove tracks from the Playlist?

Select the track(s) you want to remove, and press the Delete key. Or right-click the selection and choose Remove From Playlist.

##### How can I load a playlist?

Just drag and drop the playlist file into the Playlist, like you would do with any other file. It's that simple!

##### How can I save the current playlist?

Click the button in the Playlist toolbar. Slow-click the disc icon to chose to save to your harddisk, or to the database.

#### Playback Questions

##### How do I play audio CDs?

Audio CDs are treated differently than data CDs, which are also supported. When you insert an audio CD, it will be shown as a local collection. Drag to the playlist or Pop-Up Dropper, or right-click the selected tracks and choose Add to Playlist or Replace Playlist.

##### What media types does Amarok support?

&amarok; does not play music by itself, but lets Phonon do that job, specifically the VLC or GStreamer backends of Phonon. Therefore, whatever files they can play, &amarok; can play. To analyse file tags, &amarok; uses Taglib, which supports most file types that contain metadata.

##### What is Phonon? What are Phonon backends?

Phonon is the multimedia framework of KDE 4. You can find more information here.

We currently recommend both the Gstreamer and VLC backend as both are actively maintained. If you want to play streams you should use the VLC backend only as the Gstreamer backend has some shortcomings in this regard. Make sure you do not use any other backend as those are obsolete.

If you are using the Phonon-backend-gstreamer make sure you only use plugins from one single gstreamer version, else your sound will be compromised.

##### Amarok won't play mp3s, what can I do?

You probably lack the codecs required by your particular Phonon backend (Gstreamer, or VLC). Please report this to your distribution if you were not prompted to install them automatically when you started &amarok; for the first time.

##### I have the codecs, but Amarok still won't play mp4s and mkas

When using some phonon backend, like the gstreamer one, &amarok; might refuse to play `mp4` and `mka` files. This is a known problem, see bug #290168 for more technical information.

A very simple workaround is to change the file extension. Change `mp4` extension to `m4a` and for `mka` change it to `mkv`. Of course you must be sure the files contains audio only. You can use the ffprobe command to look at what data streams are present in the file. If the file has a video stream it must be stripped out. There are a lot of tools able to edit these formats and most of them are based on `ffmpeg`/`libav`, which you can use if you are familiar with them. If you prefer graphical tools one possible choice is avidemux.

This is a quick example how you can remove a video stream from an `mp4` video with ffmpeg. Stripping a video stream from an `mkv` file is the same. First check if there is a video stream

``$ ffprobe example.mp4 2>&1 | grep Video``

    Stream #0.1(und): Video: h264 (Baseline), yuv420p, 480x360 [PAR 1:1 DAR 4:3], 242 kb/s, 25 fps, 25 tbr, 25k tbn, 50k tbc

If the output of the previous command is null there is no video stream in the file. To create an `m4a` file with just the audio stream you can use something like

    ffmpeg -i example.mp4 -acodec copy -vn example.m4a

You can also use `avconv` in place of `ffmpeg` with the same options, where

- -i example.mp4 option is the input file name

- -acodec copy is used to not encode again the audio stream but just copy it. This to avoid quality loss, but you can also encode in a different format if you want, and you are not forced to use m4a container in this case

- -vn strips the video stream

- example.m4a is the output file name

Another possible workaround is to change the phonon backend. For example the VLC backend doesn't suffer this problem.

##### I have a second soundcard and I'm using ALSA. How do I make Amarok use it instead of the default?

Configure this in the Phonon system settings module. Settings Configure Amarok Playback Configure Phonon

##### Where's the equalizer?

The equalizer is only available if you are using the phonon-backend-gstreamer. You can find the equalizer in the Tools menu.

##### How can I control the volume in Amarok only without having to change in KMix?

Most distributions ship the PulseAudio sound-daemon nowadays which handles the sound settings system-wide. If you can't change the volume in &amarok; independently of &kmix;, then your PulseAudio settings have the option

`flat-volume=yes`

enabled. Depending on your distribution this is located either in the file `$HOME/.pulse/daemon.conf` or in the system file `/etc/pulse/daemon.conf`. More information about Pulseudio-specific settings can be found in pulse-daemon.conf man page.

##### How do I turn on visualizations?

Visualizations come in the form of an applet. For more information please see the applets page. Visualizations are currently under development and may be buggy at this time.

##### How can I add podcasts?

Go to Podcast section in the Media Sources pane and then select Add Podcast... Add the podcast URL where indicated. More about podcasts here.

We also have some services, such as gpodder and Podcast Directory to help you find great podcasts. Enable services in the Settings menu: Configure Amarok Plugins.

##### How can I use Amarok to stream to my own radio station?

If you want to stream directly to an icecast or shoutcast server the answer simply is: it is not supported. You could use IDJC for that.

#### Collection questions

##### Folder not properly picked up

If you find that most of your music is recognized by &amarok;, but some folders are not properly picked up, open a console and type

`touch folder`

where folder is the path to the folder that has the problem. Then select Settings Configure Amarok in &amarok; main window menu, open Collection page and click the Full Rescan button. Your folder should be visible again now.

this will not work on Windows, as the touch command is specific to &Linux; and BSD-like systems.

##### Can I use removable media inside Amarok?

&amarok; has a greatly improved support for the media devices based on Solid, the KDE hardware layer, that doesn't need a lot of configuration. You should be able to just plug in your device and access it within &amarok;. Also, thanks to the Dynamic Collections, your media devices could become part of your music collection, and be searchable and accessible within the Local Music section of the Media Sources pane when it's connected.

You can transfer your songs, albums and artists from your local collection by right-clicking, selecting Copy to Collection and picking your device; and you can also do it in the other way: right-click and select Copy to Collection Local Collection. More about &amarok; and devices here.

##### Can I use the old Amarok's collection in Amarok 2? Will my tags, score are ratings be lost?

A database importer is available. You will be able to keep your ratings and statistics just fine. More here.

#### General questions

##### What are scripts?

They are little pieces of software that add some functions to &amarok;. There are a lot of scripts, and you can find them in kde-apps.org or you can find and install them inside &amarok; using the Script Manager. More details can be found here. You will find the Script Manager from the Settings menu, Configure Amarok Scripts.

##### Can I use Amarok 1.4 scripts in Amarok 2?

No. A new and powerful scripting API has been created, which provides huge improvements but won't let you use your old scripts. The new scripting system is based on QtScript and will significantly reduce &amarok;'s dependencies, a huge problem for non-technical and cross-platform users, and will greatly reduce the amount of external processes launched at runtime. Another advantage is that the new API will allow much deeper integration with &amarok; than the old scripting system. Amarok Scripting API.

##### What are Moodbars?

Moodbars show the mood of a song in the progress bar. More about Moodbar here.

##### Can I play video files?

&amarok; is mainly a music player so no video file management, collection support, DVD playback, subtitles, or any other sophisticated features are available.

##### Is it Amarok, AmaroK or amaroK?

It is &amarok;! The former spelling was amaroK, but it was changed due to its strange look around 2005.

##### How are track scores determined?

&amarok; assigns a score (a number 0-100) to a song based on how many times you've listened to it and whether you skip the song without it finishing. Every time the song finishes playing, the score is changed.

Here you have an example script that can calculate scores:

    if( playcount <= 0 ) # not supposed to be less, but what the hell.
           newscore = ( prevscore + percentage ) / 2
       else
           newscore = ( ( prevscore * playcount ) + percentage ) / ( playcount + 1 )
       end

You can easily create your own script with your own algorithm. Look at the Script-Writing-Howto for further information.

##### How do I manually change a track's score?

You may change the score manually in the Track Details dialog, available by right-clicking on a track, choosing Edit Track Details and going to the Summary tab.

##### But I also want that stars system like in other players!

&amarok;, of course, supports a user-defined rating system, and you can rate your tracks with a single click using the Current Track applet. You can also do this in the context menu (right-click) Edit Track Details Summary tab. If you have the rating stars displayed in your playlist layout, you can also edit there, with the slow double-click.

##### Can I drag and drop Plasma applets from the main window to the Desktop?

No, but there are several Plasmoids available for your Desktop, which will let you display information provided by &amarok; as well as control &amarok;.

##### How can I save a stream?

First of all, load the stream into the playlist. There are several ways to do this: downloading the file and opening it with &amarok;; using the menu Playlist Add stream; among others.

Once the stream is loaded, you can save it by clicking on in the Playlist pane, and giving it a meaningful name. The Stream will then be added to the Saved Playlists view for later reference.

##### Where do I find the settings for Amarok?

``kde4-config --localprefix`/share/apps/amarok`

``kde4-config --localprefix`/share/config/amarokrc`

#### Troubleshooting

##### How can I obtain a backtrace?

If &amarok; has crashed and you want to report it, visit the Debugging HowTo. The bug report must be made in bugs.kde.org after verifying if it has not already been reported.

##### Amarok just freezes! How can I help get this fixed?

You can obtain a backtrace of a frozen instance of &amarok; using gdb like so:

`$ gdb -p `pidof amarok` (gdb) thread apply full bt all`

Then just post the backtrace to PasteBin, as described in the Debugging HowTo.

##### Amarok takes a lot of time to start

If this happens you have to check what scripts you have installed and what internet services are running, because some of them may slow down the startup. Also, if you have streams in the playlist when you open &amarok;, the startup can take a little longer. The same happens if you have a great number of tracks in the playlist (over 300 and more).

On the other hand, if you don't use KDE, but a different desktop environment, startup time can be increased very slightly because there are more libraries to be loaded.

#### Development questions

##### How do I get a GIT version of Amarok?

See the Amarok Development build instruction page. Check here for a local build: Building from Git Locally: Full Summary

##### Why isn't Amarok part of KDE Multimedia?

Packages in the KDE Software Compilation proper have a release schedule that doesn't fit with &amarok;'s development pace, and since none of the other KDE applications depend on &amarok; there is no need to follow this release schedule.

##### I've found a bug / I've got a great idea for Amarok!

Please report it at bugs.kde.org. If you have a list of suggestions or wishes it may be best to send them to our mailing list: amarok@kde.org. Simply posting the idea to our IRC channels or on an obscure wiki page or blog won't help much as the information will get lost.

##### Do you accept patches?

Happily! Your best course of action is to let us know what you plan to do before you do any work so we can discuss it, but don't fret; we haven't turned down a patch yet! Discussion is mostly to help you patch the correct bits of &amarok;. Submit your patches and code contributions to git.reviewboard.kde.org. See also How to Submit Patches to &amarok;. If you have a bug fix then just go ahead; this is open source after all.

##### Why did you choose the name Amarok?

Amarok is an album by British composer Mike Oldfield. Project founder Mark Kretschmann happens to like it a lot, and he thought the name had a nice sound. Plus, of course, it contains the all important K.

## References

- Menu and Command Reference

  - Amarok Menu

  - View Menu

  - Playlist Menu

  - Tools Menu

  - Settings Menu

  - Help Menu

- Keybinding Reference

  - Global Shortcuts

  - Amarok Shortcuts

- Credits and License

### Menu and Command Reference

#### Amarok Top-level Menus

Menu | Description
--- | ---
&amarok; | Common actions such as Play, Pause, &etc;
View | Change the layout of Amarok
Playlist | Configure your Playlist
Tools | Start additional tools and scripts
Settings | Change settings and configure Amarok
Help | Important information about Amarok and KDE

#### Amarok Menu

Some of the common actions in &amarok; are here, mostly to control media playback.

#### Contents

The Amarok Menu

The Amarok Menu

Menu Item | Description | Shortcut
--- | --- | ---
Play Media... | Opens a media file to be played. | &Ctrl;O
Previous Track | Skips back to the last track played within your current session. |
Play/Pause | Starts or temporarily stops the playing of the current media file. | Space
Stop | Stops all playback in progress. |
Stop after current Track | Waits until the current track ends before stopping the playback. This is useful when using a playlist. |
Next Track | Skips playback to the next media file in your playlist.
Quit | Exits out of &amarok;. | &Ctrl;Q

### View Menu

This top-level menu contains options to adjust the layout of &amarok;, and a checkbox to lock the configuration; use this to prevent any accidental changes to the &amarok; window layout.

View Menu

View Menu

#### Changing the Amarok Toolbar

There are also two radio buttons in this menu, which are used to choose which Toolbar &amarok; will use. The Main Toolbar has a larger height and slightly different controls than the Slim Toolbar. The Main Toolbar contains two main control buttons: a Play / Pause button and a button for controlling the volume. It also displays the name of the current media file and a slider for showing, as well as changing, the position of playback. More about the Toolbar.

The Main Toolbar

The Main Toolbar

The Slim Toolbar

The Slim Toolbar

#### Amarok Window Layouts

If the Lock Layout button is unchecked, the Media Sources, Context and Playlist tabs can be toggled and many layouts can be created as shown below:

#### Playlist Menu

This is a top-level drop down menu where can configure your Playlist. From here you can add more tracks, streaming radio channels, and clean your playlist.

##### Menu Items

The Amarok Playlist Menu

The Amarok Playlist Menu

Menu Item | Description | Shortcut
--- | --- | ---
Add Media... | Opens a media file to be played in &amarok;
Add Stream... | Choose different streaming radio channels using the URL bar, by pasting or typing the link
Export Playlist As... | Save your favorite playlists in various formats - mp3 streaming, Shoutcast, xspf
Undo | Go one step backward | &Ctrl;Z
Redo | Click Redo to do the last step over again | &Ctrl;&Shift;Z
Clear PlayList | Cleans the current playlist
Remove Duplicates | Removes duplicate entries in the playlist
Playlist Layouts | Changes the visual style of the Playlist
Edit Queue | Allows you to change the order of your queue

##### Playlist Layouts

From Playlist Playlist Layouts switch between different layouts with radio buttons, and configure your personal Playlist layout.

###### Default

Playlist Playlist Layouts Default

###### No Grouping

Playlist Playlist Layouts No Grouping

###### No Grouping (Single line)

Playlist Playlist Layouts No Grouping(Single line)

###### Verbose

Playlist Playlist Layouts Verbose

###### Configure playlist layout...

Playlist Playlist Layouts Configure playlist layout...

This option allows you to make your own Playlist layout; display Artist, Genre, Year, BPM and so forth.

Make your own layout

Make your own layout

#### Tools Menu

From this menu you can use additional tools and scripts.

The Tools Menu

The Tools Menu

Menu Item | Description
--- | ---
Bookmark Manager | Allows you to save bookmarks of various types.
Cover Manager | Allows you to view album covers and fetch missing ones.
Equalizer | Shows the equalizer.
Network Request Viewer | Shows the Network Requests Viewer.
Update Collection | Checks the tracks in your collection and updates the database.
Synchronize Statistics.. | Opens the Statistics Synchronization dialog.

##### Bookmark Manager

The bookmark manager allows you to bookmark different kinds of things to recall them later. You can also create folders to organize your collection of bookmarks. The search box provides a convenient way to find bookmarks. The context menu offers the possibility to Load and Delete the bookmark.

Menu Item | Description
--- | ---
Bookmark Context View Applets | Saves the currently used view applets.
Bookmark Media Source View | Saves the current view of the media source tree.
Bookmark Playlist Setup | Saves the current playlist setup.
Bookmark Track Position | Saves the position in the current track.

##### Cover Manager

Shows all albums in your collection. Here you can set custom album covers and fetch missing ones. More about the Cover Manager, shown below.

##### Equalizer

Provides the possibility to configure sound settings. You can choose between manually adjusting the settings and using templates. Right now, the Phonon GStreamer is required for a functional equalizer.

##### Network Requests Viewer

The Network Requests Viewer allows you to monitor the network requests made by &amarok;. Selecting this option will open this window:

##### Update Collection

Checks the files in the folders you defined as your collection. New files will be added and missing ones removed from the left pane.

##### Synchronize Statistics

This option allows you to synchronize statistics of your various collections. This is a new feature in &amarok; since version 2.7 For more information, see also Statistics Synchronization Between Collections and with Last.fm in the handbook.

#### Settings Menu

Here is where you change settings and configure &amarok;.

The Amarok Settings Menu

The Amarok Settings Menu

Menu Item | Description
--- | ---
Show Menubar | Hide the menu bar. Show it again by pressing &Ctrl;M
Replay Gain Mode | Allows you to set the Replay Gain mode; Off, by Track, or by Album
Configure Shortcuts... | Allows you to make custom keyboard shortcuts
Configure Amarok... | Configure General options, Internet Services, Playback, Notifications, and Database

##### Show Menubar

Clicking this option will hide the menu bar.

The only way to show the menu bar again is by pressing &Ctrl;M, because you can't de-select the menu option when no menu bar is shown. More about the Menus in the Menubar.

##### Replay Gain Mode

The replay gain mode will change the volume depending on meta information of the track. More about replay gain: Wikipedia entry for replay gain.

You can switch the replay gain mechanism off, use a track-based or the album-based replay gain.

##### Configure Shortcuts...

Change and define new keyboard shortcuts, or turn on multimedia keys if your keyboard has them. More about Shortcuts.

##### Configure Amarok...

Configure Amarok

Configure Amarok

Configure many aspects of &amarok;. Details in Configuring Amarok.

#### Help Menu

Important information about &amarok; and KDE.

The Amarok help menu

The Amarok help menu

Menu Item | Description
--- | ---
Report Bug... | Report bugs to the bug tracker directly, with much of your information automatically supplied to the database form.
Amarok Handbook | This Handbook in Docbook format.
Send a Comment to the Developers | Send a brief comment to &amarok; developers. Do NOT use to send bug reports.
Show Feedback Icons | Check to show feedback icons on every &amarok; screen and sub-menu.
Switch Application Language... | Change &amarok; menus and label language or back-up language.
About Amarok | &amarok; version, web site, contributors and donors.
Diagnostics | Displays complete information necessary for filing good bug reports, such as Amarok Version, KDE, Qt, Phonon, and Phonon Backend versions, and whether or not PulseAudio is installed, as well as what Amarok Scripts are installed, and whether or not they are running. There is a button on the bottom to copy the information to the clipboard.
About KDE | Information about KDE, and links to join and support KDE.

## Keybinding Reference

### Keyboard Shortcuts

Keyboard shortcuts let you quickly access &amarok;`'s` power. Change the shortcuts using Settings Configure Shortcuts....

Shortcuts are divided into two groups:

- Global Shortcuts

- Amarok Shortcuts

### Control from Console

To control &amarok; from the console, type `amarok --help-all` for a current complete list of available commands.

#### KDE Global Shortcuts

Global Shortcuts are KDE's control key combinations. Use them to control &amarok; from the keyboard as an alternative to using the mouse.

##### Default Global Shortcuts

Action | Default Global Shortcut
--- | ---
Add Media... | Meta A
Decrease Volume | Meta-
Increase Volume | Meta+
Last.fm: Love Current Track | Meta L
Last.fm: Skip Current Track | Meta S
Mute Volume | Meta M
Next Track | Media Next
Play/Pause | Media Play
Stop | Media Stop
Previous Track | Media Previous
Rate Current Track: 1 star | Meta 1
Rate Current Track: 2 stars | Meta 2
Rate Current Track: 3 stars | Meta 3
Rate Current Track: 4 stars | Meta 4
Rate Current Track: 5 stars | Meta 5
Seek Backward | Meta&Shift;-
Seek Forward | Meta&Shift;+
Show Notification Popup | Meta O
Toggle Main Window | Meta P

#### Amarok Shortcuts

Control &amarok; using keyboard shortcuts, which are combinations of keys which each control a specific action. &amarok; has default shortcuts, but you can also make your own.

##### Default Shortcuts

Action | Shortcut
--- | ---
Increase Volume | +
Decrease Volume | -
Edit Details of Currently Selected Track | &Ctrl;E
Search in Playlist | &Ctrl;J
Shuffle Playlist | &Ctrl;H
Play Media... | &Ctrl;O
Play/Pause | Space
Previous Browser | &Backspace;
Copy the Currently Playing Artist and Title to the Clipboard | &Ctrl;C
Queue Track | &Ctrl;D
Quit | &Ctrl;Q
Redo | &Ctrl;&Shift;Z
Seek Forward By 2 seconds* | &Ctrl;Right
Seek Forward By 10 seconds* | Right
Seek Forward By 60 seconds* | &Shift;Right
Seek Backward By 2 seconds* | &Ctrl;Left
Seek Backward By 10 seconds* | Left
Seek Backward by 60 seconds* | &Shift;Left
Activate Search Bar | &Ctrl;F
Toggle Full Screen | &Ctrl;&Shift;F
Undo | &Ctrl;Z
Save Playlist | &Ctrl;S
Select all | &Ctrl;A
Rename | F2

- These durations are configurable in the `amarokrc`.

##### How to make shortcuts

You can configure shortcuts from Settings Configure Shortcuts... where you can change or make new shortcuts.

#### How to use Configure Shortcuts...

Button | Description
--- | ---
Search | Search Actions and Shortcuts.
Details | Add, remove and get more information about shortcut schemes.
Reset to Defaults | Reset all custom shortcuts back to default.
Print | Print the list of shortcuts.
OK | Save all changes.
Cancel | Close window without saving changes.

When you select an action, that opens a sub-window where you can choose between two radio buttons, Default and Custom. If you choose Default you'll use the default shortcut. If you choose Custom you'll configure and use your shortcut for this action.

## Credits and License

### Program copyright

Copyright 2002, 2003 Mark Kretschmann (kretschmann kde.org).

Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The Amarok Development Squad

### Documentation copyright

Please add your name here if you contribute to the handbook. Please respect alphabetical order

Abhishek Rane (abhishektux gmail.com)

Adrián Chaves Fernández (adriyetichaves gmail.com)

Caleb Bryant (c.bryant.30 gmail.com)

Daniel Marth (danielmarth gmx.at)

Dima Panov (fluffy freebsd.org)

Dion Moult ()

Emilio Castro González (periliocastrol gmail.com)

eqisow ()

Geoffry Song (goffrie gmail.com)

Jeff Mitchell (mitchell kde.org)

José Antonio Rey (joseeantonior ubuntu.com)

Lydia Pintscher (lydia kde.org)

Mayank Madan (mayankmadan live.com)

Myriam Schweingruber (myriam kde.org)

Nick Adams (runey676 gmail.com)

Paul Ivan (bit.alex001 gmail.com)

Pedro Raimundo (pedrooraimundo gmail.com)

Pete Daniels (pete guerrillatechsupport.com), screenshots

Salma Sultana (salma4534 yahoo.com)

Sash Karttunen (sasu.karttunen tpnet.fi)

tris r ()

Valorie Zimmerman (valorie.zimmerman gmail.com)

Walter P. Little (walterplittle gmail.com)

Willem Ferguson (willemferguson zoology.up.ac.za)

### Licenses

This documentation is licensed under the terms of the GNU Free Documentation License.

This program is licensed under the terms of the GNU General Public License.

&underFDL;
&documentation.index;