Official Kodi Wiki - User contributions [en]

Add-on:Audio Profiles

2021-04-12T16:06:50Z

Pkscout: /* Saving Profiles */

{{Addon
|Name=Audio Profiles
|provider-name=pkscout, notoco, Regss
|ID=script.audio.profiles
|latest-version=2.1.0+matrix.1
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them.
|Description=Save audio profile and easily switch between them.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353852
|Website=https://kodi.wiki/view/Add-on:Audio_Profiles
|Source=https://github.com/pkscout/script.audio.profiles
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/matrix/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to ten different profiles (four for versions before 2.x) that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to automatically select a profile based on media playing
* option to auto switch based on codec kind and channel count (for videos only)
* option to load a profile when Kodi starts
* popup menu has skin specific look and feel for Ace2, Aeon MQ8, Aeon Nox Silvo, Aeon Tajo, Amber, AppTV, Aura, Arctic Horizon, Arctic Zephyr2Bello 7, Box, Confluence, Embuary, Eminence, Estuary, fTV, Pellucid, Quartz, Rapier, Revolve, Transparency, Unity, and Xperience1080

== How to use this addon ==

=== Configuration ===
By default two of the ten available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to ten profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 

'''Profiles 5 - 10:''' (default False) 
Toggle this option to individually turn profiles 5 - 10 on or off. Profiles 5 - 10 are off by default. 
''Name of Profiles 5 - 10:'' (default Profile X) 
The name for profiles 5 - 10 (shown in the popup menus and notifications) 

=== HDMI-CEC ===
'''Profile X''' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when the specified profile is activated (Toggle State, Standby, or Wakeup)

=== Auto Switch ===
All the settings in this section allow you to decide what to do if a particular type of media is detected. All settings have the following options: '''None''', '''Profile 1 - 10''', and '''Select menu'''. If you select a profile, that profile will be activated automatically. If you pick '''Select Menu''' the select menu will pop up for that media type. The music media type also has an option to assign any stream with no codec details the profile used for music.

=== Codec Detection ===
All the settings in this section allow you to decide what to do if a particular type of codec or number of channels are detected. All settings have the following options: '''None''', '''Profile 1 - 10''', and '''Select menu'''. If you select a profile, that profile will be activated automatically. If you pick '''Select Menu''' the select menu will pop up for that media type. There is one additional setting:

'''delay before reading codec information''' (default 5) 
The number of seconds the addon waits before asking Kodi for the codec information. Especially with streams, it can take a little time for Kodi to have the information needed.

=== Extras ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use.

'''Profile for Kodi Startup/Wake''' (default None) 
The profile to load when Kodi starts. 
''Force load profile at startup'' (default False) 
If True, the profile loads at startup even if it was selected at shutdown. Useful for resetting the volume level.

'''Use custom select menu''' (default True) 
If True, the addon will attempt to use a skin specific menu (if available). 
''Include skin mods'' (default True) 
If True, the addon will treat skin mods as if they are the original skin and show the custom menu. So, for instance, skin.estuary and skin.estuary.mod would both use the custom menu for Estuary.

'''Auto close select menu''' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
If True, the notifications enabled below will be displayed. 
''Delay before close'' (default 5) 
The number of seconds the notification will show.
''Auto switch notifications'' (default True) 
If True, notifications each time a profile is automatically changed will be shown. 
''Manual switch notifications'' (default True) 
If True, notifications each time a profile is changed via the select menu will be shown. 
''Maintenance notifications'' (default True) 
If True, notifications about saving profiles will be shown. 

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Harmony Hub Controller

2021-03-12T22:54:11Z

Pkscout: /* General */

{{Addon
|Name=Harmony Hub Controller
|provider-name=pkscout
|ID=script.harmony.control
|latest-version=0.2.0+matrix.1
|extension point=xbmc.python.script
|provides=executable
|Summary=Addon to send activity and remote commands via a Harmony Hub.
|Description=Harmony Hub Controller let's you setup actions to run a Harmony activity and/or a sequence of remote commands. Running the addon gives you a menu of your actions, and you can also send an action name as an arg to have the script run a specific action.
|Platform=all
|Language=
|License=GPL-2.0-only
|Forum=
|Website=
|Source=https://github.com/pkscout/script.harmony.control
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/matrix/script.harmony.control/icon.png}}

== Features ==
* Allows you to send commands to a Harmony Hub (either just activities or, with advanced settings, individual remote commands)

== How to use this addon ==
=== Basic ===
Once installed, you need to go to the add-on settings, input the IP address, and then use the ''Edit mappings'' option in the settings to create a mapping of Harmony Hub Controller menu item to a Harmony Hub Activity. When you type in the name of activity, use the exact name you gave it on the Harmony Hub. Save the settings, then run the Add-on. A menu will appear with the mapping(s) you made. Select one, and the script will run that Activity on the Hub.

=== Advanced ===
There is an option in the settings for advanced control of the Harmony Hub. If you enable that, you can send remote commands (either just one or a string of them) in addition to the activity. When enabled, there is an additional screen in the ''Edit mappings'' process to add additional commands. The general syntax for commands is:

<syntaxhighlight lang=text>
<command>|<command>|command
</syntaxhighlight>

Where command is one of the remote button commands, and the pipe (|) is a pause. You can add a longer pause by adding pipes with no command between them. The one trick here is that you have to know the exact name of the command the Hub uses. To help a little, the script logs all the commands the Hub knows to the Kodi logfile when debug logging is on. So to get a list of all commands the hub knows, enable Kodi debug logging, then also enable debug logging in the Harmony Hub Controller Add-on, and then run one of the activities you already defined. Then go to the kodi.log file and look for some lines that look like this:

<syntaxhighlight lang=text>
2021-03-12 11:49:47.649 T:1906540 DEBUG <general>: [Harmony Hub Control] the complete list of commands by device is:
</syntaxhighlight>

Right below that will be a line that is the dump of all the commands. My apologies that it's a bit hard to read, but it should get you what you need.

== Settings ==
=== General ===
''Harmony Hub IP Address'' 
The IP address of your Harmony Hub.

''Delay Between Remote Commands:'' 
The amount of delay added between commands when you add a pipe character (|). Adding pipes back to back increase the delay. So, for instance, to get a 1 second delay, you would use ||||.

''Timeout'' 
The amount of time before the script gives up trying to contact the Hub.

''Enable Advanced Harmony Hub Control'' 
Enabling this setting let's you send individual commands to the Hub rather than just activities. See the ''Advanced Usage'' section for more information on this.

''Use Custom Select Menu'' 
This script can use either a standard dialog box or one customized to match the skin you are using. If you're skin isn't supported, you will get a kind of generic "custom" menu. Setting the additional option for supporting skin mods as well means that if you use a skin mod like skin.estuary.mod, then the script will use the skin.estuary menu. The script currently supports custom menus for the following skins:

<syntaxhighlight lang=xml>
skin.ace2
skin.aeon.nox.silvo
skin.aeon.tajo
skin.aeonmq8
skin.amber
skin.apptv
skin.arctic.horizon
skin.arctic.zephyr.2
skin.aura
skin.bello.7
skin.box
skin.confluence
skin.embuary-leia
skin.eminence.2
skin.estuary
skin.ftv
skin.pellucid
skin.quartz
skin.rapier
skin.revolve
skin.transparency
skin.unity
skin.xperience1080
</syntaxhighlight>

''Enable Debug Logging'' 
If Kodi debug logging is enabled, this setting will log additional details to the Kodi log file for debug purposes.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Matrix add-on repository]]
[[Category:Leia add-on repository]]

Add-on:Harmony Hub Controller

2021-03-12T22:53:48Z

Pkscout: /* Settings */

{{Addon
|Name=Harmony Hub Controller
|provider-name=pkscout
|ID=script.harmony.control
|latest-version=0.2.0+matrix.1
|extension point=xbmc.python.script
|provides=executable
|Summary=Addon to send activity and remote commands via a Harmony Hub.
|Description=Harmony Hub Controller let's you setup actions to run a Harmony activity and/or a sequence of remote commands. Running the addon gives you a menu of your actions, and you can also send an action name as an arg to have the script run a specific action.
|Platform=all
|Language=
|License=GPL-2.0-only
|Forum=
|Website=
|Source=https://github.com/pkscout/script.harmony.control
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/matrix/script.harmony.control/icon.png}}

