View source for Amarok/Manual/ConfiguringAmarok/en

<languages />

== Configuring Amarok ==

On first start, some basic configuration is done; see also [[Special:myLanguage/Amarok/QuickStartGuide/GettingStarted|Quick Start Guide: Getting Started]]. But there is more under the hood.

To access the ''Configuration Menu'', go to <menuchoice>Settings -> Configure Amarok...</menuchoice> and see the following dialog:

[[File:AmarokConfigurationDialogGeneral2.7.png|thumb|center|300px]]

=== General ===

In the screenshot above, see some ''General Options'' you can set. Depending on the distribution, the default settings can vary; sometimes the ''Splash Screen'' is disabled for example. When hovering over the options with the mouse pointer, a tooltip will show to explain the individual settings.

General options:

<!--}-->{| border="1" cellpadding="5"
! Option !! Tooltip
|-
| <menuchoice>Show splash-screen on startup</menuchoice> || Check to enable the splash screen on '''Amarok''' startup.
|-
| <menuchoice>Show tray icon</menuchoice> || Check to enable the '''Amarok''' system tray icon.
|-
| <menuchoice>Automatically retrieve cover art</menuchoice> || Check to enable the automatic retrieval of cover art from the internet.
|-
| <menuchoice>Enable context applets collapse animations</menuchoice> || Check to enable animations when context applets collapse.
|-
| <menuchoice>Automatically scroll playlist to current track</menuchoice> || Check to make the playlist scroll so the current track is always visible.
|-
| <menuchoice>Show Moodbar in progress slider</menuchoice> || The ''Moodbar'' makes it possible to navigate in your music visually. Please note that this feature requires the [[Special:myLanguage/Amarok/Manual/Various/Moodbar|external Moodbar Generator tool]], or a script.
|-
| <menuchoice>Moodbar style</menuchoice> || 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: [[Special:myLanguage/Amarok/Manual/Various/Moodbar|Moodbar]].
<span id="Collection"></span>
=== Local Collection ===

[[File:AmarokConfigurationDialogLocalCollection2.7.png|thumb|300px|center]]

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:

<!--}-->{| border="1" cellpadding="5"
! Option !! Tooltip
|-
| <menuchoice>Fully Rescan Entire Collection</menuchoice> || Rescan your entire collection. This will ''not'' delete any statistics.
|-
| <menuchoice>Import</menuchoice> || Imports ratings and/or statistics from older '''Amarok''' versions, the batch scanner, or media players.
|-
| <menuchoice>Scan folders recursively (requires full rescan if newly checked)</menuchoice> || If selected, '''Amarok''' will read all subfolders.
|-
| <menuchoice>Watch folders for changes</menuchoice> || If selected, the collection folders will be watched for changes. The watcher will not notice changes behind symbolic links.
|-

| <menuchoice>Importing Music: Transcode tracks</menuchoice> || Whether '''Amarok''' should transcode tracks when they are copied or moved to ''Local Collection''.
|}<!--{-->
<span id="Import Statistics"></span>
==== Import Statistics ====

This option allows you to import statistics, e.g. 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 ===

[[File:MetadataDialog.png|thumb|350px|center]]

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

Metadata options:

{| border="1" cellpadding="5"
! Option !! Tooltip
|-
| <menuchoice>Write statistics to file</menuchoice> || Check to write play-changing statistics as tags back to the audio files.
|-
| <menuchoice>Write covers to file, maximum size...</menuchoice> || 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.
|-
| <menuchoice>Enable character set detection in ID3 tags</menuchoice> || 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 [[Amarok/Manual/Organization/Collection/SynchronizeCollectionLast.FM|keep statistics of your collections synchronized]]. Make sure to only check collections between which you want to synchronize metadata.

Statistics Synchronization options:

{| border="1" cellpadding="5"
! Option !! Tooltip
|-
| <menuchoice>Synchronize Rating</menuchoice> || Check to synchronize ratings between collections.
|-
| <menuchoice>Synchronize First Played</menuchoice> || Check to synchronize first played dates between collections.
|-
| <menuchoice>Synchronize Last Played</menuchoice> || Check to synchronize last played dates between collections.
|-
| <menuchoice>Synchronize Playcount</menuchoice> || Check to synchronize playcounts between collections.
|-
| <menuchoice>Synchronize Labels</menuchoice> || Check to synchronize labels between collections.
|}

=== Playback ===

[[File:AmarokConfigurationDialog2.7Playback.png|thumb|300px|center]]

Configure the playback options, as well as the KDE multimedia framework '''Phonon'''.

<!--}-->{| border="1" cellpadding="5"
! Option !! Tooltip
|-
| <menuchoice>Fadeout on stop</menuchoice> || 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.
|-
| <menuchoice>Fadeout duration</menuchoice> || The length of the fadeout, in milliseconds.
|-
| <menuchoice>Resume playback on start</menuchoice> || 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 =====

[[File:AmarokConfigurationDialog2.7PhononDevice.png|thumb|300px|center]]

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 <menuchoice>Test</menuchoice> 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 =====

[[File:AmarokConfigurationDialog2.7PhononHardware.png|thumb|300px|center]]

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

===== Backend tab =====

[[File:AmarokConfigurationDialog2.7PhononBackend.png|thumb|250px|center]]

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. 

<span id="Notifications"></span>
=== Notifications ===

 [[File:AmarokConfigurationDialog2.7Notifications.png|thumb|center|300px]]
<br />,<br />
<!--}-->{| border="1" 
! Option !! Tooltip
|-
| <menuchoice>Use On-Screen Display</menuchoice> || 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.
|-
| <menuchoice>Duration</menuchoice> || The time in milliseconds for which to show the OSD. The value must be between 500 ms and 10000 ms.
|-
| <menuchoice>Screen</menuchoice> || Allows you to choose the screen that should display the OSD if you have a multiscreen setup. Default is 0.
|-
| <menuchoice>Translucent</menuchoice> || Check to enable translucency if supported by your desktop system.
|-
| <menuchoice>Font scale</menuchoice> || (choose the size of the font in the OSD)
|-
| <menuchoice>Don't show when a fullscreen application is active</menuchoice> || Do not show On-Screen Display if another application is focused and running in fullscreen mode.
|-
| <menuchoice>Use custom colors</menuchoice> || Check to enable custom colors for the ''On-Screen Display'' text.
|-
| <menuchoice>Text color</menuchoice> || Click to select the color of the ''OSD'' text.
|-
| <menuchoice>Use system notifications</menuchoice> || Check to use the system notification. This can vary depending on your desktop system and/or distribution.
|}<!--{-->
<span id="Database"></span>
=== Database ===

[[File:AmarokConfigurationDialog2.7Database.png|thumb|300px|center]]

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.
<br /><br />
'''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.
<br /><br />
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. 

<!--}-->{| border="1" cellpadding="5"
! Option !! Tooltip
|-
| <menuchoice>Use external MySQL Database</menuchoice> || Check to enable the use of an external database.
|-
| <menuchoice>Server</menuchoice> || Enter the name of the existing '''MySQL''' server.
|-
| <menuchoice>Port</menuchoice> || Enter the port number to access the server. Default is port 3306.
|-
| <menuchoice>Username</menuchoice> || Enter the username to access the database with full access privileges.
|-
| <menuchoice>Password</menuchoice> || Enter the password for the default user.
|-
| <menuchoice>Database</menuchoice> || Enter the name of the database. Default preset is amarokdb.
|}<!--{-->

You can find more information about the External Database [[Special:myLanguage/Amarok/Manual/Organization/Collection/ExternalDatabase|here]].
<span id="Plugins (formerly Internet Services)"></span>
=== Plugins ===

[[File:Amarok2.7SettingsPlugins.png|thumb|center|300px|(Click to enlarge)]]

Plugins configuration controls <menuchoice>Collections</menuchoice>, <menuchoice>Internet Services</menuchoice>, and <menuchoice>Local Collection Backends</menuchoice>.

==== Collections ====

'''Amarok''' offers you access to the following Collections, if they are available:

<!--}-->{| border="1" cellpadding="5"
! Collection !! Description
|-
| <menuchoice>AudioCD Collection</menuchoice> || AudioCD collection plugin for '''Amarok'''
|-
| <menuchoice>DAAP Collection</menuchoice> || DAAP collection plugin for '''Amarok'''
|-
| <menuchoice>iPod, iPad & iPhone Collection</menuchoice> || Plugin to use iPod-like devices as collections in '''Amarok'''
|-
| <menuchoice>MTP Collection</menuchoice> || MTP collection plugin for '''Amarok'''
|-
| <menuchoice>Universal Mass Storage Collection</menuchoice> || UMS/USB collection plugin for '''Amarok'''
|-
| <menuchoice>UPnP Collection</menuchoice> || UPnP collection plugin for '''Amarok'''
|}<!--{-->

==== Internet Services ====

'''Amarok''' offers by default the following Internet services:

<!--}-->{| border="1" cellpadding="4"
! Service !! Description !! Needs configuration {{Configure}}
|-
| <menuchoice>Ampache</menuchoice> || Use an external music server  || Yes, '''Ampache''' server needed
|-
| <menuchoice>gpodder.net</menuchoice> || Podcast service. See also [http://www.gpodder.net gpodder.net] || No
|-
| <menuchoice>Jamendo</menuchoice> || Listen to free music published under Creative Common licenses. See also [http://www.jamendo.com/en/about Jamendo.com] || No
|-
| <menuchoice>Last.fm</menuchoice> || A popular internet radio service, streaming only for subscribers. See also [http://www.last.fm/about Last.fm] || Yes, personal information to [[Special:myLanguage/Amarok/QuickStartGuide/Glossary#Scrobble|scrobble]]
|-
| <menuchoice>Magnatune Store</menuchoice> || Preview and buy music from a non-evil record label. See also [http://magnatune.com/info/whynotevil Magnatunes.com] || Only for downloads
|-
| <menuchoice>MP3 Music Store</menuchoice> || Access the Amazon MP3 Store directly from Amarok || Yes
|-
| <menuchoice>mp3tunes</menuchoice> || A personal mp3 locker. See also [http://www.mp3tunes.com/cb/about/ mp3tunes.com] || Yes
|-
| <menuchoice>Podcast Directory</menuchoice> || Browse and subscribe to a huge choice of podcasts || No
|}<!--{-->
<br />

Other service are available through scripts.

==== Local Collection Backends ====

'''Amarok''' offers you access to the following Local Collection Backends, if they are available:

<!--}-->{| border="1" cellpadding="5"
! Devices !! Description
|-
| <menuchoice>Local Files & USB Mass Storage Backend</menuchoice> || Local Collection folders on local and pluggable disks
|-
| <menuchoice>NFS Share Backend</menuchoice> || Local Collection folders on remote NFS shares (Network File System)
|-
| <menuchoice>SMB (Windows) Share Backend</menuchoice> || Local Collection folders on remote Samba (Windows) shares
|}<!--{-->

==== Ampache configuration ====

If you have access to a remote '''Ampache''' music server, click {{Configure}} and enter the necessary information. You can configure access to more than one '''Ampache''' server. For more information see the [[Special:myLanguage/Amarok/Manual/Organization/Collection/RemoteCollections/Ampache|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 {{Configure}}. '''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 {{Configure}} 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 {{Configure}} and enter your username and password. You will then be able to access your online locker.
<span id="Scripts"></span>
=== Scripts ===

[[File:Amarok2.6ScriptsConfigMenu.png|center|thumb|300px|Scripts configuration dialog (click to enlarge)]]

Script Configuration in '''Amarok''' covers <menuchoice>Generic</menuchoice>, <menuchoice>Lyrics</menuchoice>, and <menuchoice>Scriptable Service</menuchoice> scripts. Scripts are added in the <menuchoice>Manage Scripts</menuchoice> 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:

*<menuchoice>Automatically update built-in scripts</menuchoice> 
: 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.

*<menuchoice>Manage Scripts</menuchoice> button
: Browse, install and uninstall user-supplied scripts; also search, sort and rate the scripts in the ''Amarok Add-on Installer''.

===== Add-on Installer =====

[[File:Amarok_add-on_installer.png|300px|thumb|center|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 <menuchoice>Install Scripts</menuchoice> and <menuchoice>Uninstall</menuchoice> 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 {{Icon|dialog-information}} 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 {{Icon|dialog-ok}} OK or the {{Icon|dialog-ok-apply}} Apply button. To deactivate the Script Console deselect it and confirm again.
[[File:AmarokConfigurationDialog2.7ScriptConsole.png|300px|large|center]]

{{Prevnext2
| prevpage=Special:myLanguage/Amarok/Manual/AmarokWindow | nextpage=Special:myLanguage/Amarok/Manual/ConfiguringAmarok/ChangingLayout
| prevtext=Amarok Window | nexttext=Changing Layout
| index=Special:myLanguage/Amarok/Manual | indextext=Back to Menu
}}

[[Category:Amarok2.7]]
[[Category:Multimedia]]
[[Category:Tutorials]]