== Features ==
* Allows you to send commands to a Harmony Hub (either just activities or, with advanced settings, individual remote commands)

== How to use this addon ==
=== Basic ===
Once installed, you need to go to the add-on settings, input the IP address, and then use the ''Edit mappings'' option in the settings to create a mapping of Harmony Hub Controller menu item to a Harmony Hub Activity. When you type in the name of activity, use the exact name you gave it on the Harmony Hub. Save the settings, then run the Add-on. A menu will appear with the mapping(s) you made. Select one, and the script will run that Activity on the Hub.

=== Advanced ===
There is an option in the settings for advanced control of the Harmony Hub. If you enable that, you can send remote commands (either just one or a string of them) in addition to the activity. When enabled, there is an additional screen in the ''Edit mappings'' process to add additional commands. The general syntax for commands is:

<syntaxhighlight lang=text>
<command>|<command>|command
</syntaxhighlight>

Where command is one of the remote button commands, and the pipe (|) is a pause. You can add a longer pause by adding pipes with no command between them. The one trick here is that you have to know the exact name of the command the Hub uses. To help a little, the script logs all the commands the Hub knows to the Kodi logfile when debug logging is on. So to get a list of all commands the hub knows, enable Kodi debug logging, then also enable debug logging in the Harmony Hub Controller Add-on, and then run one of the activities you already defined. Then go to the kodi.log file and look for some lines that look like this:

<syntaxhighlight lang=text>
2021-03-12 11:49:47.649 T:1906540 DEBUG <general>: [Harmony Hub Control] the complete list of commands by device is:
</syntaxhighlight>

Right below that will be a line that is the dump of all the commands. My apologies that it's a bit hard to read, but it should get you what you need.

== Settings ==
=== General ===
''Harmony Hub IP Address'' 
The IP address of your Harmony Hub.

''Delay Between Remote Commands:'' 
The amount of delay added between commands when you add a pipe character (|). Adding pipes back to back increase the delay. So, for instance, to get a 1 second delay, you would use ||||.

''Timeout'' 
The amount of time before the script gives up trying to contact the Hub.

''Enable Advanced Harmony Hub Control'' 
Enabling this setting let's you send individual commands to the Hub rather than just activities. See the ''Advanced Usage'' section for more information on this.

''Use Custom Select Menu'' 
This script can use either a standard dialog box or one customized to match the skin you are using. If you're skin isn't supported, you will get a kind of generic "custom" menu. Setting the additional option for supporting skin mods as well means that if you use a skin mod like skin.estuary.mod, then the script will use the skin.estuary menu. The script currently supports custom menus for the following skins:

<syntaxhighlight lang=xml>
skin.ace2
skin.aeon.nox.silvo
skin.aeon.tajo
skin.aeonmq8
skin.amber
skin.apptv
skin.arctic.horizon
skin.arctic.zephyr.2
skin.aura
skin.bello.7
skin.box
skin.confluence
skin.embuary-leia
skin.eminence.2
skin.estuary
skin.ftv
skin.pellucid
skin.quartz
skin.rapier
skin.revolve
skin.transparency
skin.unity
skin.xperience1080
</syntaxhighlight>

''Enable Debug Logging''
If Kodi debug logging is enabled, this setting will log additional details to the Kodi log file for debug purposes.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Matrix add-on repository]]
[[Category:Leia add-on repository]]

Add-on:Harmony Hub Controller

2021-03-12T22:41:30Z

Pkscout:

Add-on:TV Maze Integration

2020-08-11T22:05:16Z

Pkscout: /* Run for Program Addons */

{{Addon
|Name=TV Maze Integration
|provider-name=pkscout
|ID=script.tvmaze.integration
|latest-version=0.6.2
|extension point=xbmc.python.script
|provides=
|Summary=Integration between Kodi and TV Maze.
|Description=This integration allows you to mark shows as acquired on TV Maze (and add them to your followed shows if needed) when you add them to your library and mark them as watched on TV Maze after you watch them. You can also manually follow, unfollow, tag, and untag shows.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=354945
|Website=
|Source=https://github.com/pkscout/script.tvmaze.integration
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.tvmaze.integration/icon.png}}

== Addon settings ==

=== API Information ===
''TV Maze User:'' 
Your TV Maze user id. Note that this addon requires features of the TV Maze API that require a paid subscription. The lowest tier will work fine.

''TV Maze API Key'' 
This can be found on your TV Maze Dashboard.

=== TV Maze Action ===
''Add new Kodi shows to follow list:'' (default False) 
If set to True, when you scan a TV show into your library, it is added to your followed shows list on TV Maze.

''Mark new Kodi episodes as acquired:'' (default True) 
By default when you add a new TV show episode to your library, is is marked as acquired on TV Maze.

''Mark watched Kodi episodes as watched:'' (default True) 
By default when you have watched a certain percentage of an episode, it is marked as watched on TV Maze. 
'''Mark watched afer:''' (default 85%) 
The percentage of the show you need to watch for it to be marked as watched on TV Maze.

''Mark deleted Kodi episodes as watched:'' (default True) 
By default when you delete an episode from your Kodi library, it is marked as watched on TV Maze.

=== Advanced ===
''Enable debug logging:'' (default False) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Using TV Maze Integration ==
Once you have all your settings configured, TV Maze works in three ways. As a background service, a context menu item, and run from the Program Addons area.

=== Background Service ===
TV Maze runs in the background listening for library additions (to add shows to and mark episodes as acquired on TV Maze), library deletions (to mark episodes as watched on TV Maze), and the playing of episodes (to mark them as watched on TV Maze).

=== Context Menu ===
You can use the Kodi context menu on TV shows and episodes. For TV shows you can follow, unfollow, tag, and untag a show. For episodes you can mark as episode as acquired, watched, or skipped. You can also unmark an episode.

=== Run from Program Addons ===
TV Maze can add one or more of the TV shows in your Kodi library to your follow list on TV Maze, remove shows from your TV Maze follow list, and add/remove tags from your TV Maze TV shows. You can also open the settings from the menu that is presented when you run the addon.

== Getting help ==
If you need assistance using TV Maze Integration, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=354945

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). Please note that for Matrix you need to set Update Official Addons to ANY REPOSITORY in Settings > System > Addons.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Matrix add-on repository]]
[[Category:Leia add-on repository]]

Add-on:TV Maze Integration

2020-08-11T22:04:20Z

Pkscout:

{{Addon
|Name=TV Maze Integration
|provider-name=pkscout
|ID=script.tvmaze.integration
|latest-version=0.6.2
|extension point=xbmc.python.script
|provides=
|Summary=Integration between Kodi and TV Maze.
|Description=This integration allows you to mark shows as acquired on TV Maze (and add them to your followed shows if needed) when you add them to your library and mark them as watched on TV Maze after you watch them. You can also manually follow, unfollow, tag, and untag shows.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=354945
|Website=
|Source=https://github.com/pkscout/script.tvmaze.integration
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.tvmaze.integration/icon.png}}

== Addon settings ==

=== API Information ===
''TV Maze User:'' 
Your TV Maze user id. Note that this addon requires features of the TV Maze API that require a paid subscription. The lowest tier will work fine.

''TV Maze API Key'' 
This can be found on your TV Maze Dashboard.

=== TV Maze Action ===
''Add new Kodi shows to follow list:'' (default False) 
If set to True, when you scan a TV show into your library, it is added to your followed shows list on TV Maze.

''Mark new Kodi episodes as acquired:'' (default True) 
By default when you add a new TV show episode to your library, is is marked as acquired on TV Maze.

''Mark watched Kodi episodes as watched:'' (default True) 
By default when you have watched a certain percentage of an episode, it is marked as watched on TV Maze. 
'''Mark watched afer:''' (default 85%) 
The percentage of the show you need to watch for it to be marked as watched on TV Maze.

''Mark deleted Kodi episodes as watched:'' (default True) 
By default when you delete an episode from your Kodi library, it is marked as watched on TV Maze.

=== Advanced ===
''Enable debug logging:'' (default False) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Using TV Maze Integration ==
Once you have all your settings configured, TV Maze works in three ways. As a background service, a context menu item, and run from the Program Addons area.

=== Background Service ===
TV Maze runs in the background listening for library additions (to add shows to and mark episodes as acquired on TV Maze), library deletions (to mark episodes as watched on TV Maze), and the playing of episodes (to mark them as watched on TV Maze).

=== Context Menu ===
You can use the Kodi context menu on TV shows and episodes. For TV shows you can follow, unfollow, tag, and untag a show. For episodes you can mark as episode as acquired, watched, or skipped. You can also unmark an episode.

=== Run for Program Addons ===
TV Maze can add one or more of the TV shows in your Kodi library to your follow list on TV Maze, remove shows from your TV Maze follow list, and add/remove tags from your TV Maze TV shows. You can also open the settings from the menu that is presented when you run the addon.

== Getting help ==
If you need assistance using TV Maze Integration, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=354945

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). Please note that for Matrix you need to set Update Official Addons to ANY REPOSITORY in Settings > System > Addons.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Matrix add-on repository]]
[[Category:Leia add-on repository]]

Add-on:Audio Profiles

2020-06-02T23:44:29Z

Pkscout: /* Notifications */

{{Addon
|Name=Audio Profiles
|provider-name=pkscout, notoco, Regss
|ID=script.audio.profiles
|latest-version=1.4.2
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them.
|Description=Save audio profile and easily switch between them.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353852
|Website=https://kodi.wiki/view/Add-on:Audio_Profiles
|Source=https://github.com/pkscout/script.audio.profiles
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to ten different profiles (four for versions before 2.x) that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to automatically select a profile based on media playing
* option to auto switch based on codec kind and channel count (for videos only)
* option to load a profile when Kodi starts
* popup menu has skin specific look and feel for Ace2, Aeon MQ8, Aeon Nox Silvo, Aeon Tajo, Amber, AppTV, Aura, Arctic Horizon, Arctic Zephyr2Bello 7, Box, Confluence, Embuary, Eminence, Estuary, fTV, Pellucid, Quartz, Rapier, Revolve, Transparency, Unity, and Xperience1080

== How to use this addon ==

=== Configuration ===
By default two of the ten available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 

'''Profiles 5 - 10:''' (default False) 
Toggle this option to individually turn profiles 5 - 10 on or off. Profiles 5 - 10 are off by default. 
''Name of Profiles 5 - 10:'' (default Profile X) 
The name for profiles 5 - 10 (shown in the popup menus and notifications) 

=== HDMI-CEC ===
'''Profile X''' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when the specified profile is activated (Toggle State, Standby, or Wakeup)

=== Auto Switch ===
All the settings in this section allow you to decide what to do if a particular type of media is detected. All settings have the following options: '''None''', '''Profile 1 - 10''', and '''Select menu'''. If you select a profile, that profile will be activated automatically. If you pick '''Select Menu''' the select menu will pop up for that media type. The music media type also has an option to assign any stream with no codec details the profile used for music.

=== Codec Detection ===
All the settings in this section allow you to decide what to do if a particular type of codec or number of channels are detected. All settings have the following options: '''None''', '''Profile 1 - 10''', and '''Select menu'''. If you select a profile, that profile will be activated automatically. If you pick '''Select Menu''' the select menu will pop up for that media type. There is one additional setting:

'''delay before reading codec information''' (default 5) 
The number of seconds the addon waits before asking Kodi for the codec information. Especially with streams, it can take a little time for Kodi to have the information needed.

=== Extras ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use.

'''Profile for Kodi Startup/Wake''' (default None) 
The profile to load when Kodi starts. 
''Force load profile at startup'' (default False) 
If True, the profile loads at startup even if it was selected at shutdown. Useful for resetting the volume level.

'''Use custom select menu''' (default True) 
If True, the addon will attempt to use a skin specific menu (if available). 
''Include skin mods'' (default True) 
If True, the addon will treat skin mods as if they are the original skin and show the custom menu. So, for instance, skin.estuary and skin.estuary.mod would both use the custom menu for Estuary.

'''Auto close select menu''' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
If True, the notifications enabled below will be displayed. 
''Delay before close'' (default 5) 
The number of seconds the notification will show.
''Auto switch notifications'' (default True) 
If True, notifications each time a profile is automatically changed will be shown. 
''Manual switch notifications'' (default True) 
If True, notifications each time a profile is changed via the select menu will be shown. 
''Maintenance notifications'' (default True) 
If True, notifications about saving profiles will be shown. 

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Audio Profiles

2020-06-02T23:44:13Z

Pkscout: /* Notifications */

{{Addon
|Name=Audio Profiles
|provider-name=pkscout, notoco, Regss
|ID=script.audio.profiles
|latest-version=1.4.2
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them.
|Description=Save audio profile and easily switch between them.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353852
|Website=https://kodi.wiki/view/Add-on:Audio_Profiles
|Source=https://github.com/pkscout/script.audio.profiles
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to ten different profiles (four for versions before 2.x) that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to automatically select a profile based on media playing
* option to auto switch based on codec kind and channel count (for videos only)
* option to load a profile when Kodi starts
* popup menu has skin specific look and feel for Ace2, Aeon MQ8, Aeon Nox Silvo, Aeon Tajo, Amber, AppTV, Aura, Arctic Horizon, Arctic Zephyr2Bello 7, Box, Confluence, Embuary, Eminence, Estuary, fTV, Pellucid, Quartz, Rapier, Revolve, Transparency, Unity, and Xperience1080

== How to use this addon ==

=== Configuration ===
By default two of the ten available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 

'''Profiles 5 - 10:''' (default False) 
Toggle this option to individually turn profiles 5 - 10 on or off. Profiles 5 - 10 are off by default. 
''Name of Profiles 5 - 10:'' (default Profile X) 
The name for profiles 5 - 10 (shown in the popup menus and notifications) 

=== HDMI-CEC ===
'''Profile X''' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when the specified profile is activated (Toggle State, Standby, or Wakeup)

=== Auto Switch ===
All the settings in this section allow you to decide what to do if a particular type of media is detected. All settings have the following options: '''None''', '''Profile 1 - 10''', and '''Select menu'''. If you select a profile, that profile will be activated automatically. If you pick '''Select Menu''' the select menu will pop up for that media type. The music media type also has an option to assign any stream with no codec details the profile used for music.

=== Codec Detection ===
All the settings in this section allow you to decide what to do if a particular type of codec or number of channels are detected. All settings have the following options: '''None''', '''Profile 1 - 10''', and '''Select menu'''. If you select a profile, that profile will be activated automatically. If you pick '''Select Menu''' the select menu will pop up for that media type. There is one additional setting:

'''delay before reading codec information''' (default 5) 
The number of seconds the addon waits before asking Kodi for the codec information. Especially with streams, it can take a little time for Kodi to have the information needed.

=== Extras ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use.

'''Profile for Kodi Startup/Wake''' (default None) 
The profile to load when Kodi starts. 
''Force load profile at startup'' (default False) 
If True, the profile loads at startup even if it was selected at shutdown. Useful for resetting the volume level.

'''Use custom select menu''' (default True) 
If True, the addon will attempt to use a skin specific menu (if available). 
''Include skin mods'' (default True) 
If True, the addon will treat skin mods as if they are the original skin and show the custom menu. So, for instance, skin.estuary and skin.estuary.mod would both use the custom menu for Estuary.

'''Auto close select menu''' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
If True, the notifications enabled below will be displayed. 
''Delay before close'' (default 5) 
The number of seconds the notification will show.
''Auto switch notifications'' (default True) 
If True, notifications each time a profile is automatically changed will be shown. 
''manual switch notifications'' (default True) 
If True, notifications each time a profile is changed via the select menu will be shown. 
''Maintenance notifications'' (default True) 
If True, notifications about saving profiles will be shown. 

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Audio Profiles

2020-06-02T23:43:10Z

Pkscout: /* Addon settings */

{{Addon
|Name=Audio Profiles
|provider-name=pkscout, notoco, Regss
|ID=script.audio.profiles
|latest-version=1.4.2
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them.
|Description=Save audio profile and easily switch between them.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353852
|Website=https://kodi.wiki/view/Add-on:Audio_Profiles
|Source=https://github.com/pkscout/script.audio.profiles
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to ten different profiles (four for versions before 2.x) that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to automatically select a profile based on media playing
* option to auto switch based on codec kind and channel count (for videos only)
* option to load a profile when Kodi starts
* popup menu has skin specific look and feel for Ace2, Aeon MQ8, Aeon Nox Silvo, Aeon Tajo, Amber, AppTV, Aura, Arctic Horizon, Arctic Zephyr2Bello 7, Box, Confluence, Embuary, Eminence, Estuary, fTV, Pellucid, Quartz, Rapier, Revolve, Transparency, Unity, and Xperience1080

== How to use this addon ==

=== Configuration ===
By default two of the ten available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 

'''Profiles 5 - 10:''' (default False) 
Toggle this option to individually turn profiles 5 - 10 on or off. Profiles 5 - 10 are off by default. 
''Name of Profiles 5 - 10:'' (default Profile X) 
The name for profiles 5 - 10 (shown in the popup menus and notifications) 

=== HDMI-CEC ===
'''Profile X''' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when the specified profile is activated (Toggle State, Standby, or Wakeup)

=== Auto Switch ===
All the settings in this section allow you to decide what to do if a particular type of media is detected. All settings have the following options: '''None''', '''Profile 1 - 10''', and '''Select menu'''. If you select a profile, that profile will be activated automatically. If you pick '''Select Menu''' the select menu will pop up for that media type. The music media type also has an option to assign any stream with no codec details the profile used for music.

=== Codec Detection ===
All the settings in this section allow you to decide what to do if a particular type of codec or number of channels are detected. All settings have the following options: '''None''', '''Profile 1 - 10''', and '''Select menu'''. If you select a profile, that profile will be activated automatically. If you pick '''Select Menu''' the select menu will pop up for that media type. There is one additional setting:

'''delay before reading codec information''' (default 5) 
The number of seconds the addon waits before asking Kodi for the codec information. Especially with streams, it can take a little time for Kodi to have the information needed.

=== Extras ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use.

'''Profile for Kodi Startup/Wake''' (default None) 
The profile to load when Kodi starts. 
''Force load profile at startup'' (default False) 
If True, the profile loads at startup even if it was selected at shutdown. Useful for resetting the volume level.

'''Use custom select menu''' (default True) 
If True, the addon will attempt to use a skin specific menu (if available). 
''Include skin mods'' (default True) 
If True, the addon will treat skin mods as if they are the original skin and show the custom menu. So, for instance, skin.estuary and skin.estuary.mod would both use the custom menu for Estuary.

'''Auto close select menu''' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
If True, the notifications enabled below will be displayed. 
''Delay before close'' (default 5) 
The number of seconds the notification will show.
''Auto switch notifications'' (default True) 
If True, notifications each time a profile is automatically changed will be shown. 

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Audio Profiles

2020-06-02T23:28:47Z

Pkscout: /* Addon settings */

{{Addon
|Name=Audio Profiles
|provider-name=pkscout, notoco, Regss
|ID=script.audio.profiles
|latest-version=1.4.2
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them.
|Description=Save audio profile and easily switch between them.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353852
|Website=https://kodi.wiki/view/Add-on:Audio_Profiles
|Source=https://github.com/pkscout/script.audio.profiles
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to ten different profiles (four for versions before 2.x) that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to automatically select a profile based on media playing
* option to auto switch based on codec kind and channel count (for videos only)
* option to load a profile when Kodi starts
* popup menu has skin specific look and feel for Ace2, Aeon MQ8, Aeon Nox Silvo, Aeon Tajo, Amber, AppTV, Aura, Arctic Horizon, Arctic Zephyr2Bello 7, Box, Confluence, Embuary, Eminence, Estuary, fTV, Pellucid, Quartz, Rapier, Revolve, Transparency, Unity, and Xperience1080

== How to use this addon ==

=== Configuration ===
By default two of the ten available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 

'''Profiles 5 - 10:''' (default False) 
Toggle this option to individually turn profiles 5 - 10 on or off. Profiles 5 - 10 are off by default. 
''Name of Profiles 5 - 10:'' (default Profile X) 
The name for profiles 5 - 10 (shown in the popup menus and notifications) 

=== HDMI-CEC ===
'''Profile X''' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when the specified profile is activated (Toggle State, Standby, or Wakeup)

=== Settings ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use. 
''Auto close select menu'' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
By default, any time a profile is changed Kodi will display a notification indicating which profile just became active. Turn this off to disable that behavior.

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Audio Profiles

2020-06-02T23:27:09Z

Pkscout: /* Profiles */

{{Addon
|Name=Audio Profiles
|provider-name=pkscout, notoco, Regss
|ID=script.audio.profiles
|latest-version=1.4.2
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them.
|Description=Save audio profile and easily switch between them.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353852
|Website=https://kodi.wiki/view/Add-on:Audio_Profiles
|Source=https://github.com/pkscout/script.audio.profiles
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to ten different profiles (four for versions before 2.x) that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to automatically select a profile based on media playing
* option to auto switch based on codec kind and channel count (for videos only)
* option to load a profile when Kodi starts
* popup menu has skin specific look and feel for Ace2, Aeon MQ8, Aeon Nox Silvo, Aeon Tajo, Amber, AppTV, Aura, Arctic Horizon, Arctic Zephyr2Bello 7, Box, Confluence, Embuary, Eminence, Estuary, fTV, Pellucid, Quartz, Rapier, Revolve, Transparency, Unity, and Xperience1080

== How to use this addon ==

=== Configuration ===
By default two of the ten available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 

'''Profiles 5 - 10:''' (default False) 
Toggle this option to individually turn profiles 5 - 10 on or off. Profiles 5 - 10 are off by default. 
''Name of Profiles 5 - 10:'' (default Profile X) 
The name for profiles 5 - 10 (shown in the popup menus and notifications) 

=== Settings ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use. 
''Auto close select menu'' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
By default, any time a profile is changed Kodi will display a notification indicating which profile just became active. Turn this off to disable that behavior.

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Audio Profiles

2020-06-02T23:22:27Z

Pkscout: /* How to use this addon */

{{Addon
|Name=Audio Profiles
|provider-name=pkscout, notoco, Regss
|ID=script.audio.profiles
|latest-version=1.4.2
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them.
|Description=Save audio profile and easily switch between them.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353852
|Website=https://kodi.wiki/view/Add-on:Audio_Profiles
|Source=https://github.com/pkscout/script.audio.profiles
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to ten different profiles (four for versions before 2.x) that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to automatically select a profile based on media playing
* option to auto switch based on codec kind and channel count (for videos only)
* option to load a profile when Kodi starts
* popup menu has skin specific look and feel for Ace2, Aeon MQ8, Aeon Nox Silvo, Aeon Tajo, Amber, AppTV, Aura, Arctic Horizon, Arctic Zephyr2Bello 7, Box, Confluence, Embuary, Eminence, Estuary, fTV, Pellucid, Quartz, Rapier, Revolve, Transparency, Unity, and Xperience1080

== How to use this addon ==

=== Configuration ===
By default two of the ten available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 1 is activated (Toggle State, Standby, or Wakeup)

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 2 is activated (Toggle State, Standby, or Wakeup)

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 3 is activated (Toggle State, Standby, or Wakeup)

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 4 is activated (Toggle State, Standby, or Wakeup)

=== Settings ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use. 
''Auto close select menu'' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
By default, any time a profile is changed Kodi will display a notification indicating which profile just became active. Turn this off to disable that behavior.

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Audio Profiles

2020-06-02T23:21:58Z

Pkscout: /* Features */

{{Addon
|Name=Audio Profiles
|provider-name=pkscout, notoco, Regss
|ID=script.audio.profiles
|latest-version=1.4.2
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them.
|Description=Save audio profile and easily switch between them.
|Platform=all
|Language=
|License=GPL-3.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353852
|Website=https://kodi.wiki/view/Add-on:Audio_Profiles
|Source=https://github.com/pkscout/script.audio.profiles
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to ten different profiles (four for versions before 2.x) that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to automatically select a profile based on media playing
* option to auto switch based on codec kind and channel count (for videos only)
* option to load a profile when Kodi starts
* popup menu has skin specific look and feel for Ace2, Aeon MQ8, Aeon Nox Silvo, Aeon Tajo, Amber, AppTV, Aura, Arctic Horizon, Arctic Zephyr2Bello 7, Box, Confluence, Embuary, Eminence, Estuary, fTV, Pellucid, Quartz, Rapier, Revolve, Transparency, Unity, and Xperience1080

== How to use this addon ==

=== Configuration ===
By default two of the four available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 1 is activated (Toggle State, Standby, or Wakeup)

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 2 is activated (Toggle State, Standby, or Wakeup)

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 3 is activated (Toggle State, Standby, or Wakeup)

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 4 is activated (Toggle State, Standby, or Wakeup)

=== Settings ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use. 
''Auto close select menu'' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
By default, any time a profile is changed Kodi will display a notification indicating which profile just became active. Turn this off to disable that behavior.

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Where Are You

2020-05-09T01:18:45Z

Pkscout: /* Generating the Stream Files */

{{Addon
|Name=Where Are You
|provider-name=pkscout
|ID=plugin.whereareyou
|latest-version=0.2.1
|extension point=xbmc.python.pluginsource
|provides=executable
|Summary=Plugin module to display a custom dialog box when playing external media.
|Description=Where Are You is a plugin for Kodi that accepts a URL from a stream file and then displays a dialog box with the title and message from the stream file URL. After the dialog is dismissed a black video plays for 2 seconds. This is basically to do what the media stub file does (which is display a title and a message for a given file), but for streaming files because the media stub only works if you have an optical drive attached to the device running Kodi.

|Platform=all
|Language=
|License=GPL-2.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353924
|Website=
|Source=https://github.com/pkscout/plugin.whereareyou
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/plugin.whereareyou/icon.png}}

== About ==

Where Are You is a plugin for Kodi that accepts a URL from a stream file and then displays a dialog box with the title and message from the stream file URL. After the dialog is dismissed a black video plays for 2 seconds. This is basically to do what the media stub file does (which is display a title and a message for a given file), but for streaming files because the media stub only works if you have an optical drive attached to the device running Kodi.

== Usage ==

The stream file is just a text file with a URL in it. The format of the URL is:

<syntaxhighlight>
plugin://plugin.whereareyou?empty=pad&title=Available+streaming&message=This+is+available+via+the+Netflix+app+on+the+TV
</syntaxhighlight>

The stream file should be named in a way that Kodi can scrape it as a TV show:

<syntaxhighlight>
My.TV.Show.S01.E01.My.Episode.strm
</syntaxhighlight>
or a movie:

<syntaxhighlight>
My.Great.Movie (2020).strm
</syntaxhighlight>

Place the stream file in a location you have defined as a source and then scan the stream files into your library. Now when you play them you'll get a dialog box telling you were to find the TV show or movie (like the Disney+ app on your Smart TV).

== Generating the Stream Files ==

I also wrote a little python3 command line tool to generate the stream files. That command line tool is available at:

https://github.com/pkscout/create.kodi.mediastubs/releases/

== Credits ==

The icon is Compass by Diane from the Noun Project.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Matrix add-on repository]]
[[Category:Leia add-on repository]]

Add-on:Where Are You

2020-05-09T01:18:27Z

Pkscout:

{{Addon
|Name=Where Are You
|provider-name=pkscout
|ID=plugin.whereareyou
|latest-version=0.2.1
|extension point=xbmc.python.pluginsource
|provides=executable
|Summary=Plugin module to display a custom dialog box when playing external media.
|Description=Where Are You is a plugin for Kodi that accepts a URL from a stream file and then displays a dialog box with the title and message from the stream file URL. After the dialog is dismissed a black video plays for 2 seconds. This is basically to do what the media stub file does (which is display a title and a message for a given file), but for streaming files because the media stub only works if you have an optical drive attached to the device running Kodi.

|Platform=all
|Language=
|License=GPL-2.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=353924
|Website=
|Source=https://github.com/pkscout/plugin.whereareyou
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/plugin.whereareyou/icon.png}}

== About ==

Where Are You is a plugin for Kodi that accepts a URL from a stream file and then displays a dialog box with the title and message from the stream file URL. After the dialog is dismissed a black video plays for 2 seconds. This is basically to do what the media stub file does (which is display a title and a message for a given file), but for streaming files because the media stub only works if you have an optical drive attached to the device running Kodi.

== Usage ==

The stream file is just a text file with a URL in it. The format of the URL is:

<syntaxhighlight>
plugin://plugin.whereareyou?empty=pad&title=Available+streaming&message=This+is+available+via+the+Netflix+app+on+the+TV
</syntaxhighlight>

The stream file should be named in a way that Kodi can scrape it as a TV show:

<syntaxhighlight>
My.TV.Show.S01.E01.My.Episode.strm
</syntaxhighlight>
or a movie:

<syntaxhighlight>
My.Great.Movie (2020).strm
</syntaxhighlight>

Place the stream file in a location you have defined as a source and then scan the stream files into your library. Now when you play them you'll get a dialog box telling you were to find the TV show or movie (like the Disney+ app on your Smart TV).

== Generating the Stream Files ==

I also wrote a little python3 command line tool to generate the stream files. That command line tool is available at:

<https://github.com/pkscout/create.kodi.mediastubs/releases/>

== Credits ==

The icon is Compass by Diane from the Noun Project.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Matrix add-on repository]]
[[Category:Leia add-on repository]]

Add-on:SpeedFan Information Display

2020-04-24T23:27:52Z

Pkscout: /* Beta Testing */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=1.1.0
|extension point=xbmc.python.script
|provides=executable
|Summary=Vertoon inligting van jou SpeedFan Aantekenings.
|Description=Ontleed en vertoon inligting van die SpeedFan Aantekenings. Terwyl hierdie plugin werk op enige platform, SpeedFan werk net op Windows, so dit is optimaal gebou vir mense wat Kodi op Windows gebruik. Sien readme.txt vir inligting oor hoe om jou SpeedFan Aantekenings in te stel sodat die prop dit behoorlik kan ontleed nie.
|Platform=all
|Language=
|License=GPL-2.0-only
|Forum=https://forum.kodi.tv/showthread.php?tid=122481
|Website=https://kodi.wiki/view/Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
'''AVAILABLE ONLY ON VERSIONS OLDER THAN 1.0.0''' When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the Kodi forums for assistance.

: https://forum.kodi.tv/showthread.php?tid=122481

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2020-04-24T23:26:58Z

Pkscout: /* Beta Testing */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.1.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Show notification during image downloads:'' (default false) 
If set to true, Artist Slideshow will show a notification any time it starts downloading new artist images and then another when it is done downloading images for the artist.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties==
Window(Visualisation).Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images of the currently playing artist

Window(Visualisation).Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses either a single image control (for version 3.x) or a multi-image control (version 2.x). See [[Add-on:Artist_Slideshow#Changes_to_MusicVisualisation.xml|section on changes to MusicVisualisation.xml.]]

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images for the currently playing artist.

Window.Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Audio Profiles

2020-04-24T21:59:19Z

Pkscout: /* Getting help */

{{Addon
|Name=Audio Profiles
|provider-name=Regss
|ID=script.audio.profiles
|latest-version=1.2.0
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them
|Description=To map a key for switch audio profile edit keymap xml file and add:
RunScript(script.audio.profiles,0) - for switch profile in loop
RunScript(script.audio.profiles,x) - where x is number of profile
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=200081
|Website=
|Source=https://github.com/Regss/script.audio.profiles
|Email=regss84@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to four different profiles that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to show a dialog box to select an audio profile any time Kodi starts playing a media file
* option to automatically select a profile based on media playing
* option to load a profile when Kodi starts

== How to use this addon ==

=== Configuration ===
By default two of the four available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 1 is activated (Toggle State, Standby, or Wakeup)

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 2 is activated (Toggle State, Standby, or Wakeup)

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 3 is activated (Toggle State, Standby, or Wakeup)

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 4 is activated (Toggle State, Standby, or Wakeup)

=== Settings ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use. 
''Auto close select menu'' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
By default, any time a profile is changed Kodi will display a notification indicating which profile just became active. Turn this off to disable that behavior.

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Audio Profiles

2020-04-24T21:58:38Z

Pkscout: new instructions for version 1.42 and later

{{Addon
|Name=Audio Profiles
|provider-name=Regss
|ID=script.audio.profiles
|latest-version=1.2.0
|extension point=xbmc.python.script
|provides=
|Summary=Save audio profile and easily switch between them
|Description=To map a key for switch audio profile edit keymap xml file and add:
RunScript(script.audio.profiles,0) - for switch profile in loop
RunScript(script.audio.profiles,x) - where x is number of profile
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=200081
|Website=
|Source=https://github.com/Regss/script.audio.profiles
|Email=regss84@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.audio.profiles/icon.png}}
== Features ==
Audio Profiles is a Kodi addon to help you easily switch between certain audio and video settings in Kodi. Version 1.2 is the last version available for Kodi 17 and earlier. Version 1.42 or later is required for proper functioning on Kodi 18 or later.

* save up to four different profiles that include the settings from System/Audio, System/Display (optional), Player/Videos (optional), and the Kodi volume.
* send an HDMI-CEC command when a profile is activated (Toggle State, Standby, or Wakeup)
* switch between profiles using different keymaps for each profile
* rotate through profiles using a single keymap
* select a profile using a pop up dialog box
* option to show a dialog box to select an audio profile any time Kodi starts playing a media file
* option to automatically select a profile based on media playing
* option to load a profile when Kodi starts

== How to use this addon ==

=== Configuration ===
By default two of the four available profiles are enabled and named Digital (profile 1) and Analog (profile 2). From the settings (see below for details on the settings) you can rename the profiles and configure the other settings.

=== Saving Profiles ===
Audio Profiles saves the options from a handful of areas within the Kodi settings. Those are:
* System/Audio
* System/Display (always saved, only changed on profile change if enabled in settings)
* Player/Videos (always saved, only changed on profile change if enabled in settings)
* Kodi system volume (always saved, only changed on profile change if enabled in settings)

Once you have configured those areas they way you want, go to the Audio Profiles addon and run it. A dialog box will pop up asking you to select a profile in which to save the settings. After saving the settings, make the changes you want to the Kodi settings, and run the addon again to save to another profile. You may save up to four profiles. If you ever want to make changes to a profile, load it (see usage below on how to change profiles), make your changes, and then run the addon to select the profile you want to update.

=== Switching Profiles Using Keymaps ===
You can assign keys and remote buttons in Kodi using keymaps. For more information on keymaps (including how to create them and where to store them), please see [https://kodi.wiki/view/Keymap the Kodi wiki page on keymaps]. You assign a key to run a particular Kodi function that will either select a profile, pop up a dialog box for you to pick, or rotate through your profiles. You don't need to have a keymap for every option, just the ones you want to use. Here's an example of all those options for reference where each action is mapped to a function key:

<syntaxhighlight lang=xml>
<keymap>
<global>
<keyboard>
<F1>RunScript(script.audio.profiles,1)</F1> 
<F2>RunScript(script.audio.profiles,2)</F2> 
<F3>RunScript(script.audio.profiles,3)</F3> 
<F4>RunScript(script.audio.profiles,4)</F4> 
<F5>RunScript(script.audio.profiles,popup)</F5> 
<F6>RunScript(script.audio.profiles,0)</F6> 
</keyboard>
</global>
</keymap>
</syntaxhighlight>

You will need to restart Kodi for the new keymaps to be active.

== Addon settings ==

=== Profiles ===
'''Profile 1:''' (default True) 
Toggle this option to turn profile 1 on or off. Profile 2 is on by default. 
''Name of Profile 1:'' (default Digital) 
The name for profile 1 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 1 is activated (Toggle State, Standby, or Wakeup)

'''Profile 2:''' (default True) 
Toggle this option to turn profile 2 on or off. Profile 2 is on by default. 
''Name of Profile 2:'' (default Analog) 
The name for profile 2 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 2 is activated (Toggle State, Standby, or Wakeup)

'''Profile 3:''' (default False) 
Toggle this option to turn profile 3 on or off. Profile 3 is off by default. 
''Name of Profile 3:'' (default Headphones) 
The name for profile 3 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 3 is activated (Toggle State, Standby, or Wakeup)

'''Profile 4:''' (default False) 
Toggle this option to turn profile 4 on or off. Profile 4 is off by default. 
''Name of Profile 4:'' (default HDMI) 
The name for profile 4 (shown in the popup menus and notifications) 
''Send HDMI-CEC command when profile activated:'' (default None) 
If set to something other than None, sends the selected HDMI-CEC command when profile 4 is activated (Toggle State, Standby, or Wakeup)

=== Settings ===
'''Include volume level''' (default False) 
if activated, all profiles will save and change the Kodi system volume level when profiles are activated.

'''Include video player settings''' (default False) 
If activated, all profiles will save and change the settings in the Kodi settings area Player/Videos.

'''Include display settings''' (default False) 
If active, all profiles will save and change the settings in the Kodi settings area System/Display.

'''Show audio stream select menu on start playing''' (default False) 
If activated, any time Kodi starts playing any media file a dialog box will popup so you can select the profile you want to use. 
''Auto close select menu'' (default False) 
If activated, the menu will disappear after a certain amount of time (see next setting below). Please note that if you stop playing media, the dialog box will close immediately. 
''Delay before close'' (default 10 seconds) 
If the auto close option is activated, Kodi will wait this many seconds before closing the dialog box automatically. You may select between 5 and 30 seconds.

=== Notifications ===
'''Notifications:''' (default True) 
By default, any time a profile is changed Kodi will display a notification indicating which profile just became active. Turn this off to disable that behavior.

'''Enable debug logging''' (default False) 
When enabled, if you have Kodi logging set to DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Getting help ==
If you need assistance using Audio Profiles, please see the support thread on the Kodi forums.
: https://forum.kodi.tv/showthread.php?tid=353852>.

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Leia or later, there will be no more updates for earlier versions) from my addon beta repository - either [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip Kodi 18 (Leia)] or [https://github.com/pkscout/repository.beta.pkscout/raw/matrix/repository.beta.pkscout-1.1.2.zip Kodi 19 (Matrix) and later] (these are zip downloads). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2020-01-19T16:39:31Z

Pkscout: /* Find a Compatible Skin */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=3.1.0
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GPL-2.0-only
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.1.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Show notification during image downloads:'' (default false) 
If set to true, Artist Slideshow will show a notification any time it starts downloading new artist images and then another when it is done downloading images for the artist.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties==
Window(Visualisation).Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images of the currently playing artist

Window(Visualisation).Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses either a single image control (for version 3.x) or a multi-image control (version 2.x). See [[Add-on:Artist_Slideshow#Changes_to_MusicVisualisation.xml|section on changes to MusicVisualisation.xml.]]

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images for the currently playing artist.

Window.Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2020-01-02T01:51:17Z

Pkscout: /* Images */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=3.0.0
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GPL-2.0-only
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Show notification during image downloads:'' (default false) 
If set to true, Artist Slideshow will show a notification any time it starts downloading new artist images and then another when it is done downloading images for the artist.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties==
Window(Visualisation).Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images of the currently playing artist

Window(Visualisation).Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses either a single image control (for version 3.x) or a multi-image control (version 2.x). See [[Add-on:Artist_Slideshow#Changes_to_MusicVisualisation.xml|section on changes to MusicVisualisation.xml.]]

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images for the currently playing artist.

Window.Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2019-12-26T22:40:36Z

Pkscout: /* Compatibility */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.8
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
'''AVAILABLE ONLY ON VERSIONS OLDER THAN 1.0.0''' When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the Kodi forums for assistance.

: https://forum.kodi.tv/showthread.php?tid=122481

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip pkscout's Add On Beta Repository]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2019-12-26T22:39:57Z

Pkscout: /* Beta Testing */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.8
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
'''AVAILABLE ONLY ON VERSIONS OLDER THAN 1.0.0''' When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the Kodi forums for assistance.

: https://forum.kodi.tv/showthread.php?tid=122481

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip pkscout's Add On Beta Repository]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2019-12-26T22:39:38Z

Pkscout: /* Beta Testing */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.8
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
'''AVAILABLE ONLY ON VERSIONS OLDER THAN 1.0.0''' When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the Kodi forums for assistance.

: https://forum.kodi.tv/showthread.php?tid=122481

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip pkscout's Add On Beta Repository). You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-23T19:09:11Z

Pkscout: /* Beta Testing */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=3.0.0
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GPL-2.0-only
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties==
Window(Visualisation).Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images of the currently playing artist

Window(Visualisation).Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses either a single image control (for version 3.x) or a multi-image control (version 2.x). See [[Add-on:Artist_Slideshow#Changes_to_MusicVisualisation.xml|section on changes to MusicVisualisation.xml.]]

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images for the currently playing artist.

Window.Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [https://github.com/pkscout/repository.beta.pkscout/raw/helix/repository.beta.pkscout-1.1.1.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T17:18:27Z

Pkscout: /* Additional script/skin properties available */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties==
Window(Visualisation).Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images of the currently playing artist

Window(Visualisation).Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses either a single image control (for version 3.x) or a multi-image control (version 2.x). See [[Add-on:Artist_Slideshow#Changes_to_MusicVisualisation.xml|section on changes to MusicVisualisation.xml.]]

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images for the currently playing artist.

Window.Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T17:17:16Z

Pkscout: /* New skin properties */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties==
Window(Visualisation).Property(ArtistSlideshow.Image)
'''VERSION 3.x ONLY''' This is one of the randomly selected images of the currently playing artist

Window(Visualisation).Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses either a single image control (for version 3.x) or a multi-image control (version 2.x). See [[Add-on:Artist_Slideshow#Changes_to_MusicVisualisation.xml|section on changes to MusicVisualisation.xml.]]

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(Artist.Image)
'''VERSION 3.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2019-12-16T04:41:10Z

Pkscout: /* Advanced */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.8
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
'''AVAILABLE ONLY ON VERSIONS OLDER THAN 1.0.0''' When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the Kodi forums for assistance.

: https://forum.kodi.tv/showthread.php?tid=122481

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [http://raw.github.com/pkscout/repository.beta.pkscout/gotham/repository.beta.pkscout-1.0.2.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T04:38:05Z

Pkscout: /* How to call this addon from another addon */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties==
Window(Visualisation).Property(Artist.Image)
'''VERSION 3.x ONLY''' This is one of the random selected images of the currently playing artist

Window(Visualisation).Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses either a single image control (for version 3.x) or a multi-image control (version 2.x). See [[Add-on:Artist_Slideshow#Changes_to_MusicVisualisation.xml|section on changes to MusicVisualisation.xml.]]

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(Artist.Image)
'''VERSION 3.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T04:32:07Z

Pkscout: /* New skin properties for version 2.x */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties==
Window(Visualisation).Property(Artist.Image)
'''VERSION 3.x ONLY''' This is one of the random selected images of the currently playing artist

Window(Visualisation).Property(ArtistSlideshow)
'''VERSION 2.x ONLY''' This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
'''VERSION 2.x ONLY''' Lets the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
'''VERSION 2.x ONLY''' Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T04:27:51Z

Pkscout: /* New skin properties */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties for version 2.x==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T04:08:45Z

Pkscout: /* Addon settings for version 3.x */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

''Move images to Kodi music artist folder'' 
This will run a script to rename all your artwork to the Kodi music artist folder standard (fanart1, fanart2, etc). It cannot be undone, so please backup your artist images before you do this.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T04:05:47Z

Pkscout: /* Addon settings for version 3.x */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T04:04:22Z

Pkscout: /* Addon settings for version 3.x */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

=== Storage ===
''Store artist images in:'' (default addon_data folder) 
three options: addon_data folder, custom location, Kodi artist information folder 
'''addon_data folder''' uses the default data storage location for Kodi addons. If you select this option you can also limit the size of the downloads to between 128mb and 4gb. 
'''Custom location''' use a location you define. If you select this option you can also specific a different name for the extrafanart folder or even opt not to use an extrafanart folder at all. 
'''Kodi artist information folder''' will use the artist information folder defined in the main Kodi settings. If you select this option and haven't set the artist information folder in Kodi, it will default back to the addon_data folder.

''Store artist information in:'' (default addon_data folder) 
two options: addon_data folder, custom location 
'''addon_data folder''' uses the default data storage location for Kodi addons. 
'''Custom location''' use a location you define. 

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T03:55:35Z

Pkscout:

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 3.x ==

=== Slideshow ===
''Delay between slide transitions:'' (default 10 seconds) 
The time each slide will show on the screen.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

''Fade to black during chage in artists:'' (default True) 
Shows a black screen when transitioning from one artist to another. To allow the skin to show some other image during transition instead, set this to False.

''Include Kodi artist fanart:'' (default True) 
If Kodi downloaded an artist image during scraping of the music, this image will be included in the slideshow and shown first while other images are loading in the background.

''Include Kodi album fanart:'' (default False) 
If Kodi downloaded an album fanart image during scraping of the music, this image will be included in the slideshow..

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T03:47:15Z

Pkscout: /* Addon settings */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings for version 2.x ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T03:45:59Z

Pkscout: /* Changes to MusicVisualisation.xml */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
If you want to manually add support for AS to an existing skin, you need to add/update a few things in MusicVisualization.xml.

To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

For both AS 2.x and 3.x support:
<syntaxhighlight lang=xml>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Player.Art(fanart)]</texture>
<visible>String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="image">
<aspectratio>scale</aspectratio>
<fadetime>400</fadetime>
<animation effect="fade" start="0" end="100" time="400">WindowOpen</animation>
<animation effect="fade" start="100" end="0" time="300">WindowClose</animation>
<texture background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow.Image)]</texture>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.Image))</visible>
</control>
<control type="multiimage">
<aspectratio>scale</aspectratio>
<timeperimage>10000</timeperimage>
<randomize>true</randomize>
<fadetime>600</fadetime>
<loop>yes</loop>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<visible>!String.IsEmpty(Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)</visible>
</control></syntaxhighlight>

For AS 3.x only support you can ignore the multiimage control near the bottom.

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T03:42:17Z

Pkscout: /* Using Artist Slideshow with the default Estuary Skin */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you are using AS 3.0.0 or later (which is available for Kodi 18 or later), you must be using Kodi 18.5 or later for images to display properly. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T03:40:50Z

Pkscout: /* Find a Compatible Skin */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo for [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-12-16T03:39:48Z

Pkscout: /* Features */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.4
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=https://forum.kodi.tv/showthread.php?t=124880
|Website=https://kodi.wiki/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-04-13T17:30:07Z

Pkscout: /* Using Artist Slideshow with the default Confluence Skin */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.3
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?t=124880
|Website=http://wiki.xbmc.org/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
** option to display notification during download of first image for an artist with option to provide a local image (or images) to use instead of default Kodi notification
** option to display notification when downloads are complete (or no images found for download)
** ability to exclude images from being downloaded (see Tips and Tricks below)
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Estuary Skin ===
As of Kodi 18, the default Estuary skin has built in basic support for Artist Slideshow. If you're on Kodi 17 you can use my Estuary mod to support Artist Slideshow.

https://forum.kodi.tv/showthread.php?tid=303946

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2019-03-01T02:47:19Z

Pkscout: /* Getting Help */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.8
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the Kodi forums for assistance.

: https://forum.kodi.tv/showthread.php?tid=122481

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [http://raw.github.com/pkscout/repository.beta.pkscout/gotham/repository.beta.pkscout-1.0.2.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2019-03-01T02:46:17Z

Pkscout: /* Getting Help */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.8
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the Kodi forums for assistance.

: https://forum.kodi.tv/showthread.php?tid=1014479

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [http://raw.github.com/pkscout/repository.beta.pkscout/gotham/repository.beta.pkscout-1.0.2.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-03-01T02:43:53Z

Pkscout: /* Getting help */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.3
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?t=124880
|Website=http://wiki.xbmc.org/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
** option to display notification during download of first image for an artist with option to provide a local image (or images) to use instead of default Kodi notification
** option to display notification when downloads are complete (or no images found for download)
** ability to exclude images from being downloaded (see Tips and Tricks below)
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Confluence Skin ===
Depending on the version of Kodi you have and the operating system on which you are running it, the files you need to modify will be in different locations. If you don't know where skin files are stored, then this is not the option for you. Please see the section above for information on downloading and installing a skin that supports Artist Slideshow.

''Change Default Skin Files''

This is probably the easiest way, but anytime you upgrade or reinstall XBMC you will have to redo these modifications. Go to the Kodi installation root folder (see this wiki page under special://xbmc for the path for your operating system). Then go to addons --> skin.confluence. Quit Kodi, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

''Create Custom Skin''

This is a bit more complicated but will keep your modifications intact across upgrades. Go to the Kodi installation folder, enter the addon directory and find the skin.confluence folder. Make a copy of it and move it to your user addon directory. Rename the directory to skin.confluence.mod. In that directory open the file called addon.xml. Change the third line to read id="skin.confluence.mod" and then launch (or relaunch Kodi). Go to SYSTEM --> APPEARANCE --> SKIN and switch to the modified skin. When you do that you will lose all your current skin settings, so you might want to write them down before changing. Quit Kodi again, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?tid=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2019-03-01T02:42:47Z

Pkscout: /* Getting help */

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.3
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?t=124880
|Website=http://wiki.xbmc.org/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/leia/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
** option to display notification during download of first image for an artist with option to provide a local image (or images) to use instead of default Kodi notification
** option to display notification when downloads are complete (or no images found for download)
** ability to exclude images from being downloaded (see Tips and Tricks below)
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Confluence Skin ===
Depending on the version of Kodi you have and the operating system on which you are running it, the files you need to modify will be in different locations. If you don't know where skin files are stored, then this is not the option for you. Please see the section above for information on downloading and installing a skin that supports Artist Slideshow.

''Change Default Skin Files''

This is probably the easiest way, but anytime you upgrade or reinstall XBMC you will have to redo these modifications. Go to the Kodi installation root folder (see this wiki page under special://xbmc for the path for your operating system). Then go to addons --> skin.confluence. Quit Kodi, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

''Create Custom Skin''

This is a bit more complicated but will keep your modifications intact across upgrades. Go to the Kodi installation folder, enter the addon directory and find the skin.confluence folder. Make a copy of it and move it to your user addon directory. Rename the directory to skin.confluence.mod. In that directory open the file called addon.xml. Change the third line to read id="skin.confluence.mod" and then launch (or relaunch Kodi). Go to SYSTEM --> APPEARANCE --> SKIN and switch to the modified skin. When you do that you will lose all your current skin settings, so you might want to write them down before changing. Quit Kodi again, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none) 
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first) 
three options: remote first, local first, both 
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow 
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow 
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false) 
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false) 
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both) 
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false) 
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false) 
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty) 
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false) 
Tells Kodi to use this folder of images if no artwork is found for the playing artist 
'''Fallback slideshow folder:''' (default none) 
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false) 
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded. 
'''Override slideshow folder:''' (default none) 
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false) 
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Client API key''' (default empty) 
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false) 
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Download all images regardless of resolution:''' (default false) 
Downloads images even if they are not in 16x9 aspect ratio. 
'''I donate to this service:''' (default false) 
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false) 
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Download album info fromlast.fm'' (default false) 
Downloads the artist's discography from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English) 
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages). 
''Get artist bio from Kodi:'' (default: true) 
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio from theaudiodb.com'' (default: false) 
If selected, AS will download the artist bio matching the selected language from theaudiodb.com. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 
''Get artist bio fromlast.fm'' (default: false) 
If selected, AS will download the artist bio matching the selected language from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false) 
If selected, AS will download a list of similar artists from last.fm. 
'''Priority''' (range 1 - 10, default 5) 
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last. 

=== Advanced ===
''Download notification type:'' (default none) 
three options: none, text notifications, custom images 
'''none''' will surpress all notifications 
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete) 
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''') 
'''Progress images folder:''' (default empty) 
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder. 
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings. 
'''Replace illegal path characters in artist name with''' (default _) 
This character replaces any illegal characters noted above. 
'''Replace trailing period in artist name with:''' (default BLANK) 
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false) 
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted. 
'''Maximum cache size (in megabytes):''' (default 1024) 
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false) 
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: https://forum.kodi.tv/showthread.php?t=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2018-04-28T01:04:26Z

Pkscout: /* Getting Help */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.6
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the Kodi forums for assistance.
<http://forum.kodi.tv/showthread.php?p=1014479>

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [http://raw.github.com/pkscout/repository.beta.pkscout/gotham/repository.beta.pkscout-1.0.2.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2018-04-28T01:03:42Z

Pkscout: /* General */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.6
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'' Primary Log File Title: '' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'' Log File Location: '' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

'' Use Compact Display '' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

'' Log Temperature Scale '' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

'' Window Update Interval (in seconds) '' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the XBMC forums for assistance.
<http://forum.kodi.tv/showthread.php?p=1014479>

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [http://raw.github.com/pkscout/repository.beta.pkscout/gotham/repository.beta.pkscout-1.0.2.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2018-04-28T01:02:59Z

Pkscout: /* Additional Logs */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.6
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'Primary Log File Title:'' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'Log File Location:'' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

''Use Compact Display'' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

''Log Temperature Scale'' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

''Window Update Interval (in seconds)'' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
''Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the XBMC forums for assistance.
<http://forum.kodi.tv/showthread.php?p=1014479>

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [http://raw.github.com/pkscout/repository.beta.pkscout/gotham/repository.beta.pkscout-1.0.2.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2018-04-28T00:30:13Z

Pkscout: /* Compatibility */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.6
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. The add-on will run on any platform using Kodi Helix or later (although testing and active support is only done on the current production version of Kodi), but SpeedFan is a Windows only program. Please see below for information on how to run an external script of your choice to generate copy cat SpeedFan log files for showing data from non-Windows platforms.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'Primary Log File Title:'' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'Log File Location:'' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

''Use Compact Display'' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

''Log Temperature Scale'' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

''Window Update Interval (in seconds)'' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
"'Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the XBMC forums for assistance.
<http://forum.kodi.tv/showthread.php?p=1014479>

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [http://raw.github.com/pkscout/repository.beta.pkscout/gotham/repository.beta.pkscout-1.0.2.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:SpeedFan Information Display

2018-04-28T00:27:38Z

Pkscout: /* Addon Options */

{{Addon
|Name=SpeedFan Information Display
|provider-name=pkscout
|ID=script.speedfaninfo
|latest-version=0.7.6
|extension point=xbmc.python.script
|provides=executable
|Summary=Display information from your SpeedFan log.
|Description=Parses and displays information from the SpeedFan log. While this plugin works on any platform, SpeedFan only works on Windows, so it is optimally built for people using XBMC on Windows. Please see readme.txt for information on how to configure your SpeedFan log so that the plugin can parse it properly.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?p=1014479
|Website=http://wiki.xbmc.org/index.php?title=Add-on:SpeedFan_Information_Display
|Source=https://github.com/pkscout/script.speedfaninfo
|Email=speedfaninfo.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.speedfaninfo/icon.png}}
== Information ==
=== Getting SpeedFan ===
SpeedFan is available at: http://www.almico.com/speedfan.php

=== Compatibility ===
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. It has been tested on XBMC Eden (11.0) and Frodo (12.0) on Windows and Macintosh. It has not been tested on Dharma (10.1) and likely will not work on Dharma.

== SpeedFan Setup ==
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about five kinds of log items: temperatures, fan speeds, voltages, fan speed percentages, and a catch all 'other.'

''Temperatures'' 
This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

''Fan Speeds'' 
This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

''Voltages'' 
This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

''Fan Speed Percentages'' 
This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

''Other'' 
If you want any other log item to show up on the SpeedFan display, you can label it ending with .other. These items will show up in the OTHER section exactly as stored in the log.

== Addon Options ==
After you install this plugin, go to the plugin settings. There are a few options to set.

=== General ===
'Primary Log File Title:'' (default empty) 
The name to display at the top of the information summary. Useful if you're showing the logs from more than one machine.

'Log File Location:'' (default empty) 
The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

''Use Compact Display'' 
When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

''Log Temperature Scale'' 
This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This add-on will not convert from Celcius to Farenheit (or vice versa).

''Window Update Interval (in seconds)'' 
The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

=== Additional Logs ===
"'Use Log File x:'' (default false) 
Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a title and location for the log.

=== Advanced ===
''Set Line Read Size:'' (default 256) 
You shouldn't ever really need to change this unless you're using an external script to generate a copy cat log file (see below). Changing this will change the amount of data read at one time by the add-on.

''Use External Script to Generate Log File:'' (default false) 
When enabled, this will call an external script to generate a log file. You need to have the add-on log file settings set to look in whatever directory is used to save the copy cat log file. Note that you can only run one external script, so if you have multiple non-SpeedFan machines that you want to display, the script will have to handle creating separate log files for all of them. This is useful if you want to display information from Linux or OSX machines. 
''' External Script: '''
 Path to the external script. 
''' Timeout (in secs): '''
 The maximum amount of time to wait for the external script to complete before aborting.

''Enable debug logging:'' (default false) 
When enabled, if you have Kodi logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Screenshots ==
<gallery>
File:Speedfan-full.jpg|Default Display
File:Speedfan-compact.jpg|Compact Display
</gallery>

== Tips and Tricks ==
=== Setting a Keyboard Shortcut ===
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1.
<keymap>
<global>
<keyboard>
<f1>RunAddon(script.speedfaninfo)</f1>
</keyboard>
</global>
</keymap>

=== Using a SpeedFan Log File on Network Storage ===
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

== Getting Help ==
Please see the thread in the XBMC forums for assistance.
<http://forum.kodi.tv/showthread.php?p=1014479>

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from [http://raw.github.com/pkscout/repository.beta.pkscout/gotham/repository.beta.pkscout-1.0.2.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]