Official Kodi Wiki - User contributions [en]

Add-on:WeatherScreensaver

2016-10-19T04:15:59Z

Rob webset: Blanked the page

Add-on:VideoScreensaver

2016-10-19T04:15:41Z

Rob webset: Blanked the page

Add-on:VideoExtras

2016-10-19T04:15:18Z

Rob webset: Blanked the page

Add-on:TvTunesScreensaver

2016-10-19T04:15:00Z

Rob webset: Blanked the page

Add-on:Suitability

2016-10-19T04:14:26Z

Rob webset: Blanked the page

Add-on:Sonos

2016-10-19T04:14:09Z

Rob webset: Blanked the page

Add-on:Sleep

2016-10-19T04:13:51Z

Rob webset: Blanked the page

Add-on:Recap

2016-10-19T04:13:33Z

Rob webset: Blanked the page

Add-on:RandomScreensaver

2016-10-19T04:13:17Z

Rob webset: Blanked the page

Add-on:PinSentry

2016-10-19T04:13:01Z

Rob webset: Blanked the page

Add-on:FilmWise

2016-10-19T04:12:39Z

Rob webset: Blanked the page

Add-on:EBooks

2016-10-19T04:12:22Z

Rob webset: Blanked the page

Add-on:AudioBooks

2016-10-19T04:12:05Z

Rob webset: Blanked the page

Add-on:AddonSync

2016-10-19T04:10:50Z

Rob webset: Blanked the page

Add-on:WeatherScreensaver

2016-10-01T14:28:58Z

Rob webset:

{{Addon
|Name=WeatherScreensaver
|provider-name=robwebset
|ID=screensaver.weather
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Weather Screensaver
|Description=Screensaver that displays the weather.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292709
|Website=
|Source=https://github.com/robwebset/screensaver.weather
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.weather/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The WeatherScreensaver is an addon that you can select as your screensaver and will display the weather screen in Kodi.

It will display whichever Weather add-on you have configured via the [[Weather|Kodi System Settings]].
 
 
== Settings ==
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Dim Level'''
::Allows the configuration of how much the screen should be dimmed when the screensaver starts
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables WeatherScreensaver debug logging into the Kodi log file
| [[File:WeatherScreensaver-Settings1.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* WeatherScreensaver debug from the WeatherScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the WeatherScreensaver Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=233520 WeatherScreensaver Forum]

Add-on:VideoScreensaver

2016-10-01T14:27:57Z

Rob webset:

{{Addon
|Name=VideoScreensaver
|provider-name=robwebset
|ID=screensaver.video
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Screensaver that plays a video file
|Description=Plays a video when the screensaver starts, this can be a custom video or one of the built in videos
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292708
|Website=
|Source=https://github.com/robwebset/screensaver.video
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.video/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
VideoScreensaver is a screensaver that will play a video file when the screensaver starts. It will support playing either a user specified video file, or one of several pre-defined video files.
 
 
== Forum And Issue Report Pages ==
If you have any questions, found an issue to report or would just like to know a little more you can take part in the forum discussions at:

[http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]
 
 
== Built-In Screensaver Videos ==
The following screensaver videos are supplied with the addon. They can be enabled, downloaded and previewed via the Video -> Addons -> VideoScreensaver menu. There is a context menu that allows you to preview and remove each screensaver video.

=== Apple TV Collection ===
==== China ====
{|
| [[File:VideoSecreensaver-appletv-China-D1.JPG|China - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D2.JPG|China - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D3.JPG|China - Day 3|none|thumb|250px]]
|}
==== Hawaii ====
{|
| [[File:VideoSecreensaver-appletv-Hawaii-D1.JPG|Hawaii - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D2.JPG|Hawaii - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D3.JPG|Hawaii - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-D4.JPG|Hawaii - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D5.JPG|Hawaii - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D6.JPG|Hawaii - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-N1.JPG|Hawaii - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-N2.JPG|Hawaii - Night 2|none|thumb|250px]]
|}
==== London ====
{|
| [[File:VideoSecreensaver-appletv-London-D1.JPG|London - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-D2.JPG|London - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N1.JPG|London - Night 2|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-London-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== New York ====
{|
| [[File:VideoSecreensaver-appletv-NewYork-D1.JPG|New York - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D2.JPG|New York - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D3.JPG|New York - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-NewYork-N1.JPG|London - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== San Francisco ====
{|
| [[File:VideoSecreensaver-appletv-SanFrancisco-D1.JPG|San Francisco - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D2.JPG|San Francisco - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D3.JPG|San Francisco - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-D4.JPG|San Francisco - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D5.JPG|San Francisco - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D6.JPG|San Francisco - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N1.JPG|San Francisco - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N2.JPG|San Francisco - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N3.JPG|San Francisco - Night 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N4.JPG|San Francisco - Night 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N5.JPG|San Francisco - Night 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N6.JPG|San Francisco - Night 6|none|thumb|250px]]
|}

=== Aquarium Collection ===
{|
| [[File:Aquarium001.png|Aquarium 1 - [846MB] - 400p|none|thumb|250px]]
| [[File:Aquarium002-720p.png|Aquarium 2 - [2.7GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium003.PNG|Aquarium 3 - [2.4GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Aquarium004.JPG|Aquarium 4 - [780MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium005.png|Aquarium 5 - [3.0GB] - 720p|none|thumb|250px]]
|}
=== Beach Collection ===
{|
| [[File:VideoScreensaver-Beach001.JPG|Beach 1 - [2.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach002.JPG|Beach 2 - [838MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach003.JPG|Beach 3 - [3.4GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Beach004.JPG|Beach 4 - [768MB] - 720p|none|thumb|250px]]
|}
=== Clock Collection ===
{|
| [[File:VideoScreensaver-Clock001.JPG|Clock 1 - [1.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Clock002.JPG|Clock 2 - [1.3GB] - 360p|none|thumb|250px]]
|}
=== Fireplace Collection ===
{|
| [[File:Fireplace001-720p.png|Fireplace 1 - [965MB] - 720p|none|thumb|250px]]
| [[File:Fireplace002.png|Fireplace 2 - [827MB] - 480p|none|thumb|182px]]
| [[File:Fireplace003-1080p.png|Fireplace 3 - [2.1GB] - 1080p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Fireplace004.PNG|Fireplace 4 - [2.7GB] - 720p|none|thumb|250px]]
|}
=== Miscellaneous Collection ===
{|
| [[File:VideoScreensaver-Christmas001.JPG|Christmas 1 - [777MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-JohnnyCastaway001.JPG|Johnny Castaway 1 - [75MB] - 480p|none|thumb|168px]]
| [[File:VideoScreensaver-Matrix001.JPG|Matrix 1 - [909MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Ocean001.JPG|Ocean 1 - [1.1GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-RetroSciFi001.JPG|Retro Sci-Fi 1 - [200MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-StarTrekTNG001.JPG|Star Trek TNG 1 - [54MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Watermill001.JPG|Watermill 1 - [549MB] - 1080p|none|thumb|250px]]
|}
=== Snow Collection ===
{|
| [[File:VideoScreensaver-Snow001.JPG|Snow 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow002.JPG|Snow 2 - [677MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow003.JPG|Snow 3 - [1.2GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Snow004.JPG|Snow 4 - [1.5GB] - 720p|none|thumb|250px]]
|}
=== Space Collection ===
{|
| [[File:VideoScreensaver-Space001.PNG|Space 1 - [970MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Space002.JPG|Space 2 - [563MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Space003.png|Space 3 - [2.2GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Space004.PNG|Space 4 - [1.2GB] - 720p|none|thumb|250px]]
|}
=== Waterfall Collection ===
{|
| [[File:VideoScreensaver-Waterfall001.JPG|Waterfall 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall002.JPG|Waterfall 2 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall003.JPG|Waterfall 3 - [2.4GB] - 720p|none|thumb|250px]]
|}
=== Woodland Collection ===
{|
| [[File:VideoScreensaver-Woodland001.JPG|Woodland 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Woodland002.JPG|Woodland 2 - [664MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Woodland003.JPG|Woodland 3 - [1.0GB] - 720p|none|thumb|250px]]
|}

 
 
== Built-In Overlay Images ==
The following overlay images are supplied with the addon.
{|
| [[File:PictureFrame1.png|Picture Frame 1|none|thumb|250px]]
| [[File:WindowFrame1.png|Window Frame 1|none|thumb|232px]]
| [[File:WindowFrame2.png|Window Frame 2|none|thumb|230px]]
|}
 
 
== Weather ==
VideoScreensaver can display the latest weather information in the top left hand corner of the screen if you wish. This feature makes use of the standard set of Weather addons available in the official Kodi repository, and can be configured via the VideoScreensaver settings.
 
 
== Clocks ==
VideoScreensaver has special handling for clock videos. This enables the correct current time to be displayed. This is assuming the video is either 12 hours (for an analog clock) or 24 hours (for a digial clock) and starts at midnight/12 o'clock. The built in "Clock" screensaver videos will handle this and show the correct time. If you have a custom video you wish to be shown as a clock, then this can be done my naming it with the name "clock" in the filename.
 
 
== Custom Collections ==
VideoScreensaver can handle the import of custom collections. This allows users to make their own collections of videos and make them available for others to share. The file format to import is as follows:

<source lang="xml">
<videoscreensaver>
<collection>Collection Name</collection>
<video>
<name>Video Name 1</name>
<filename>collection-filename1.mkv</filename>
<image>http://location/of/fame-image1.png</image>
<duration>3602</duration>
<primary>http://location/of/video2.mkv</primary>
</video>
<video>
<name>Video Name 2</name>
<filename>collection-filename2.mkv</filename>
<image>http://location/of/fame-image2.png</image>
<duration>2000</duration>
<primary>http://location/of/video1.mkv</primary>
</video>
</videoscreensaver>
</source>

As many "video" elements can be added as required for the collection. The filename should be unique from the other video files available, it is advised that the name of the collection is pre-pended to the filename. The "image" and duration elements are optional and the primary element contains the full URL to the source video file.

This file can then be imported via the Video -> Addons -> VideoScreensaver menu item.
 
 
== Schedule ==
It is possible to schedule which video is used at which time of day via the [[Add-on:VideoScreensaver#Schedule_2|Schedule Settings]]. The rules to apply for schedules can either be defined directly in the settings, or defined in an XML file which is then referenced from the settings.

<source lang="xml">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<schedule>
<rule id="1" start="10:24" end="14:37" day="monday", video="myvideo.mkv" overlay="myoverlay.png" />
<rule id="2" start="16:00" end="18:00" video="myvideo2.mkv" overlay="myoverlay2.png" />
</schedule>
</source>

The "day" attribute is optional and if set must be one of the values (monday, tuesday, wednesday, thursday, friday, saturday, sunday), the default is every day

If no video is specified in the schedule settings, then it will fall back to the default rules from the screensaver settings.
 
 
== Settings ==
This section details all the settings options for VideoScreensaver
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Use All Files In A Folder'''
::Will play a selection of video files from a directory instead of a single file
:'''Limit Session To Single Collection/Folder'''
::When the screensaver starts it will only play videos that are part of a single collection or folder on the file system.
:'''Include Nested Folders'''
::Will include video files from sub directories as well as the root directory
:'''Select Video Folder/File'''
::Prompts for the video files to use as a screensaver
:'''Repeat Type For Multiple Files'''
::Repeat All - Will loop through all the videos in the folder
::Repeat One - Will randomly select one video and keep repeating that video
:'''Overlay Image'''
::Allows for either a built in or user defined image to be overlayed on top of the video file
| [[File:Settings1.JPG|400px]]
|}

=== Configuration ===
{| border="0"
|- valign=top
|
:'''Show Time'''
::Displays the current time and data in the top right hand corner when the screensaver is active
:'''Show Weather'''
::Displays weather information in the top left hand corner
:'''- Select Weather Addon'''
::Selects the weather addon to display the weather details
:'''Start Video At Random Point'''
::When the video starts, will start at a random point into the duration of the video
:'''Prevent Screensaver Starting If Playing Media'''
::If there is media playing (i.e. Music or Video) and the screensaver is due to start, then if this is enabled, the screensaver will be prevented from starting.
:'''Change Volume When Screensaver Starts'''
::Allow the volume to be changed when the screensaver starts
:'''- Set Volume To'''
::The value to set the volume to when the screensaver starts
:'''- Use Audio Engine Suspend For 0 Volume'''
::If the screensaver volume is set to 0, then this option will suspend the Kodi Audio Engine rather than just reducing the volume to zero (This is useful if your system is set to passthrough audio)
:'''Dim Level'''
::How much to dim the screensaver video when it starts (0 = No Dim)
:'''Stop Screensaver Automatically'''
::Allow the screensaver to stop automatically after it has been playing for a given length of time. After stopping, the screensaver will start again after the default time of inactivity.
:'''- Stop Screensaver After (Minutes)'''
::Duration to let the screensaver play before stoping it
:'''- Shutdown After Automatic Stop'''
::After automatic shutdown has been triggered perform the default shutdown method set in the System -> Power Saving -> Shutdown Function
| [[File:Settings4.JPG|400px]]
|}

=== Startup ===
{| border="0"
|- valign=top
|
:'''Reset Volume On Startup'''
::Will reset the Kodi volume on startup of the system - this is useful if you always run your system at a set volume and use the TV or external audio system to change the volume (This way if the system crashes while playing a Video Screensaver, it will not leave the volume in an inconsistent state)
:'''- Set Volume On Startup To'''
::The value to set the Kodi volume to on startup
:'''Launch Screensaver On Startup'''
::When Kodi first starts the screensaver will start playing
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables VideoScreensaver debug logging into the Kodi log file
| [[File:VideoScreensaver-Settings5.JPG|400px]]
|}

=== Schedule ===
{| border="0"
|- valign=top
|
:'''Schedule Settings'''
::This can take the following values: Off (No scheduling enabled), Settings (Configure via the settings menu, see options below) and File (Load configuration from a file, see the [[Add-on:VideoScreensaver#Schedule|schedule section]])
:'''Number Of Schedule Rules'''
::The number of different schedule rules to be configured
:'''''Rule X'''''
::
:'''Start Time'''
::The time of day that this rule starts being used
:'''Stop Time'''
::The time of day that this rule stops being used
:'''Day'''
::The day of the week that this rule starts being used
:'''Select Video File'''
::The video file to play while this rule is active
:'''Overlay Image'''
::The overlay image to use while this rule is active
| [[File:VideoScreensaver-Settings6.JPG|400px]]
|}

 
 
== Detecting If VideoScreensaver Is Running ==
The way that VideoScreensaver has been implemented in order to play a video as a screensaver, it will not be recorded via the normal "xbmc.Monitor" onScreensaverActivated() or onScreensaverDeactivated() method. In fact when the screensaver starts you will get both an onScreensaverActivated() and onScreensaverDeactivated() message before the VideoScreensaver starts playing.
 
If you wanted to work out if VideoScreensaver is active from another script then you can check for the "VideoScreensaverRunning" property being set:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverRunning")</source>
This will return the value "true" if it is running.
 
It is also worth noting, that while the screensaver is starting up it will set the "VideoScreensaverStarting" property, that can be checked as follows:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverStarting")</source>
This will return the value "true" if it is currently starting.
 
 
== Known Issues ==
=== Auto-Shutdown Will Not Activate While VideoScreensaver Is Running ===
If you enable Kodi Auto-Shutdown options in Kodi System Settings they will not trigger while VideoScreensaver is active - this is because the video being played as part of the screensaver will make Kodi "active". The impact of this can be lessened by enabling "Stop Screensaver Automatically" and setting "Shutdown After Automatic Stop"
=== Changing Screensaver volume will not work when using audio Pass-Through ===
If you have Audio-Passthrough enabled in your audio settings then the ability to reduce the volume of the screensaver will not function. This is because you have removed Kodi's control of the audio. If you wish to set the volume to zero, then there is an option to "[[Add-on:VideoScreensaver#Configuration|Suspend The Audio Engine]]"
=== Using password protected profiles will prompt before screensaver starts ===
If you have a password protected profile and try and launch VideoScreensaver, then you will be prompted for the password '''''before''''' the screensaver starts instead of after. One alternative is to use [[Add-on:PinSentry|PinSentry]] instead of profiles.
 
 

== FAQ ==
=== Where are the built in videos stored after download? ===
The location of the video files will vary depending on the OS where Kodi is installed. The location can be retrieved by switching the "Video Selection" option in settings to "User Defined". This will then display the full path in the "Select Videos Folder/File" setting.
=== Can Kodi play music or radio while showing a screensaver video? ===
Unfortunately this is not possible. This is because Kodi can only play one media type at a time.
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* VideoScreensaver debug from the VideoScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the VideoScreensaver Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]

Add-on:VideoExtras

2016-10-01T14:27:09Z

Rob webset:

{{Addon
|Name=VideoExtras
|provider-name=robwebset
|ID=script.videoextras
|extension point=xbmc.python.script
|provides=
|Summary=Add Video Extras to your Movies and TV shows.
|Description=Provides a way to add Video Extras to your Video library. Look at the wiki for setup instructions.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292722
|Website=
|Source=https://github.com/robwebset/script.videoextras
|Email=
|broken=
|icon url=https://github.com/robwebset/script.videoextras/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
VideoExtras is an addon to allow you to store, list and play the "extras" for a given Movie or TV Series. (i.e. The extras that often come on DVD's or Blu-Rays)

:''Note:'' This Addon will allow you to view the Extras Videos you already own - it will NOT download extras for you from the internet. (Although there is an option to use YouTube and Vimeo to search and view for extra video content)
 
== Forum and Issue Report Pages ==
If you have any questions, found an issue to report or would just like to know a little more you can take part in the forum discussions at:

:[http://forum.kodi.tv/showthread.php?tid=214289 VideoExtras Forum]

 
== Quickstart Guide ==
This Quickstart guide is aimed at first time users of VideoExtras, who also have some freedom to re-arrange their video content to fit best with VideoExtras.
==== Install VideoExtras ====
VideoExtras is no longer in the official repo, you can install it from [[Repository:robwebset]]

==== Arranging Your Video Files ====
Although VideoExtras will support most structures (with various configuration changes), the easiest and best structure is as follows:

:''../<Movie Name>/<movie name>.ext''
:''../<Movie Name>/Extras/<extras name 1>.ext''
:''../<Movie Name>/Extras/<extras name 2>.ext''
:''...''
:where .ext is any video extension compatible with Kodi
More details of extras setup can be found in the [[Add-on:VideoExtras#File_Naming_Convention|File Naming Convention Section]]

==== Stopping The Extras Being Scanned Into Your Library ====
Now that you have copied your Extras files into the correct directories, you do not want them to be accidently picked up/scanned as a Movie or TV Series in their own right. To stop this you need to add "excludes" into the advancedsettings.xml file. This can be done for you by clicking on the [[Add-on:VideoExtras#Extras|"Update advancedsettings.xml File"]] operation on the first tab of the VideoExtras settings, or you could always do it yourself [[Add-on:VideoExtras#Kodi_File_Exclusions|manually]].
==== Scanning Media Into Your Library ====
Once you have updated the advancedsettings.xml file it should now be safe to perform any scans you wish to pull media into your library. At this point, the scanner should skip over any Extras files.
==== Viewing Your Extras ====
In order to view the Extras you have now stored with your Movies or TV Shows you will need one of the following 2 things:
* To update the default Confluence Skin, this can either be done [[Add-on:VideoExtras#Skin_Modifications|manually]] or by navigating to the Advanced tab of the VideoExtras settings and clicking on [[Add-on:VideoExtras#Advanced|"Update Confluence Skin"]].
* Use one of the non default [[Add-on:VideoExtras#Skins_With_Build_In_Support|skins that has built in support]] for VideoExtras
==== You Are Now Up And Running ====
That's it! You should now be able to navigate to your extras by either going to the Video Information Dialog for the given video, or by going via: ''[[Add-on:VideoExtras#Video_Extras_Browser|Videos -> Addons -> VideoExtras]]''
 
There are plenty more things you can do to improve your user experience such as adding [[Add-on:VideoExtras#Images:_Thumbnails.2C_Icons_and_Fanart|icons/fanart/thumbnails]] or giving detailed [[Add-on:VideoExtras#NFO_Files|titles or plots]]. However, this is a quickstart guide, and you should take a look at the rest of the wiki for those features.
 
 
== Using VideoExtras ==
Now that you have [[Add-on:VideoExtras#Quickstart_Guide|configured]] VideoExtras, you can start using it. If you are using Confluence with the supplied [[Add-on:VideoExtras#Viewing_Your_Extras|Confluence update]] then any Movies or TV Shows that have extras will be highlighted with an overlay image:
<center> [[File:VideoExtras-ThumbnailOverlay.JPG|VideoExtras Overlay|center|thumb|200px]]</center>
 Then if you navigate into the Video Information Screen you should see an Extras button available:
<center> [[File:VideoExtras-VideoInfoDialog.JPG|VideoExtras Button (Video Information Screen)|center|thumb|400px]]</center>
 Selecting this button will then result in seeing the list of extras available:
<center> [[File:VideoExtras-DetailedListScreen.JPG|VideoExtras - Extras list|center|thumb|400px]]</center>
 
 

== Video Extras Browser ==
The VideoExtras browser allows you to view all the Movies/Tv Shows/Music Videos that have extras, and then watch those extras. You can load the extras browser in the following ways:
# Via the [[Add-on:VideoExtras#Database|VideoExtras Settings screen]] "Database" -> "Browse Extras"
# From the Programs Menu -> VideoExtras
# Videos -> Addons -> VideoExtras
 
 
== Online Video Platforms Support ==
{| border="0"
|- valign=top
|
It you have the '''[[Add-on:YouTube|YouTube]]''' or '''[[Add-on:Vimeo|Vimeo]]''' addons installed and the options enabled in the [[Add-on:VideoExtras#Advanced|settings]] you can be forwarded directly to the videos that would result in a search of "<Movie Name> Extras", or by calling up the context menu there are options to search for other parameters.
|[[File:VideoExtras Youtube Support.png|VideoExtras Youtube Support|right|thumb|400px]]
[[File:VideoExtras Vimeo Support.png|VideoExtras Vimeo Support|right|thumb|400px]]
|}
 
 

== Settings ==
This section details all the settings options for VideoExtras
==== Extras ====
{| border="0"
|- valign=top
|
:'''Extras Directory Name'''
::The name of the sub directory that stores all the extras files
:'''Search Nested Directories'''
::If directories below the selected TV Show or Movie should be searched for more extras. This is useful if you select a given TV Show and have all your seasons for that show in separate directories under that show. This means that all extras will be displayed when viewed via the root TV Show, and only the seasons extras if selected from inside a given season.
:'''Enable Extras with File Tag'''
::Finds extras based on a "tag", listing anything containing that tag
:'''Extras File Name Tag'''
::If "Enable Extras with File Tag" was enabled, this gives the name to search for as the tag
:'''Use Detailed List Screen'''
::Displays a more advanced listing screen which displays resume points and a watched flag
:'''Window to show after exiting detailed list'''
::(If detailed list screen is enabled) - Which screen to go to after exiting the detailed list screen, options are: "Video Selection", "Information", "Home"
:'''Menu to show after playing an extra'''
::(If detailed list screen is disabled) - Which screen to go to after playing an extra, options are: "Extras", "Video Selection", "Information", "Home"
:'''''Operations'''''
::
:'''Update advancedsettings.xml File'''
::Will update (or create if it does not already exist) the advancedsettings.xml file so that your extras files are not accidently read into the library and incorrectly detected as actual Movies or TV Shows
| [[File:VideoExtras-Settings1.JPG|VideoExtras Settings - Extras tab|right|thumb|400px]]
|}

==== File System ====
{| border="0"
|- valign=top
|
:'''Use Custom Extras Location'''
::If extras are not stored with the Movies/TV Shows, this allows them to be stored in a different directory structure.
:'''Path'''
::The path that the extras are located in (Only if ''"Use Custom Extras Location"'' is enabled)
:'''Custom Movies Sub-Folder'''
::The name of the folder under the ''"Path"'' where Movie extras are stored (Note: a directory with the movie name will be located under this directory containing the extras for that movie)
:'''Custom TV Shows Sub-Folder'''
::The name of the folder under the ''"Path"'' where TV Shows extras are stored (Note: a directory with the TV Show name will be located under this directory containing the extras for that TV Show)
:'''Custom Music Video Sub-Folder'''
::The name of the folder under the ''"Path"'' where Music Video extras are stored (Note: a directory with the Music Video name will be located under this directory containing the extras for that Music Video)
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables VideoExtras debug logging into the Kodi log file
| [[File:VideoExtras-Settings2.JPG|VideoExtras Settings - File System tab|right|thumb|400px]]
|}

==== Database ====
{| border="0"
|- valign=top
|
:'''Enable Database Support'''
::Enables the use of the Extras stand-alone database, this enables the display and storing of data such as
:::* Which extras have been viewed already
:::* Resume playing an extra from the last stop point
:'''''Operations'''''
::
:'''Clean Database'''
::Clears the extras database (resets all play states for the extras) - Note: This does not do anything to the default Kodi database.
:'''Browse Extras'''
::Loads the Video Extras Browser plugin.
| [[File:VideoExtras-Settings3.JPG|VideoExtras Settings - Database tab|right|thumb|400px]]
|}

==== Advanced ====
{| border="0"
|- valign=top
|
:'''Enable YouTube Search Support'''
::Enabling this option will allow you to search for extra content for your video on YouTube (Requires the [[Add-on:YouTube|YouTube]] add-on)
:'''Enable Vimeo Search Support'''
::Enabling this option will allow you to search for extra content for your video on Vimeo (Requires the [[Add-on:Vimeo|Vimeo]] add-on)
:'''Force Extras Button Display'''
::Will always display the "Extras" button on the Video Information screen (Normal behaviour is to only show the button if there are extra's detected for the given video.
:'''Exclude Files Regular Expression'''
::Regular expression for files that will be deemed "Not to be extras" even if there are present in the Extras directory.
:'''Allow caching of extras on startup'''
::Used to cache the video extras available so that it can be used for icon overlays in some skins, if you do not wish to see icon overlays (or do not use a skin that supports them) then disable this option.
:'''Use Custom Images'''
::Allows you to change the images used in the skin to highlight if extras exist (Note: Changing these values will only be visable after a restart of Kodi)
:'''- Overlay Image'''
::(If Use Custom Images is enabled) The image that is drawn over the top of the thumbnail/cover
:'''- List Image'''
::(If Use Custom Images is enabled) The image that is used when adding to a list
:'''''Operations'''''
::
:'''Update Confluence Skin'''
::Will add VideoExtras support to the default confluence skin
| [[File:VideoExtras-Settings4.JPG|VideoExtras Settings - Advanced tab|right|thumb|400px]]
|}
 
 

== File Naming Convention ==
For your video extras files to be found they must follow a specific naming convention. VideoExtras currently supports extras videos from Movies, TV Shows and Music Videos. Here are the supported conventions:
 
=== Extras Folder ===
''(Recommended Method)''
 
If you put all of your movies in their own folder you can simply add an "Extras" sub folder and add all of your bonus content in that directory. (The name of this folder can be changed via the settings menu). The script will simply display the filename (without extension) in the UI. By default the list of videos will appear in alphabetical order.
 
=== Same Directory (Tagging) ===

If for some reason you don't want to create an "Extras" folder or you want to associate a bonus feature with a specific TV show episode there is an alternative naming convention which uses tagging. Simply use the same name as the file you want to associate the extra feature with and then append "-extras-" followed immediately (no spaces) by the name you want to displayed on the GUI for the extra, e.g. ''<main video name>-extras-<displayed name>.mkv'' . This default tag "-extras-" can be changed via the settings menu and MUST be turned on in order for the tagging to work.

This method will work whether your movies are in their own self-contained folder or all together in one folder only.

'''Example:''' So if you wanted to associate an Extended Pilot feature with the first episode of a tv show named "s1e1.mkv", you would create a file name "s1e1-extras-Extended Pilot.mkv". When the script displays this file in the UI it will strip out all the extra stuff and just show "Extended Pilot". To customize the displayed order here you can use NFO files or manual mode, just as in folder mode. Example of manual mode: "s1e1-extras-[#]Extended Pilot.mkv" where # is a number from 1 to 99.

'''Warning:''' if you don't append the <displayed name> after the tag -extras-, the file name will be displayed on the GUI instead, including the tag -extras-.
 

=== Remote Location ===

If you did not want your extras stored in the same directory structure as your Movies, TV Shows or Music Videos, then there is a settings option "Use Custom Extras Location" that can be set to point to a different location. The format of this location should have 3 directories at the top level: "Movies", "TvShows" and "MusicVideos". Under each of these should be directories (That match the name of the directories containing the Movies, TV Shows and Music Videos) containing the extras files.
 
e.g.

:Movies/Die Hard
:TvShows/Blake's 7
:TvShows/Blake's 7/Series 1
:TvShows/Blake's 7/Series 2

In this case, when clicking on the "TV Information" for the whole Blake's 7 Series you would see all files in "TvShows/Blake's 7" and the two sub-folders (if nested search is enabled), if viewing Episode Information for an episode in series 1 of Blake's 7 then you would only see the extras in "Blake's 7/Series 1"
 
 
Note: When using a custom path VideoExtras will first check for a directory name that matches the directory containing the actual TV Show or Movie. (As described above) If that is not found, then it will use the text title of the Movie or TV Show as the directory name to look for with the following replacements:
* : (Colon) removed from the name
* / or \\ (Forward or back slash) replaced with -
* . (dot) removed from the end of the name
* Non ascii characters are removed
 
 
With this method (based on where this root directory is), there may not be a need to add the "File Exclusions" section into [http://kodi.wiki/view/Advancedsettings.xml advanced settings].
 
 

== Kodi File Exclusions ==

Since these are video files sprinkled in among all of your other video files we need to tell the kodi scanner to ignore these files. If we don't then the scanner will try and match them up with one of the online sites and you probably won't be happy with the results. To do this we just need to add some new regular expressions to the [http://kodi.wiki/view/Advancedsettings.xml advanced settings]. This can be done for you by clicking on the [[Add-on:VideoExtras#Extras|"Update advancedsettings.xml File"]] operation on the first tab of the VideoExtras settings, or you can do this manually using some of the information below. It is recommended to add these settings and reboot Kodi for them to take effect BEFORE any library scan takes place, so the scanner doesn't try to parse them.

<source lang="xml">
<advancedsettings>
<video>
<excludefromscan action="append">
<regexp>-extras-</regexp>
<regexp>/Extras/</regexp>
<regexp>/extras/</regexp>
<regexp>[\\/]Extras[\\/]</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>-extras-</regexp>
<regexp>/Extras/</regexp>
<regexp>/extras/</regexp>
<regexp>[\\/]Extras[\\/]</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>
</video>
</advancedsettings>
</source>

''In this example the default name "Extras" has been used for the directory containing the extras, if you have changed this in the settings, then this name should also be changed to match.''

Obs.:

1) If you executed a library scan before the regexps have been put in place and found extra material accidentally scanned to your library, you can either remove/rename the extra material and conduct a 'clean library' under Kodi video settings or, delete the video sources and rescan them again after the regexps are operating properly.

2) Beware that if any of your sources contains the word 'extras' in it, e.g. a source named 'Extrasy' or 'Extrascent', nothing new that you put in it will be scanned to the library. This is because that source matches the exclude rule RegExp:'Extras'. To solve this either rename your source or change the default name 'extras', which VideoExtras operates with, to anything different.
 
 

== Images: Thumbnails, Icons and Fanart ==
=== Custom Artwork ===
In order to have thumbnails or custom fanart images displayed on your Extras listings (and player overlay) you can either reference them via an NFO file (see NFO section), or by having the image in the same directory as the extras file. Images referenced via NFO (locally or remotely) will have priority over any other. Thumbnail/icon images in the same directory as extras will be picked up in the following order:

* <filename>.tbn/png/jpg
* <filename>-poster.tbn/png/jpg
* <filename>-thumb.tbn/png/jpg
* poster.tbn/png/jpg (assigns same thumb to all those extras without one)
* folder.tbn/png/jpg (assings same thumb to all those extras without one)

For fanart, the images are picked up in the following order :
* <filename>-fanart.tbn/png/jpg
* fanart.tbn/png/jpg

obs: should you experience image caching persistency of old <filename>-poster/thumb.ext after replacing them by new ones at folder level, this is due to the way Kodi handles the caching of certain images. If you need an immediate solution and don't want to wait for Kodi to cache the new images, there is a script available that solves this issue at database level [http://Just%20to%20help%20with%20the%20cleansing%20of%20thumbs%20cached%20in%20XBMC%20to%20allow%20VideoExtras%20to%20display%20updated%20thumbs%20for%20your%20extras here] called Texture Cache Maintenance utility by MilhouseVH. There aren't cases reported of image caching persistency when using the naming convention <filename>.tbn/png/jpg

=== Default Artwork ===
* '''If no custom fanart:''' fanart is automatically inherited from the parent video file, if there's any.
* '''If no custom thumb (poster):''' default thumb is VideoExtras image icon and will only be displayed in the video overlay whilst playing the extra and not in the extras list.
 
 

== NFO Files ==

The recommended method to give a name or sort order to your "Extras" is to add an NFO for each extra file. This follows the standard Kodi method of having the same name as the file with the extension being replaced with ".nfo" (Sitting in the same directory as the original file). This nfo can take any of the followoing formats (These are in line with the default Kodi behaviour), additional data in these files will be ignored as it is not relevant for the extras file. (Note: The only mandatory element is the "title")

=== Movie NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<movie>
<title>Who knows</title>
<sorttitle>Who knows 1</sorttitle>
<plot>Something happens</plot>
<thumb>thumbnail.jpg</thumb>
<fanart>background.jpg</fanart>
</movie>
</source>

=== TV Show NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<tvshow>
<title>Who knows</title>
<sorttitle>Who knows 1</sorttitle>
<plot>Something happens</plot>
<thumb>http://forum.kodi.tv/images/xbmc/xbmc-lettering.png</thumb>
<fanart>http://forum.kodi.tv/images/xbmc/xbmc-lettering.png</fanart>
</tvshow>
</source>

=== TV Episode NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<episodedetails>
<title>Who knows</title>
<season>2</season>
<episode>1</episode>
<plot>Something happens</plot>
<thumb>C:\MyThumbs\Who.Knows.tbn</thumb>
<fanart>C:\MyFanart\myart.png</fanart>
</episodedetails>
</source>

=== Legacy Naming Format ===
The following are the legacy naming formats, they are supported in the short term only to allow easy migration from DVDExtras to VideoExtras. (If an NFO file is specified, the settings in that file will be used)
 
 
By default the list of videos will appear in alphabetical order. If you would like to specify a custom order just start the filename with brackets containing the text to sort on. For example you could create files "[0]Deleted Scenes.mkv", "[1]Bloopers.mkv", and "[2]Behind The Scenes.mkv". In this case instead of sorting on the name it will sort on the numbers. The bracket portion of the filename will not be displayed in the UI.
 
 
For extras tagged on a per file basis (rather and all in a sub-directory) the name will be taken from anything after the extras tag. So append "-extras-Display name here" will result in the name "Display name here". To customize the order here you can use the same format as the extras folder. Example: "s01e01-extras-[99]Extended Pilot.mkv"
 
 
== "videoextras.nfo" Files ==

If you do not have your video extras files stored in a standard location (as already described in the previous sections) then it is possible to create a file with the name "videoextras.nfo" in the same directory as your Movie or TV Show. This file must be of the following format:

<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<videoextras>
<file>..\..\Extras\Extras01.mkv</file>
<directory>C:\Kodi\Sample-Data\Movies\Extras</directory>
</videoextras>
</source>

You can have multiple "file" or "directory" entries in the "videoextras.nfo" file (or none of one type). The "file" will result in just the given file being listed in the extras. The "directory" will result in the entire contents of the directory being listed.
: ''Note: It is only logical to use this approach if you have each movie in it's own directory, as adding a videoextras.nfo file to a directory containing multiple movies will result in every movie in that directory picking up the extras defined in the videoextras.nfo file''
=== Common extras content for Movie Sets ===
The videoextras.nfo's capabilities are useful to assign common extras content to movies within a set (collection), thus we would have only one physical copy of the 'Extras' folder somewhere whilst each videoextras.nfo is pointing at it.
 
 
== Skin Information ==
=== Skins With Build In Support ===
The following skins (except Confluence, since it requires the hooks) have built-in support for Video Extras , so require no user skin modifications:
{| class="wikitable"
|-
! Skin !! Hook Support !! Detailed Screen Support !! Detailed Screen Skin Location !! Hooks Location
|-
| [[Add-on:Confluence|Confluence]] || <center>No</center>|| <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/DialogVideoInfo.xml DialogVideoInfo.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=145080 Confluence Modified] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=139712 Immersive] || <center>Yes</center> || <center>Yes</center> || <center>Immersive</center> || <center>[https://github.com/Sranshaft/skin.immersive/blob/master/720p/DialogVideoInfo.xml DialogVideoInfo.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=165481 Xperience1080++] || <center>Yes</center> || <center>Yes</center> || <center>Xperience1080++</center> || <center></center>
|-
| [[Add-on:Aeon_MQ_5|Aeon MQ 5]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Aeon_Nox|Aeon Nox 5]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/BigNoid/Aeon-Nox/blob/master/1080i/custom_1119_ExtrasDialog.xml custom_1119_ExtrasDialog.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=185290 Aeon Nox 4.1.9.x] || <center>Yes</center> || <center>Yes</center> || <center>Aeon Nox 4.1.9.x</center> || <center></center>
|-
| [[Add-on:Rapier|Rapier]] || <center>Yes</center> || <center>Yes</center> || <center>Rapier</center> || <center></center>
|-
| [http://forum.kodi.tv/showthread.php?tid=170954 Artic mk. ii] || <center>Yes</center> || <center>Yes</center> || <center>Artic</center> || <center></center>
|-
| [[Add-on:Metropolis| Metropolis]] ([http://forum.kodi.tv/showthread.php?tid=99317&pid=1726112#pid1726112 coming soon!]) || <center></center> || <center></center> || <center></center> || <center></center>
|-
| [[Add-on:XTV-SAF| xTV-SAF]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Transparency!|Transparency!]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/ronie/skin.transparency/blob/master/720p/custom_DialogExtras.xml custom_DialogExtras.xml]</center>
|-
| [[Add-on:Titan MediaBrowser| Titan MediaBrowser]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Black_Glass_Nova|Black Glass Nova 3.x]] || <center>Yes</center> || <center>Yes</center> || <center>Black Glass Nova</center> || <center>[https://github.com/Tgxcorporation/skin.blackglassnova/blob/master/1080i/DialogVideoInfo.xml DialogVideoInfo.xml]</center>
|-
|}
 
If your skin does not support the "Detailed List Screen", then you can either:
# Switch the "Detailed List Screen" off - reverting to the basic list dialog
# Convert the Window XML file in the addon and post a link to it in the forum.
# Use the default "Detailed List Screen" (May not fit in visually with the skin you are using)

Obs: due to a natural delay between the dates of release of possible latest features (and fixed issues too) and actual implementation of these updates in the supported skins, such as support for Music Videos, these skins may still require some manual changes as per [[Add-on:VideoExtras#Skin_Modifications|item 10.2]] in certain skins with built-in support.
 
 

=== Confluence Skin Support ===
A request has been made to the Kodi official repo to have VideoExtras included in the Confluence skin:
https://github.com/xbmc/xbmc/pull/4827
Unfortunately this did not get approved to go into the official repository.
 
 
Instead of this, there is an option that will update the Confluence skin for you in the settings. Just navigate to the [[Add-on:VideoExtras#Advanced|"Update Confluence Skin"]] operation in the VideoExtras settings.
 
 

;Note:
For this update to work, the directory containing the Confluence skin must have write permissions set. To get around this:
* ''' on Windows Vista, 7 and 8.x:''' right click Kodi and select "Run As administrator" and (if it prompts), click "Yes". Then navigate to the "Update Confluence Skin" operation in the VideoExtras settings. (If you select this option without doing a "run as administrator", it will say that it has updated the file successfully, but actually it won't.) - This is believed to only be an issue if you have "User Access Control" enabled 

As Confluence is the default skin, its directory is not user-modifiable on non-Windows systems. To get around this, it is recommended to copy the Confluence skin's directory from it's existing location to the standard location for user installed add-ons: 
* '''On Ubuntu Linux:''' the operation would be to copy the directory "/usr/share/kodi/addons/skin.confluence/" to "/home/<username>/.kodi/addons/". 
Upon restarting Kodi, you should now be able to use the "Update Confluence Skin" feature. 
 

=== Skin Modifications ===
A skin modification is required in order to see the extras button in the UI and enjoy all the features. This is a fairly simple process but will depend on your selected skin. The file that needs modified is DialogVideoInfo.xml. The following code is needed for the default confluence skin, which would result in the new, [https://dl.dropboxusercontent.com/u/56161346/XBMC/VideoExtras/DialogVideoInfo%20062015/DialogVideoInfo.xml modified DialogVideoInfo.xml] (as per June 2015) with support for VideoExtras:

Add to the top of the file (after <window>):
<source lang="xml">
<onload condition="System.HasAddon(script.videoextras)">
RunScript(script.videoextras,check,"$INFO[ListItem.FilenameAndPath]")</onload>
</source>

Add to near the foot of the file after the last control statement:

<source lang="xml">
<control type="button" id="105">
<description>Extras</description>
<include>ButtonInfoDialogsCommonValues</include>
<label>Extras</label>
<onclick>RunScript(script.videoextras,display,"$INFO[ListItem.FilenameAndPath]")</onclick>
<visible>System.HasAddon(script.videoextras)
+ [Container.Content(movies) | Container.Content(episodes) | Container.Content(TVShows)
| Container.Content(musicvideos)]
+ IsEmpty(Window(movieinformation).Property("HideVideoExtrasButton"))</visible>
</control>
</source>
You should be able to use something similar for other skins.

==== Location of XML ====
The DialogVideoInfo.xml's location listed by skin:
;Confluence
* '''Ubuntu Linux:''' /home/<username>/.kodi/addons/skin.confluence/720p/
* '''Ubuntu Linux (alternative):''': /usr/share/kodi/addons/skin.confluence/720p/
* '''OS X:''' /Applications/Kodi.app/Contents/Resources/Kodi/addons/skin.confluence/720p
* '''Windows 7/8.1:''' Program Files (x86)\Kodi\addons\skin.confluence\720p
;Aeon Nox 4
* '''Ubuntu Linux:''' /home/<username>/.kodi/addons/skin.aeon.nox/1080i/
* '''Windows 7/8.1:''' Program Files (x86)\Kodi\addons\skin.aeon.nox\1080i\

Obs.: Remember to create a backup of any file before altering it i.e. DialogVideoInfo.xml.old.

=== Icon Overlay on Video List Screen (Advanced Skinners Only) ===
If you are a skinner and wish to add support for some form of indication that a Movie/TV Show has extras, there is a way, it is not perfect but should get the overlays working. The first part is that you need to have "Allow caching of extras on startup" enabled in the VideoExtras settings. You then need the following in your skin:

<source lang="xml">
<control type="image">
<posx>950</posx>
<posy>14</posy>
<width>16</width>
<height>16</height>
<texture fallback="blank.png">$INFO[ListItem.DBID,special://profile/addon_data/script.videoextras/movies/,.png]</texture>
<visible>System.HasAddon(script.videoextras) + Window.IsVisible(Videos) + Container.Content(Movies)</visible>
</control>
</source>

This example would possibly be added to the confluence skin at line 554 to add an icon to movies on the "biglist" screen. There are 3 different values that can be used:

{| class="wikitable"
|-
| movies || Container.Content(Movies)
|-
| tvshows|| Container.Content(TVShows)
|-
| musicvideos|| Container.Content(MusicVideos)
|}

Where the first column supplies the value used in the <texture> element, and the second for the <visible> element.
 
 
There is a default image that is used to represent the existance of Video Extras, but this can be overridden by the skin by putting a file called "videoextras_overlay.png" in the skins "media" directory, or by updating the [[Add-on:VideoExtras#Advanced|VideoExtras settings]].
 
 
IMPORTANT: This is for advanced skinners only, please only post on the forum if you '''own the skin you are trying to update''' - this is because it will require lots of changes to patch an existing skin, and this feature is only intended to support skins that will support VideoExtras "Out Of The Box".
 
 

=== Request To Skinners (Detailed List Screen) ===
VideoExtras uses a custom window to show the extras, I have written the Window XML files for Confluence. With the large array of different skins available it is not possible to write versions for every skin. If you would be willing to support Video Extras I would really like to include a skin specific Window XML file for your skin and would be greatful for any contribution.
 
The files are very small, so hopefully will not take long to convert for your skin.
 
 

== Known Issues ==
=== Cast List In Summary Screen Not Populated ===
There is a known issue that when you return from the detailed list screen that shows the extras back to the summary screen, the Cast section is not populated, the following was posted for this, but there is no solution:
http://forum.kodi.tv/showthread.php?tid=173502
 
=== Back Navigation For YouTube Incorrect ===
The Videos -> Addon -> VideoExtras Youtube route seems to work how you would expect, however the Video Information -> Extras route gives the option, but when you exit the YouTube list of files it will return to the "Home" screen and not back to the Extras screen.
 
 

== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* VideoExtras debug from the VideoExtras addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 

== Donations ==
If you have found VideoExtras useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=214289 VideoExtras Forum]

Add-on:TvTunesScreensaver

2016-10-01T14:26:27Z

Rob webset:

{{Addon
|Name=TvTunesScreensaver
|provider-name=robwebset
|ID=screensaver.tvtunes
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Plays your themes while showing images for each TV Show or Movie
|Description=The TvTunes Screensaver makes use of the themes configured in your library to use them as a screensaver.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292714
|Website=
|Source=https://github.com/robwebset/screensaver.tvtunes
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.tvtunes/raw/master/icon.png}}

== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
TvTunes Screensaver is a versatile screensaver that can be used to:
* View artwork for TV Shows and Movies
* Play TV or Movie themes while showing artwork
* Show a set of different images in various display formats

It was originally designed to work well with [[Add-on:TvTunes|TvTunes]] but can also be used to just display images if you would rather theme audio was not played in the background.

 

== Screensaver Formats ==
The following formats are available within TvTunes Screensaver
{| border="0"
|- valign=top
|'''Slider''' - This will slide the images into view from either the left, right, top or bottom of the screen.
| [[File:TvTunes-Screensaver-Slider.JPG|400px]]
|- valign=top
|'''Crossfade''' - will fade one image in over the top of the next image
| [[File:TvTunes-Screensaver-Crossfade.JPG|400px]]
|- valign=top
|'''TableDrop''' - will drop each image onto the screen at random overlaps and angles
| [[File:TvTunes-Screensaver-Tabledrop.JPG|400px]]
|- valign=top
|'''StarWars''' - will show a stream of images similar to the Star Wars intro sequence
| [[File:TvTunes-Screensaver-Starwars.JPG|400px]]
|- valign=top
|'''RandomZoomIn''' - will randomly zoom in to each image in turn
| [[File:TvTunes-Screensaver-RandomZoomIn.JPG|400px]]
|- valign=top
|'''AppleTVLike''' - like the Apple TV Screensaver, will scroll a mix of images up from the bottom of the screen
| [[File:TvTunes-Screensaver-AppleTVLike.JPG|400px]]
|- valign=top
|'''GridSwitch''' - will show several images at the same time in a grid format
| [[File:TvTunes-Screensaver-GridSwitch.JPG|400px]]
|- valign=top
|'''Random''' - will randomly show one of the above screensaver formats
|
|}

There are several options for each of the different screen saver that control the speed images move or how frequently the image changes.
 

== Settings ==
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Screensaver'''
::Select which format of screensaver to use
:'''Image Source'''
::Select if the Movie, TV Show or custom path is used to show images for the screensaver
:'''- Image Type'''
::Which type of images to use for the screensaver i.e. Fanart, Thumbnails, Cast
| [[File:TvTunesScreensaver-Settings1.JPG|400px]]
|}
 
=== Themes ===
{| border="0"
|- valign=top
|
:'''Play Themes During Screensaver'''
::If a theme is available, play it while showing the images for the given Movie or TV Show
:'''- Only Show Images When A Theme Exists'''
::Only add a Movie or TV Show to the screensaver if it has a theme
:'''- Repeat Rules'''
::When to move to the next set of images for a different Movie or TV Show
:'''Include Artwork Downloader Images'''
::If the [[Add-on:Artwork Downloader|Artwork Downloader Addon]] is installed and has stored images with the Movie or TV Show, also show those images
:'''Dim Level'''
::If to dim the screen when the screensaver runs
| [[File:TvTunesScreensaver-Settings2.JPG|400px]]
|}
 
=== File System ===
{| border="0"
|- valign=top
|
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables TvTunesScreensaver debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
| [[File:TvTunesScreensaver-Settings3.JPG|400px]]
|}

 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* TvTunesScreensaver debug from the TvTunesScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 

== Donations ==
If you have found TvTunesScreensaver useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=272157 TvTunesScreensaver Forum]

Add-on:Suitability

2016-10-01T14:24:45Z

Rob webset:

{{Addon
|Name=Suitability
|provider-name=robwebset
|ID=script.suitability
|extension point=xbmc.python.script
|provides=
|Summary=Check if a movie or TV show is family friendly
|Description=Supplies details for how suitable a movie or TV show is for children.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292724
|Website=
|Source=https://github.com/robwebset/script.suitability
|Email=
|broken=
|icon url=https://github.com/robwebset/script.suitability/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The Suitability addon allows you to get an "overview" of the content of a movie, things like the sex/violence/language content, so you can make a judgement as to the suitability for your children. (Or your grandmother!)

The addon uses the following sites to retrieve information:
* [http://www.kids-in-mind.com Kids-In-Mind]
* [http://www.commonsensemedia.org Common Sense Media]
* [http://www.dove.org The Dove Foundation]
* [http://www.movieguide.org Movie Guide]

Suitability allows you to view a summary star rating of the movie content and then drill down to view the detailed text description of the movies content. It is available via the movie context menu or launched from the Kodi Programs section (where you will be prompted for a movie name to search for) or there is also an option in settings to add it to the Confluence Movie Information Dialog.
 
 
== Summary Display ==
The summary screen shows a star rating, the categories for each provider will differ as each source site is slightly different.
 
<center>[[File:Suitability-Summary1.JPG|300px]]</center>
 
The details button will show a text description of the films content, while the right hand button will allow you to toggle through all the available providers.
 
 
== Details Display ==
The details screen will describe the content of the film to give you a better understanding of the rating available via the summary screen.
 
<center>[[File:Suitability-Details1.JPG|600px]]</center>
 
The summary button will switch to the summary view for the given provider, while the right hand button will allow you to toggle through all the available providers.
 
 
== Settings ==
This section details all the settings options for Suitability
=== Suitability ===
{| border="0"
|- valign=top
|
:'''Default Source'''
::The first site to display the movie ratings from
:'''Default View'''
::If the initial screen to display is the summary or the detailed view
:'''Show Suitability On Context Menu (Restart Required)'''
::If a link to Suitability should be added to the Movie context menu
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables Suitability debug logging into the Kodi log file
:'''''Operations'''''
::
:'''Update Confluence Skin'''
::Adds a Suitability button to the Movie Information dialog in confluence.                
| [[File:Suitability-Settings1.JPG|400px]]
|}

=== Providers ===
{| border="0"
|- valign=top
|
:'''Common Sense Media'''
::Enable, disable and set the order for the supplier to be used
:'''Kids In Mind'''
::Enable, disable and set the order for the supplier to be used
:'''Dove Foundation'''
::Enable, disable and set the order for the supplier to be used
:'''Movie Guide (.org)'''
::Enable, disable and set the order for the supplier to be used                        
| [[File:Suitability-Settings2.JPG|400px]]
|}

 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* Suitability debug from the Suitability addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the Suitability Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=255113 Suitability Forum]

Add-on:Sonos

2016-10-01T14:23:55Z

Rob webset:

{{Addon
|Name=Sonos
|provider-name=robwebset
|ID=script.sonos
|extension point=xbmc.python.script
|provides=
|Summary=Sonos Controller
|Description=Supports simple Sonos Controls and notifications from Kodi. Look at the wiki for more details.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292713
|Website=
|Source=https://github.com/robwebset/script.sonos
|Email=
|broken=
|icon url=https://github.com/robwebset/script.sonos/raw/master/icon.png}}

== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The Kodi Sonos addon allows you to control your Sonos system from Kodi. It is implemented (for those who like to know) as a script, plugin and service. In addition to controlling your Sonos system it also allows you to be notified (via a popup) whenever a new track starts and link the audio volume control of Kodi to the audio volume of the Sonos system. There is also a full "Artist View" controller that will display images and descriptions of the artists currently playing on the Sonos System.
 
 
== Sonos Controller ==
The Sonos Controller can be launched in two different ways:
* From Programs -> Sonos
* From the Browser Menu (See below)

There are two different formats of controller. They both offer the same expected features:

* Display Artist Name
* Display Track Name
* Display Album Name
* Display Album Artwork
* Display Track Duration and Current Position
* Volume Display and Operations (Mute, Change Volume)
* Control Operations (Play, Pause, Stop, Next, Previous, Seek)
* Adjustment Operations (Loop, Random, Crossfade)

The standard controller supports just this set of features, and the data is read from the source files that the Sonos system is playing or streaming.
<center>[[File:Controller-Default.JPG|300px]]</center>

The advanced controllers will also support additional information which is retrieved from the internet. These are available when you enable the option "Display Artist Information" in the settings. These include:

{|
|-
| [[File:Controller-Artist-1.JPG|400px]]
| Controller, Slideshow, Biography, Albums by the same artist
|-
| [[File:Controller-Artist-2.JPG|400px]]
| Controller, Slideshow
|-
| [[File:Controller-Artist-3.JPG|400px]]
| Slideshow Only (No Controller)
''Note:'' This screen works well if you also have Notifications enabled (with "Do Not Display Notification If Controller Is Showing" unset) so that you also get notified what the artist and title of each track that starts is.
|-
| [[File:Sonos-Controller-Artist-4.JPG|400px]]
| Controller, Slideshow, Lyrics
''Note:'' This screen will only show the lyrics when used with Helix (v14) or later (Kodi needs to be restarted after the initial install of the [[Add-on:CU LRC Lyrics|CU LRC Lyrics]] addon)
|}
 

== Notifications ==
The notifications option (if enabled) will display a small popup whenever the track being played by the Sonos system changes. This popup will display the Track Title, Artist and Album Artwork.
<center>
{|
|- align=center
| [[File:Notification-Sonos.JPG|300px]] || [[File:Notification-XBMC.JPG|300px]]
|- align=center
| Sonos Notification Format || Kodi Notification Format
|}
</center>
 
 
== Sonos Browser ==
The Sonos Browser can be launched from "Music -> Add-ons -> Sonos", this will give the folowing options:
 
{| border="0"
|- valign=top
|
* '''Launch Sonos Controller''' - Start the Sonos Controller
* '''Music Library''' - List the locally stored tracks on your server
* '''Radio Stations''' - List the radio stations saved in "My Radio Stations"
* '''Sonos Playlists''' - List your Sonos playlists
* '''Queue''' - List the currently queued tracks to play on the Sonos system
* '''Speech''' - Get your Sonos system to talk
| [[File:Browser-1.JPG|400px]]
 
|- valign=top
|
By right clicking on the Music Library to get the context menu, you will then have the option of "Update The Music Library" so that the current tracks are synchronised with the Sonos system.
 
The Music Library section can be navigated to view and select tracks to play or add to the current queue. You can navigate directly down to a given track and select it. This will cause that track to be played immediately on the Sonos System.
| [[File:Browser-2.JPG|400px]]
 
|- valign=top
|
If you were to right click to get the context menu on a track, album or artist you will get a menu that will enable you to
* '''Play Now''' - Plays the given selection
* '''Add To Queue''' - Adds the given selection to the end of the current queue
* '''Replace Queue''' - Clears the current queue and adds the given selection to the queue
| [[File:Browser-3.JPG|400px]]
 
|- valign=top
|
If you were to right click to get the context menu when viewing the queue you will be able to
* '''Play Track''' - Plays the given selection
* '''Remove Track''' - Removes the given track from the current queue
* '''Clear Queue''' - Removes all items from the queue
| [[File:Browser-4.JPG|400px]]
 
|- valign=top
|
The Speech section will allow you to request that your Sonos system read out the messages you request.
* '''Enter Speech Text To Play...''' - Specify some text to be spoken immediately
* '''Enter Speech Text To Save...''' - Specify some text that can be saved and reused in future
* After a space, the remainder of the screen will show any saved text in alphabetical order.
When specifying text to be spoken there are some key words that will be substituted
* '''%greet''' - A greeting based on the time of day (Good Morning, Good Afternoon, Good Evening)
* '''%day''' - The current day (e.g. Monday, Tuesday ...)
* '''%date''' - The current date (e.g. 3rd September)
* '''%time''' - The current time (e.g. 19:14)
You can delete any saved messages by calling up the context menu and selecting "Remove Saved Text"
| [[File:Browser-5.JPG|400px]]
|}
 
 
== Settings ==
The Sonos addon does not require any other programs installed. It will communicate directly with your Sonos speaker to perform operations.
 
The following settings are available:
=== Speaker ===
{| border="0"
|- valign=top
|
:'''Search For Sonos Speakers...'''
::Attempt to auto detect any Sonos speakers on the network
:'''IP Address'''
::The IP Address of your speaker
:'''Zone Name (Optional)'''
::The Zone Name which the Speaker belongs to (This will be auto populated if a search is done)
:'''- Automatically Update IP Address On Startup'''
::This will result in the Sonos Addon searching for Speakers in the given Zone, and setting their IP address automatically (Useful if the IP addresses of your speakers change and you want Kodi to auto-detect them each time the system starts)
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables Sonos debug logging into the Kodi log file
| [[File:Settings-Speaker.JPG|400px]]
|}

=== Controller ===
{| border="0"
|- valign=top
|
:'''Display Artist Information'''
::Displays images and artist information while items are playing when the controller is selected (using [[Add-on:Artist Slideshow|ArtistSlideshow]] and [[Add-on:CU LRC Lyrics|CU LRC Lyrics]])
:'''- Layout'''
::A selection of various layouts of the screen when the Artist Information is shown
:'''- Make Artist Slideshow Image Full Screen'''
::When enabled will display the artist slideshow image full screen instead of in a frame
:'''- Hide Sonos Logo'''
::Stops the Sonos logo being displayed on the controller screen
:'''Controller Refresh Interval (Seconds)'''
::Sets how often the controller screen should refresh and check for changes of track being played
:'''Avoid Duplicate Key Presses (Seconds)'''
::When using a remote control and holding down a button (such as volume) it will send many requests to increase the volume - this setting allows you to ensure only one press is detected every X seconds. (This prevents flooding the Sonos system with requests).
:'''Volume Change Increments'''
::When the volume increase/decrease button, how much to change the volume by (default is 3%)
| [[File:Settings-Controller.JPG|400px]]
|}

=== Automation ===
{| border="0"
|- valign=top
|
:'''Link Kodi Volume With Sonos Speaker (Requires Restart)'''
::Whenever you change the Kodi volume, the Sonos volume will be set to the same percentage value (Note: Changes in the Sonos Volume are not reflected in Kodi - this is one way only)
:'''Redirect Volume Controls To Sonos (Requires Restart)'''
::Change the default behaviour for Kodi volume and mute operations from the keyboard or remote control to send them to Sonos instead.
:'''Switch Sonos To Line-In On Kodi Startup (Requires Restart)'''
::When Kodi starts, it will send a message to the Sonos speaker to switch it to line-in
:'''Switch Sonos To Line-In On Media Start (Requires Restart)'''
::When Kodi starts playing any form of media, it will send a message to the Sonos speaker to switch it to line-in
:'''Automatically Pause Sonos When Kodi Plays Media (Restart Required)'''
::If you start playing any form of media in Kodi, then a pause command will be sent to the Sonos system to ensure it stops playing
:'''- Automatically Resume Sonos (Seconds) [0 = Off]'''
::If The Sonos Addon paused the Sonos system because of Kodi playing media, how many seconds to wait before resuming Sonos playback
:'''Launch Controller On Kodi Startup'''
::Will launch the Sonos Controller automatically when Kodi starts
:'''Status Checks Per Second (Restart Required)'''
::Will increase the number of times a second the addon will check for status changes such as volume changes. Use this setting with care, as it will increase the processing power used on your machine.
| [[File:Settings-Automation.JPG|400px]]
|}

=== Plugin ===
{| border="0"
|- valign=top
|
:'''Batch Size'''
::The number of records to retrieve from Sonos in one chunk, looping to get all the records in this batch size. (Default = 100)
:'''Maximum Entries In Displayed Lists'''
::Limits the number of entries that are retrieved from the Sonos system when generating lists (e.g. The Queue). (Default = 1000)
:'''Use Skin Icons Instead Of Sonos Icons'''
::Allows the change of the plugin section to use the default icons suplied by skin instead of the Sonos icons
| [[File:Settings-Plugin.JPG|400px]]
|}

=== Notifications ===
{| border="0"
|- valign=top
|
:'''Enable Notifications (Restart Required)'''
::Enables or disables the popup notification of track change
:'''Display Notification For (Seconds)'''
::How long to display the track information on the screen
:'''Notification Check Frequency (Seconds)'''
::The frequency in which the service check which track is playing on the Sonos speaker
:'''Do Not Display Notification If Video Is Playing'''
::Prevents the popup notification displaying while a video file is playing
:'''Do Not Display Notification If Controller Is Showing'''
::In most cases this would be "true" (default) so that the popup does not display the notification while the controller is showing. However when using certain Artist Slideshow supported controller sceens, there is no display of the current artist name or track, this allos the notification to show while these screens are being used.
:'''Use Default Kodi Notification Dialog'''
::Uses the default Kodi popup dialog instead of the custom Sonos one
 
| [[File:Settings-Notifications.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* Sonos debug from the Sonos addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the Sonos Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=183020 Sonos Forum]

Add-on:Sleep

2016-10-01T14:23:09Z

Rob webset:

{{Addon
|Name=Sleep
|provider-name=robwebset
|ID=script.sleep
|extension point=xbmc.python.script
|provides=
|Summary=A TV like sleep timer
|Description=Add improved sleep behaviour to your Kodi system, allowing the system to shut down after a certain amount of time.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292726
|Website=
|Source=https://github.com/robwebset/script.sleep
|Email=
|broken=
|icon url=https://github.com/robwebset/script.sleep/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The Sleep addon provides support to automatically shutdown/suspend Kodi in a similar manner to the traditional TV Sleep Timers. If has many additional features and can be launch by any of the following methods:
* From the "Programs" area of Kodi
* As a screensaver
* Via a remote control or keyboard button (Configurable which button)
 
 
== The Sleep Dialog ==
<center>[[File:Sleep-Dialog.JPG|Sleep Timer Dialog|none|thumb|300px]]</center>
The dialog to control the Sleep Addon is designed to be as simple as possible. When the dialog first opens it will show the sleep timer as disabled, the timer can be extended, by default in ten minute intervals (configurable in the settings), by performing either of the following actions:
* Pressing the configured remote or keyboard button again (For each press it will extend the timer)
* Selecting the "+10" button on the dialog
If the sleep timer is currently set if can be reduced or cancelled by selecting either the "-10" button or the cancel button.
 
The sleep timer will also allow you to have Kodi shutdown after a video finishes playing. If there is a video playing when the sleep timer is set, it will shutdown after it completes. If there is not currently a video playing it will shutdown after the next played video completes. (Note: The Sleep timer will only shutdown the system if the video completes playing, if the video is stopped manually, then sleep timer will not shutdown - this is by design).
 
 
== Shutdown Warnings ==
When the Sleep timer is about to expire and shutdown the system it will again display the shutdown dialog with a progress bar showing how long it is until the shutdown will commence. While this dialog is displayed the timer can be:
* Extended (In the same manner as it was originally set)
* Cancelled (By selecting the cancel button)
* Left to expire and shutdown Kodi.
In addition to the shutdown dialog, it is possible to configure the Sleep Addon to display a notification of how long is left before shutdown will be performed (for example 30, 20, 10 minutes left).
 
 
== Remote Control or Keyboard Setup ==
It is possible to configure the Sleep Addon to response to a keyboard or remote control button press. This can be done by either selecting one of the predefined options in the Addon settings or have the Sleep Addon auto detect a key/button press and then use that to allow you to control the Sleep Addon. This can be configured from the Sleep Addon Settings.
 
 
== Sleep After Idle Period ==
If you with to have the Sleep Addon detect when the system has been idle for a set period of time, and then start the notification for shutdown, this can be done by selecting Sleep as your chosen screensaver, then when the screensaver triggers, it will display the Sleep shutdown dialog.
 
 
== Settings ==
=== Sleep ===
{| border="0"
|- valign=top
|
:'''Sleep Interval Length (Minutes)'''
::How much to increase or decrease the time when the +/- button is pressed of the configured sleep key
:'''Warning Length (Seconds)'''
::How long to display the warning dialog before shutdown
:'''Maximum Sleep Time (Minutes)'''
::The maximum time that the timer can be set for, after that time the timer will loop from zero again
:'''Pause Video When Displaying Timer Dialog'''
::If the timer dialog is displayed while a video is playing, should the video be paused?
:'''Shutdown Earlier If Screensaver Starts'''
::If the timer has been set, and the screensaver starts, trigger shutdown
:'''Display Sleep Reminders'''
::If reminders for how much time remains before shutdown are required
:'''- Start Showing Reminders For Last (Minutes)'''
::If reminders are set, when they should start being displayed
:'''- Frequency To Display Reminder (Minutes)'''
::If reminders are set, how often they should be displayed
:'''Dim Screen'''
::If the timer has been set, dim the screen so that it is darker - aka "Night Time Mode"
| [[File:Sleep-Settings1.JPG|400px]]
|}
=== Controls ===
{| border="0"
|- valign=top
|
:'''Button Selection'''
::Choose which button to map to the Sleep command. Either None, Mute, Astrisk (*) or Custom
:'''Automatic Button Detection'''
::Allows a button to be automatically detected by the Sleep Addon and used to control it
:'''Manual Detection'''
::For advanced users only - allows the manual codes to be entered
| [[File:Sleep-Settings2.JPG|400px]]
|}
=== Advanced ===
{| border="0"
|- valign=top
|
:'''Shutdown Behaviour'''
::Allows the operation that is performed when the timer expires to be change.
::''Default Shutdown'' - Performs the shutdown set in the Kodi System Settings
::''HTTP Request'' - Makes a call to the given URL
::''Screensaver'' - Stats the Kodi screensaver
::''Scripts'' - Runs the given python script
:'''''Setup'''''
::
:'''Debugging'''
::Enables Sleep debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
| [[File:Sleep-Settings3.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* Sleep Addon debug from the Sleep addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the Sleep Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=261959 Sleep Forum]

Add-on:Recap

2016-10-01T14:22:17Z

Rob webset:

{{Addon
|Name=Recap
|provider-name=robwebset
|ID=script.recap
|extension point=xbmc.python.script
|provides=
|Summary=Recap
|Description=Shows a summary of what has happened in a TV Episode, including images.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292728
|Website=
|Source=https://github.com/robwebset/script.recap
|Email=
|broken=
|icon url=https://github.com/robwebset/script.recap/raw/master/icon.png}}



[http://recapguide.com Supported By:] <img src=http://recapguide.com/static/img/logo/recap-guide-logo-on-light.png>
 
 
== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The Recap addon is an addon that allows you to "Catch Up" with what has happened in a given TV Episode. It uses the site [http://www.recapguide.com www.recapguide.com] and will display a small description and 50 images to jog your memory for what happened.
 
 
This is useful if you watch TV an entire season/series and then watch the episodes back-to-back. This means it can be almost a year between watching each season/series, and this addon can help remind you what has happened.
 
 
It can be run from the Programs section, or call up the context menu on a TV Show/Season/Episode and you can get the recap on that show (For episodes, there is also an option to get a recap for the previous episode).
 
 
== Recap Information ==
The following image is an example of the recap information provided:
<center>
[[File:Recap-Screen1.JPG|400px]]
</center>
 
 
== Settings ==
=== Recap ===
{| border="0"
|- valign=top
|
:'''Show Recap On Context Menu (Restart Required)'''
::Shows the recap option on the context menu for TV Show items
:'''Show Recap Previous On Context Menu (Restart Required)'''
::Shows the recap previous episode option on the context menu for TV Show episodes
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables Recap debug logging into the Kodi log file
| [[File:Recap-Settings1.JPG|400px]]
|}
 
 
=== Behaviour ===
{| border="0"
|- valign=top
|
:'''Show Automatically If Only One Match'''
::If there is only one TV Show that matches the title searched for then do not prompt for show selection
:'''Show Image Captions'''
::Show the captions over the images for the TV Show screenshots
:'''Loop Slideshow'''
::When navigating the slideshow, when the last image is reached, show the first image as the next image
:'''Automatically Progress Slideshow'''
::Automatically flick through the images for the TV Show without the need to click the next button
:'''Enable Notifications For Requests'''
::Allows an email address to be entered that will be sent with any requests to add new TV Shows. This email address will be used to notify you when the show is added
| [[File:Recap-Settings2.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* Recap debug from the Recap addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the Recap Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=275040 Recap Forum]

Add-on:RandomScreensaver

2016-10-01T14:21:30Z

Rob webset:

{{Addon
|Name=RandomScreensaver
|provider-name=robwebset
|ID=screensaver.random
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Random Screensaver
|Description=Screensaver that selects an installed screensaver at random to be used.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292710
|Website=
|Source=https://github.com/robwebset/screensaver.random
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.random/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The RandomScreensaver is an addon that you can select as your screensaver and every time the screensaver starts it will automatically choose one of the screensavers installed on your system and start it.

There is also an option to set time intervals during which a specified screensaver should be used.

This can be very useful if you wish to have a mix of different screensavers used on your installation.
 
 
== Screensaver Support ==
In order for RandomScreensaver to support randomly selecting a screensaver to start, the screensaver must also be configured to run as a script, this means that in addition to the addon.xml file containing:
<source lang="xml">
<extension point="xbmc.ui.screensaver" library="default.py"/>
</source>
It should also contain the following entry:
<source lang="xml">
<extension point="xbmc.python.script" library="default.py" />
</source>
The Kodi default screensavers (Dim and Black) are automatically excluded from any selection.
 
 
== Settings ==
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Mode'''
::Either Random, or Schedule mode (If Schedule mode, then the Schedule setting need to be set)
:'''- Excluded Screensavers'''
::Allows you to prevent a given set of screensavers being selected by RandomScreensaver (Random Mode Only)
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables RandomScreensaver debug logging into the Kodi log file
:'''''Operations'''''
::
:'''Check Supported Screensavers'''
::Checks all the screensavers installed and displays a list of screensavers that RandomScreensaver does not support.
| [[File:RandomScreensaver-Settings1.JPG|400px]]
|}

=== Schedule ===
{| border="0"
|- valign=top
|
:'''Number Of Schedule Rules'''
::Allows upto 5 different schedule rules to be set. (In order for the Schedule option to be used it must first be enabled in the "mode" setting)
:'''''Rule X'''''
:'''Start Time'''
::The start of the time interval that the given screensaver is to be used
:'''End Time'''
::The end of the time interval that the given screensaver is to be used
:'''Screensaver'''
::The screensaver that should be used during this time interval
| [[File:RandomScreensaver-Settings2.JPG|400px]]
|}

 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* RandomScreensaver debug from the RandomScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the RandomScreensaver Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=226971 RandomScreensaver Forum]

Add-on:PinSentry

2016-10-01T14:20:24Z

Rob webset:

{{Addon
|Name=PinSentry
|provider-name=robwebset
|ID=script.pinsentry
|extension point=xbmc.python.pluginsource
|provides=video
|Summary=Protect Kodi Content With A Pin Code
|Description=Force users to enter the correct pin code for given content.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292719
|Website=
|Source=https://github.com/robwebset/script.pinsentry
|Email=
|broken=
|icon url=https://github.com/robwebset/script.pinsentry/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
PinSentry is an addon that will allow you to set a pin code that you can then force to be input when you play a particular video file or navigate into a given TV Show or Plugin. There is also an option to force the user to enter a pin when the system starts, and then restrict the amount of time the user is allowed each day.

After install you need to:
* Go to settings and select your pin
* Enable which videos you want the pin to be displayed for (Either via Settings, Programs->PinSenty or Videos->Addons->PinSentry)
 
 
== Pin Contol ==
Whenever a user selects an item that has been protected by PinSentry they will be prompted with a dialog like the following:
 
<center>[[File:PinSentry-PinDialog1.JPG|200px]]</center>
 
The correct pincode should be entered via the onscreen buttons or a remote control numeric pad in order to gain access. It you have "[[Add-on:PinSentry#Setup|Allow Direction Keys In Pin Code]]" enabled in the settings then you can also use a pin code made up of Up, Down, Left and Right, this is useful if you have a remote control without numbers.
 
 
== Configuring Access ==
In order to configure which files or operations require the entry of the pin number you can access the menu be either via:
* Videos -> Addons -> PinSentry
* Programs -> PinSenty
* Settings
That will present the main settings menu:
 
<center>[[File:PinSentry-PermissionsScreen1.JPG|600px]]</center>
 
That will allow you to set values as follows:
:'''Movies'''
::Specify individual Movies to restrict
:'''TV Shows'''
::Specify individual TV Shows to restrict
:'''Movie Sets'''
::Specify individual Movie Sets to restrict, this will also flag the movies in the movie set as restricted
:'''Music Videos'''
::Specify individual Music Videos to restrict
:'''Plugins'''
::Specify individual Plugins to restrict
:'''File Source'''
::Specify individual file sources to restrict
:'''Classifications'''
::Specify Movie or TV Show classification to restrict
:'''[Force Pin Entry]'''
::Brings up the Pin Entry Dialog, forcing the pin to be entered before continuing
 
 
== Classifications ==
Each country has their own set of classifications, each meaning different things. Pin Sentry currently supports the following countries classifications
* Australia
* Brazil
* Canada
* Denmark
* Finland
* France
* Germany
* Hungary
* Ireland
* Netherlands
* Norway
* Sweden
* UK
* USA
If you would like another countries classifications supported then please post a request to the [http://forum.kodi.tv/showthread.php?tid=228451 forum]. The classifications have been taken from the following documents:
* http://en.wikipedia.org/wiki/Motion_picture_rating_system
* http://en.wikipedia.org/wiki/Television_content_rating_systems
Note: Not all countries have TV Show classifications
 
 
The classifications used on your Kodi library will depend on the settings (and scraper) that you used when you loaded them into the library initially. It is always worth noting that some videos can end up with incorrect classifications being set in your library.
 
 
There are two options in the PinSentry settings to help you identify videos that do not require a pin when using the current classification settings. Items that do not require a pin will be highlighted with the "Play Triangle" to illustrate that it can be played without a pin.
 
 
Videos that are protected via a classification rule can be excluded by manually selecting a given video and then choosing the "Remove Classification Restriction" option. Again, when this option is set it will be highlighted by the "Play Triangle".
 
 
== Multiple Security Levels ==
If you wish to have multiple pins to restrict different types of content then you can enable this support via the [[Add-on:PinSentry#Setup|options screen]]. You are allowed upto 5 different security levels, each needing a pin number to be set for them. (To access the settings screens the pin for the highest security level will be required).
 
 
The security levels are "stacked" on top of each other. You can set the security level of each video, you will then be prompted for a pin when you try and access the video, at which point you can enter a pin number. If you are trying to play a video with security level 3, then you can enter the pin number set for either 3, 4 or 5 in order to get it playing. Entering the pin for level 1 or 2 will continue to prevent you viewing the video.
 
 
If you enable the option "[[Add-on:PinSentry#Setup|Show Security Level On Permissions Screen]]" then the security level will be shown on the permissions screens. This is shown in the format 01:00 (Level 1), 02:00 (Level 2), 03:00 (Level 3), 04:00 (Level 4) and 05:00 (Level 5). This is not ideal, but allows the use of the generic Kodi plugin screens without the need to introduce custom screens that would require support to be added for each skin.
 
 
== Time Limits ==
If you wish to restrict the amount of time that a user is able to use Kodi each day (Children for example) then the Time Limits feature will allow you to do that. After being configured in the [[Add-on:PinSentry#Time_Limits_2|settings]] each time that Kodi starts it will prompt for a pin code to be entered.

If you enter the master (unrestricted) pin then no limits will be applied.

If you enter a users pin number then the current time limit settings (and remaining time) for that user will be displayed. The user will then be restricted to using Kodi within certain times of day and limited with regards to the total time that they can use Kodi each day.

If a user wishes to see how much time they have remaining, they can run PinSentry from the Programs menu and the summary dialog will be displayed again.
 
 
== Force Pin Prompt ==
It is possible to have the Pin Prompt be displayed and not exit until the correct pin is entered. This can be started in one of the following ways:
* Videos -> Addons -> PinSentry -> [Force Pin Entry]
* As a screensaver - just select PinSentry as your screensaver, and the prompt will appear when your screensaver time expires
* On Kodi startup (Enable in settings)
It is also possible to manually update your Kodi configuration to "map" a remote control (or keyboard button) to force the prompt to be displayed. To do this you must create a [[HOW-TO:Modify keymaps|keymap]] file and map your chosen key to run the following command:
<source lang="xml">
SetProperty(PinSentryPrompt, true, 10000)
</source>
 
 

== Settings ==
This section details all the settings options for PinSentry
=== Setup ===
{| border="0"
|- valign=top
|
:'''Pin Length'''
::The number of digits required when entering a pin
:'''Allow Direction Keys In Pin Code'''
::Allows the direction keys (Up, Down, Left, Right) to be used in the pin code, this is useful if you have a remote control without numbers on.
:'''Invalid Pin Notification'''
::How to inform the user that an invalid pin has been entered. Options include "None", "Notification" and "Dialog"
:'''Number Of Security Levels'''
::Allows multiple security levels to be used, so different pins are required for different videos
:'''- Show Security Level On Permissions Screen'''
::When using more than one security level, will show the current level on the permissions screen
:'''''Operations'''''
::
:'''Set Pin Value'''
::Sets the current pin
:'''Set Permissions'''
::Allows the setting of which items require the user to enter a pin before access.
:'''Clean Database'''
::Clears the database that contains all the rules for which items require a pin
| [[File:PinSentry-Settings1.JPG|400px]]
|}

=== Activity ===
{| border="0"
|- valign=top
|
:'''Video Playing'''
::Check if a pin is required each time a video is played
:'''Navigation'''
::Check if a pin is required to access certain menu items (Such as looking inside Movie Sets or TV Shows)
:'''Plugins'''
::Check if a pin is required to use a given plugin
:'''System Settings'''
::Prompt for a pin is someone enters the Kodi system settings
:'''File Source'''
::Check if a pin is required when accessing soming using a give file source
:'''- Only Restrict File Sources During Navigation'''
::Only prompts for file source restrictions when navigating into one (Not when playing a video)
:'''Block Movies Without A Classification'''
::Requires a pin if an attempt to access a movie that has no valid classification set
:'''Block TV Shows Without A Classification'''
::Requires a pin if an attempt to access a TV Show that has no valid classification set
| [[File:PinSentry-Settings2.JPG|400px]]
|}

=== Advanced ===
{| border="0"
|- valign=top
|
:'''Remember Pin'''
::In the pin should be remembered after it has been entered. Options are Off, On (will be remembered until the screensaver starts or the system is restarted) and "For Time Period"
:'''- Remember Pin For (Minutes)'''
::If configured to remember the pin for a given time period, this sets that period (Between 1 and 120 minutes)
:'''Background'''
::What to display behind the pin dialog. Options are None (the default background will be visible), Black (the screen behind the dialog will be blacked out), PinSentry (the PinSentry fanart will be displayed) and Custom (a user defined image is used)
:'''- Custom Background Image'''
::Allows the user to select their own background image
:'''Only Enforce Pin Between Set Times'''
::Will only prompt for a pin at certain times of the day
:'''- Start Time'''
::The time that the pin starts to be required
:'''- End Time'''
::The time that the pin is no longer required
:'''Highlight Videos Not Protected By Classifications'''
::If enabled, any you are using classification restrictions, will highlight the videos (with a play triangle) that are not currently protected with a pin in the "Set Permissions" menu
:'''Prompt For Pin On Startup'''
::When Kodi starts the Pin Entry Dialog will be displayed, forcing a pin to be entered before continuing
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables PinSentry debug logging into the Kodi log file
| [[File:PinSentry-Settings3.JPG|400px]]
|}

=== Time Limits ===
{| border="0"
|- valign=top
|
:'''Warn User When Remaining Time Is (Minutes)'''
::Set the time when a popup notification will be displayed detailing the time remaining on the allowance
:'''Number Of Limited Users'''
::Set the number of limited users that you want on the system
:'''''Unrestricted User Access Settings'''''
::
:'''- Set Pin Value'''
::Sets the value of the pin to be used for the user that has no time limit (This must be set if the number of users is greater than zero)
:'''''User X Access Settings'''''
::
:'''- Set Pin Value'''
::Sets the pin for the given user
:'''- User Name'''
::The name of the user, this is just so that you can easily recognise each users settings for future updates
:'''- Start Time'''
::The time of day that the user is allowed to access Kodi
:'''- End Time'''
::The time of day that the user is no longer allowed to access Kodi
:'''- Daily Viewing Allowance (Minutes)'''
::The total time in one day that the user is allowed to use Kodi
| [[File:PinSentry-Settings4.JPG|400px]]
|}

 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* PinSentry debug from the PinSentry addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the PinSentry Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=228451 PinSentry Forum]

Add-on:FilmWise

2016-10-01T14:19:11Z

Rob webset:

{{Addon
|Name=FilmWise
|provider-name=robwebset
|ID=script.game.filmwise
|extension point=xbmc.python.script
|provides=
|Summary=FilmWise Invisibles Quiz
|Description=Play the FilmWise weekly invisibles quiz
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292729
|Website=
|Source=https://github.com/robwebset/script.game.filmwise
|Email=
|broken=
|icon url=https://github.com/robwebset/script.game.filmwise/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
FilmWise is an addon that gives you access and reminders for the [http://www.filmwise.com/ FilmWise Invisibles Quiz].

This is a great weekly quiz where you get 8 images where the actors have been removed and you have to guess the movie!

After installing the addon you can start the quiz by either going to the Programs section or Video Add-on section.
 
 
== The Quiz ==
When selecting a quiz either via the Programs or Video Addon section the following window will be displayed:
 
<center>[[File:FilmWise-Display1.JPG|700px]]</center>
 
The answers can be entered under each picture, and by clicking on "Check Answers" it will highlight the correct ones. For weeks that have solutions, a "Show Solution" button will be displayed, clicking on that will show the answers for that week, filling in the people in the picture at the same time.
 
<center>[[File:FilmWise-Display2.JPG|700px]]</center>
 
 
== Notifications ==
There are two different ways to be notified of a new quiz (configurable in the settings)
* A notification popup when Kodi starts
* Automatically opening the quiz display screen when Kodi starts
 
 
== Settings ==
This section details all the settings options for Suitability
=== FilmWise ===
{| border="0"
|- valign=top
|
:'''Remember User Answers'''
::Stores the answers previously entered
:'''Notify If New Quiz Available'''
::Notify on startup if a new quiz is available
:'''- Automatically Open New Quiz'''
::Automatically open the new quiz on startup
:'''''Operations'''''
::
:'''Clear Saved Answers'''
::Removes all the saved answers
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables FilmWise debug logging into the Kodi log file                
| [[File:FilmWise-Settings1.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* FilmWise debug from the FilmWise addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the FilmWise Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=257178 FilmWise Forum]

Add-on:EBooks

2016-10-01T14:18:28Z

Rob webset:

{{Addon
|Name=eBooks
|provider-name=robwebset
|ID=script.ebooks
|extension point=xbmc.python.pluginsource
|provides=executable
|Summary=View eBooks
|Description=Allows the viewing of eBooks
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292727
|Website=
|Source=https://github.com/robwebset/script.ebooks
|Email=
|broken=
|icon url=https://github.com/robwebset/script.ebooks/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
eBooks is an addon that allows you to list and view your epub and mobi eBooks using Kodi. Only the text will be displayed, no images.
 
Supported book formats are
* ePub
* Mobi
* PDF
 
On installation of the eBook addon it will need configuring to point to the directory that contains all of your eBook files. This can be done via the eBooks Settings, or if not set, you will be prompted on first use.
 
 
== Book Listing ==
When entering the addon via the Programs Menu the available books will be listed in the format:
 
:''Author - Title''
 
Any directories that exist will be displayed with their directory name and enclosed in square brackets. On selecting a book, the chapters in that book will be displayed (Note: If there are no chapters, then a single entry for the entire book will be displayed).
 
Any books or chapters that have been marked previously as read will start with an asterisk ("*").
 
 
== Text Viewer ==
When a chapter is selected for reading it will be displayed in the text viewer. This enables the reader to scroll down the text either using the scrollbar or up and down arrow keys. Once the chapter has been read the user can either
* Select "Close" to close the window
* Select "Mark As Read" to record that this chapter has been read and then close the window
* Select "<" (Or the Page Up key) to go back to the previous chapter
* Select ">" (Or the Page Down key) to go to the next chapter
 
 
== Cover Art ==
The cover art for a given book is retrieved in the following order:
# A jpg file in the same directory as the book with the same name (i.e. a book with the name mybook.epub and an image with the name mybook.jpg)
# An image that has previously been cached from a book (Based on the file name of the book)
# Extracted internal image from the book file
# The default cover image set in the eBooks settings screen.
 
 
== OPDS Support ==
The eBooks addon supports the OPDS network protocol that enables you to expost your eBooks over the network from a server. For information on how to set this up on your Calibre installation, a [http://manual.calibre-ebook.com/gui.html#connect-share brief description can be found here].
 
 
This is the fastest way to navigate your library, especially if you wish to do so over a network connection. It also allows different filtering methods rather than a directory based navigation.
 
 
== Network Support ==

If you store your books on a network server and use Kodi to access them via smb:// or nfs:// then the initial listing of the available books will be slower (Until they are cached into the eBooks database) and chapter listings and viewing will always be slower.
 
'''Why?''' - Because the ebook reading scripts are not able to read the smb:// or nfs:// format that Kodi uses, so in order for the addon to read the file, it is copied to a temporary local directory, it is this copy that makes the processing of data slower.
 
'''How to Avoid This?''' - Either store the books locally or use the OS level network functionality to map the drive in such a way that it looks like a local drive. The use of the OPDS interface will also supply a faster and cleaner navigation experience (Although the book will still need to be copied locally when it comes time to read it)
 
 
== Settings ==
=== General ===
{| border="0"
|- valign=top
|
:'''Use eBooks Folder'''
::If eBooks are to be read from a directory location
:'''- eBooks Folder'''
::The Location where the eBooks are stored
:'''OPDS Interface'''
::If eBooks are to be read from an OPDS server
:'''- OPDS URL'''
::The URL and port of the OPDS server (e.g. localhost:8080)
:'''Default Book Cover Image'''
::The default cover image to use if there is no image available for the book
:'''Only Show Whole Book If No Chapters'''
::Will only show a link to the entire book if there are no chapters available in the book
:'''Mark Chapter As Read When Navigating To Next Chapter'''
::When using the next button on the viewer, mark the chapter being left as read
:'''Use White Background For Reader'''
::Use black text on a white background for the viewer window
:'''Always Use Page Numbers For PDF Files'''
::When listing PDF files, use page numbers rather than any chapters found
| [[File:EBooks-Settings1.JPG|400px]]
|}
=== Operations ===
{| border="0"
|- valign=top
|
:'''Clean Book Cover Cache'''
::Removes any book covers that have been cached
:'''Clear Book Details Cache'''
::Clears any data cached about the ebooks (inc. read markers)
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables eBooks debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
| [[File:EBooks-Settings2.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* eBooks debug from the eBooks addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the eBooks Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=238835 eBooks Forum]

Add-on:AudioBooks

2016-10-01T14:15:59Z

Rob webset:

{{Addon
|Name=AudioBooks
|provider-name=robwebset
|ID=script.audiobooks
|extension point=xbmc.python.pluginsource
|provides=audio
|Summary=Play AudioBooks
|Description=Allows the playing of AudioBooks
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292711
|Website=
|Source=https://github.com/robwebset/script.audiobooks
|Email=
|broken=
|icon url=https://github.com/robwebset/script.audiobooks/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
AudioBooks is an addon that allows you to list and play your AudioBooks using Kodi. Support includes m4b file format and the standard file formats supported by Kodi. (e.g. mp3, flac etc)
 
On installation of the AudioBooks addon it will need configuring to point to the directory that contains all of your AudioBook files. This can be done via the AudioBooks Settings, or if not set, you will be prompted on first use.
 
 
== Basic Support ==
With the default configuration you can:
* List all your AudioBooks (By filename)
* Play your AudioBooks
* Resume your AudioBooks from the point it was last stopped
* Display of AudioBook Titles
* Display of AudioBook Cover Artwork
 
 
== Advanced Support ==
In order to get features that include:
* Listing of AudioBook Chapters
* Starting playing from a given chapter marker
You will need some form of FFmpeg installed, see the following section on how to make FFmpeg available.
 
 
== Enabling FFmpeg ==
There are 2 different ways to enable FFmpeg
* Using the Kodi ffmpeg modules
* Using a locally installed ffmpeg on the machine Kodi is running on.
Note: If you previously loaded books without ffmpeg, then you will need to clear the cache via the settings - or the context menu to have the audiobooks rescanned.
 
=== FFmpeg Modules ===
There are a set of script.module.ffmpeg addons available that will supply the required FFmpeg files for each platform. Make sure you install the module designed for your platform:
* Windows: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/windows/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Linux: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/linux/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Mac OS X: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/osx/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Android: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/android/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]

After installing script.module.ffmpeg, if you already have AudioBooks installed, then enable "[[Add-on:AudioBooks#ffmpeg|Auto Detect FFmpeg On Next Restart]]" in the settings and restart Kodi.

Note: The Windows version of script.module.ffmpeg is optional, Kodi for windows already comes with the FFmpeg libraries, and the AudioBooks addon will use these be default.

=== FFmpeg Manual Install ===
You will need to download [https://www.ffmpeg.org/ ffmpeg] to a location on your machine and then use the AudioBooks Addon Settings to point to the ffmpeg executable. If you are running on a Linux or Android system then you need to ensure that the ffmpeg program has execute permissions otherwise it will not run (In order to set execute permissions on Android you will most likely need to have rooted your device)

 
 
== Network Support ==
If you store your audiobooks on a network server and use Kodi to access them via smb:// or nfs:// then the initial listing of the available books will be slower (Until they are cached into the AudioBooks database) and chapter listings will always be slower.
 
'''Why?''' - Because external programs (like ffmpeg) is not able to read the smb:// or nfs:// format that Kodi uses, so in order for the AudioBooks Addon to use ffmpeg to read the file, it is copied to a temporary local directory, it is this copy that makes the processing of data slower.
 
'''How to Avoid This?''' - Either store the books locally or use the OS level network functionality to map the drive in such a way that it looks like a local drive.
 
 
== AudioBook Listing ==
When entering the addon via the Music Addons Menu the available audiobooks will be listed. Any directories that exist will be displayed with their directory name and enclosed in square brackets. On selecting an audiobook, the chapters in that book will be displayed (Note: If ffmpeg support is not enabled then a link to play from the start of the book, or resume will be displayed).
 
Any audiobooks or chapters that have been marked previously as complete will start with an asterisk ("*").
 
 

== Cover Art ==
The cover art for a given audiobook is retrieved in the following order:
# A jpg file in the same directory as the audiobook with the same name (i.e. an audiobook with the name myaudiobook.m4b and an image with the name myaudiobook.jpg)
# An image that has previously been cached from a book (Based on the file name of the book)
# Extracted internal image from the audiobook file
# The default cover image set in the AudioBooks settings screen.
 
 
== Settings ==
=== General ===
{| border="0"
|- valign=top
|
:'''AudioBooks Folder'''
::The Location where the AudioBooks are stored
:'''Highlight Completed Books And Chapters'''
::Indicate which books and chapters have been completed
:'''Automatically Number Chapters'''
::Will give each chapter in an audiobook a number when displayed
:'''Default AudioBook Cover Image'''
::The default cover image to use if there is no image available for the audiobook
| [[File:AudioBooks-Settings1.JPG|400px]]
|}

=== ffmpeg ===
{| border="0"
|- valign=top
|
:'''Auto Detect FFmpeg On Next Restart'''
::The next time Kodi restarts it will search for installations of ffmpeg and update the settings location
:'''FFmpeg Usage'''
::Options are None (Do not use FFmpeg), Libraries (Use FFmpeg shared libraries) and Executable (Use FFmpeg executable)
:'''- Library Location'''
::(If Usage set to "Libraries") The location of the ffmpeg libraries
:'''- Library Location'''
::(If Usage set to "Executable") The location of the ffmpeg executable
| [[File:AudioBooks-Settings3.JPG|400px]]
|}

=== Operations ===
{| border="0"
|- valign=top
|
:'''Clean AudioBook Cover Cache'''
::Removes any audiobook covers that have been cached
:'''Clear AudioBook Details Cache'''
::Clears any data cached about the audiobooks (inc. read markers)
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables AudioBook debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
| [[File:AudioBooks-Settings2.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* AudioBooks debug from the AudioBooks addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the AudioBooks Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=239859 AudioBooks Forum]

Add-on:AddonSync

2016-10-01T14:14:22Z

Rob webset:

{{Addon
|Name=AddonSync
|provider-name=robwebset
|ID=service.addonsync
|extension point=xbmc.service
|provides=
|Summary=Synchronise Addon Settings Between Different Installations
|Description=Keep all Addon settings in sync across all of your installations
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=292715
|Website=
|Source=https://github.com/robwebset/service.addonsync
|Email=
|broken=
|icon url=https://github.com/robwebset/service.addonsync/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The AddonSync service allows you to set one of your Kodi installations as the "Master" and have all the other installations be Slaves. Then you can have the master installation upload to a network share, and the slave installation download them.
 
 
== Setup ==
AddonSync works on a "Master" and "Slave" approach. There can be only a single Master installation, and any number of slave installations. First set up the Master installation, this will backup all of your addon settings to a shared location.
 
 
Once you have your Master installation backing up it's settings to a shared location you can configure any number of other installations to act as slaves and update their own settings from the master copy.
 
 
== Exclusions ==
There are some addons that will not be sync'ed between installations, this is normally because they need to have their own configurations, these include:
* Skin settings
* Metadata addons
* Built in screensavers
* Addons where the versions of the addon do not match
 
 
== Settings ==
=== AddonSync ===
{| border="0"
|- valign=top
|
:'''Installation Type'''
::If this Kodi installation should work as the Master or Slave
:'''Central Store Location'''
::The location where AddonSync should store the addons data it needs to synchronise
:'''Run On Startup'''
::If AddonSync should backup/restore when Kodi first starts up
:'''Update Interval (Minutes)'''
::How often AddonSync should check to see if any settings have changed
:'''Restart Updated Service Addons'''
::If running as a slave and a service addon is updated, restart it to pick up the changes
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables AddonSync debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
:'''''Operations'''''
::
:'''Run Synchronisation Now'''
::Manually run the synchronise operation
| [[File:AddonSync-Settings1.JPG|400px]]
|}
=== Filter ===
{| border="0"
|- valign=top
|
:'''Addon Synchronise Selection'''
::Allows either All addons to be synchronise, or to include/exclude a set of addons
:'''Select Addons'''
::If not all addons are being synchronised, then selectes those that are included/excluded
| [[File:AddonSync-Settings2.JPG|400px]]
|}

 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* AddonSync debug from the AddonSync addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the AddonSync Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=260802 AddonSync Forum]

Add-on:AddonSync

2016-10-01T07:34:17Z

Rob webset:

{{Addon
|Name=AddonSync
|provider-name=robwebset
|ID=service.addonsync
|extension point=xbmc.service
|provides=
|Summary=Synchronise Addon Settings Between Different Installations
|Description=Keep all Addon settings in sync across all of your installations
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=260802
|Website=
|Source=https://github.com/robwebset/service.addonsync
|Email=
|broken=
|icon url=https://github.com/robwebset/service.addonsync/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The AddonSync service allows you to set one of your Kodi installations as the "Master" and have all the other installations be Slaves. Then you can have the master installation upload to a network share, and the slave installation download them.
 
 
== Setup ==
AddonSync works on a "Master" and "Slave" approach. There can be only a single Master installation, and any number of slave installations. First set up the Master installation, this will backup all of your addon settings to a shared location.
 
 
Once you have your Master installation backing up it's settings to a shared location you can configure any number of other installations to act as slaves and update their own settings from the master copy.
 
 
== Exclusions ==
There are some addons that will not be sync'ed between installations, this is normally because they need to have their own configurations, these include:
* Skin settings
* Metadata addons
* Built in screensavers
* Addons where the versions of the addon do not match
 
 
== Settings ==
=== AddonSync ===
{| border="0"
|- valign=top
|
:'''Installation Type'''
::If this Kodi installation should work as the Master or Slave
:'''Central Store Location'''
::The location where AddonSync should store the addons data it needs to synchronise
:'''Run On Startup'''
::If AddonSync should backup/restore when Kodi first starts up
:'''Update Interval (Minutes)'''
::How often AddonSync should check to see if any settings have changed
:'''Restart Updated Service Addons'''
::If running as a slave and a service addon is updated, restart it to pick up the changes
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables AddonSync debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
:'''''Operations'''''
::
:'''Run Synchronisation Now'''
::Manually run the synchronise operation
| [[File:AddonSync-Settings1.JPG|400px]]
|}
=== Filter ===
{| border="0"
|- valign=top
|
:'''Addon Synchronise Selection'''
::Allows either All addons to be synchronise, or to include/exclude a set of addons
:'''Select Addons'''
::If not all addons are being synchronised, then selectes those that are included/excluded
| [[File:AddonSync-Settings2.JPG|400px]]
|}

 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* AddonSync debug from the AddonSync addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the AddonSync Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=260802 AddonSync Forum]

Add-on:AudioBooks

2016-09-18T08:41:25Z

Rob webset:

{{Addon
|Name=AudioBooks
|provider-name=robwebset
|ID=script.audiobooks
|extension point=xbmc.python.pluginsource
|provides=audio
|Summary=Play AudioBooks
|Description=Allows the playing of AudioBooks
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=239859
|Website=
|Source=https://github.com/robwebset/script.audiobooks
|Email=
|broken=
|icon url=https://github.com/robwebset/script.audiobooks/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
AudioBooks is an addon that allows you to list and play your AudioBooks using Kodi. Support includes m4b file format and the standard file formats supported by Kodi. (e.g. mp3, flac etc)
 
On installation of the AudioBooks addon it will need configuring to point to the directory that contains all of your AudioBook files. This can be done via the AudioBooks Settings, or if not set, you will be prompted on first use.
 
 
== Basic Support ==
With the default configuration you can:
* List all your AudioBooks (By filename)
* Play your AudioBooks
* Resume your AudioBooks from the point it was last stopped
* Display of AudioBook Titles
* Display of AudioBook Cover Artwork
 
 
== Advanced Support ==
In order to get features that include:
* Listing of AudioBook Chapters
* Starting playing from a given chapter marker
You will need some form of FFmpeg installed, see the following section on how to make FFmpeg available.
 
 
== Enabling FFmpeg ==
There are 2 different ways to enable FFmpeg
* Using the Kodi ffmpeg modules
* Using a locally installed ffmpeg on the machine Kodi is running on.
Note: If you previously loaded books without ffmpeg, then you will need to clear the cache via the settings - or the context menu to have the audiobooks rescanned.
 
=== FFmpeg Modules ===
There are a set of script.module.ffmpeg addons available that will supply the required FFmpeg files for each platform. Make sure you install the module designed for your platform:
* Windows: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/windows/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Linux: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/linux/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Mac OS X: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/osx/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Android: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/android/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]

After installing script.module.ffmpeg, if you already have AudioBooks installed, then enable "[[Add-on:AudioBooks#ffmpeg|Auto Detect FFmpeg On Next Restart]]" in the settings and restart Kodi.

Note: The Windows version of script.module.ffmpeg is optional, Kodi for windows already comes with the FFmpeg libraries, and the AudioBooks addon will use these be default.

=== FFmpeg Manual Install ===
You will need to download [https://www.ffmpeg.org/ ffmpeg] to a location on your machine and then use the AudioBooks Addon Settings to point to the ffmpeg executable. If you are running on a Linux or Android system then you need to ensure that the ffmpeg program has execute permissions otherwise it will not run (In order to set execute permissions on Android you will most likely need to have rooted your device)

 
 
== Network Support ==
If you store your audiobooks on a network server and use Kodi to access them via smb:// or nfs:// then the initial listing of the available books will be slower (Until they are cached into the AudioBooks database) and chapter listings will always be slower.
 
'''Why?''' - Because external programs (like ffmpeg) is not able to read the smb:// or nfs:// format that Kodi uses, so in order for the AudioBooks Addon to use ffmpeg to read the file, it is copied to a temporary local directory, it is this copy that makes the processing of data slower.
 
'''How to Avoid This?''' - Either store the books locally or use the OS level network functionality to map the drive in such a way that it looks like a local drive.
 
 
== AudioBook Listing ==
When entering the addon via the Music Addons Menu the available audiobooks will be listed. Any directories that exist will be displayed with their directory name and enclosed in square brackets. On selecting an audiobook, the chapters in that book will be displayed (Note: If ffmpeg support is not enabled then a link to play from the start of the book, or resume will be displayed).
 
Any audiobooks or chapters that have been marked previously as complete will start with an asterisk ("*").
 
 

== Cover Art ==
The cover art for a given audiobook is retrieved in the following order:
# A jpg file in the same directory as the audiobook with the same name (i.e. an audiobook with the name myaudiobook.m4b and an image with the name myaudiobook.jpg)
# An image that has previously been cached from a book (Based on the file name of the book)
# Extracted internal image from the audiobook file
# The default cover image set in the AudioBooks settings screen.
 
 
== Settings ==
=== General ===
{| border="0"
|- valign=top
|
:'''AudioBooks Folder'''
::The Location where the AudioBooks are stored
:'''Highlight Completed Books And Chapters'''
::Indicate which books and chapters have been completed
:'''Automatically Number Chapters'''
::Will give each chapter in an audiobook a number when displayed
:'''Default AudioBook Cover Image'''
::The default cover image to use if there is no image available for the audiobook
| [[File:AudioBooks-Settings1.JPG|400px]]
|}

=== ffmpeg ===
{| border="0"
|- valign=top
|
:'''Auto Detect FFmpeg On Next Restart'''
::The next time Kodi restarts it will search for installations of ffmpeg and update the settings location
:'''FFmpeg Usage'''
::Options are None (Do not use FFmpeg), Libraries (Use FFmpeg shared libraries) and Executable (Use FFmpeg executable)
:'''- Library Location'''
::(If Usage set to "Libraries") The location of the ffmpeg libraries
:'''- Library Location'''
::(If Usage set to "Executable") The location of the ffmpeg executable
| [[File:AudioBooks-Settings3.JPG|400px]]
|}

=== Operations ===
{| border="0"
|- valign=top
|
:'''Clean AudioBook Cover Cache'''
::Removes any audiobook covers that have been cached
:'''Clear AudioBook Details Cache'''
::Clears any data cached about the audiobooks (inc. read markers)
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables AudioBook debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
| [[File:AudioBooks-Settings2.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* AudioBooks debug from the AudioBooks addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the AudioBooks Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=239859 AudioBooks Forum]

Add-on:AudioBooks

2016-09-18T08:38:31Z

Rob webset:

{{Addon
|Name=AudioBooks
|provider-name=robwebset
|ID=script.audiobooks
|extension point=xbmc.python.pluginsource
|provides=audio
|Summary=Play AudioBooks
|Description=Allows the playing of AudioBooks
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=239859
|Website=
|Source=https://github.com/robwebset/script.audiobooks
|Email=
|broken=
|icon url=https://github.com/robwebset/script.audiobooks/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
AudioBooks is an addon that allows you to list and play your AudioBooks using Kodi. Support includes m4b file format and the standard file formats supported by Kodi. (e.g. mp3, flac etc)
 
On installation of the AudioBooks addon it will need configuring to point to the directory that contains all of your AudioBook files. This can be done via the AudioBooks Settings, or if not set, you will be prompted on first use.
 
 
== Basic Support ==
With the default configuration you can:
* List all your AudioBooks (By filename)
* Play your AudioBooks
* Resume your AudioBooks from the point it was last stopped
* Display of AudioBook Titles
* Display of AudioBook Cover Artwork
 
 
== Advanced Support ==
In order to get features that include:
* Listing of AudioBook Chapters
* Starting playing from a given chapter marker
You will need some form of FFmpeg installed, see the following section on how to make FFmpeg available.
 
 
== Enabling FFmpeg ==
There are 2 different ways to enable FFmpeg
* Using the Kodi ffmpeg modules
* Using a locally installed ffmpeg on the machine Kodi is running on.
 
Note: If you previously loaded books without ffmpeg, then you will need to clear the cache via the settings - or the context menu to have the audiobooks rescanned.
 
=== FFmpeg Modules ===
There are a set of script.module.ffmpeg addons available that will supply the required FFmpeg files for each platform. Make sure you install the module designed for your platform:
* Windows: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/windows/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Linux: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/linux/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Mac OS X: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/osx/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]
* Android: [https://github.com/robwebset/kodi.ffmpeg.bundles/raw/master/addons/android/script.module.ffmpeg-1.0.0.zip script.module.ffmpeg-1.0.0.zip]

After installing script.module.ffmpeg, if you already have AudioBooks installed, then enable "[[Add-on:AudioBooks#ffmpeg|Auto Detect FFmpeg On Next Restart]]" in the settings and restart Kodi.

Note: The Windows version of script.module.ffmpeg is optional, Kodi for windows already comes with the FFmpeg libraries, and the AudioBooks addon will use these be default.

=== FFmpeg Manual Install ===
You will need to download [https://www.ffmpeg.org/ ffmpeg] to a location on your machine and then use the AudioBooks Addon Settings to point to the ffmpeg executable. If you are running on a Linux or Android system then you need to ensure that the ffmpeg program has execute permissions otherwise it will not run (In order to set execute permissions on Android you will most likely need to have rooted your device)

 
 
=== Network Support ===
If you store your audiobooks on a network server and use Kodi to access them via smb:// or nfs:// then the initial listing of the available books will be slower (Until they are cached into the AudioBooks database) and chapter listings will always be slower.
 
'''Why?''' - Because external programs (like ffmpeg) is not able to read the smb:// or nfs:// format that Kodi uses, so in order for the AudioBooks Addon to use ffmpeg to read the file, it is copied to a temporary local directory, it is this copy that makes the processing of data slower.
 
'''How to Avoid This?''' - Either store the books locally or use the OS level network functionality to map the drive in such a way that it looks like a local drive.
 
 
== AudioBook Listing ==
When entering the addon via the Music Addons Menu the available audiobooks will be listed. Any directories that exist will be displayed with their directory name and enclosed in square brackets. On selecting an audiobook, the chapters in that book will be displayed (Note: If ffmpeg support is not enabled then a link to play from the start of the book, or resume will be displayed).
 
Any audiobooks or chapters that have been marked previously as complete will start with an asterisk ("*").
 
 

== Cover Art ==
The cover art for a given audiobook is retrieved in the following order:
# A jpg file in the same directory as the audiobook with the same name (i.e. an audiobook with the name myaudiobook.m4b and an image with the name myaudiobook.jpg)
# An image that has previously been cached from a book (Based on the file name of the book)
# Extracted internal image from the audiobook file
# The default cover image set in the AudioBooks settings screen.
 
 
== Settings ==
=== General ===
{| border="0"
|- valign=top
|
:'''AudioBooks Folder'''
::The Location where the AudioBooks are stored
:'''Highlight Completed Books And Chapters'''
::Indicate which books and chapters have been completed
:'''Automatically Number Chapters'''
::Will give each chapter in an audiobook a number when displayed
:'''Default AudioBook Cover Image'''
::The default cover image to use if there is no image available for the audiobook
| [[File:AudioBooks-Settings1.JPG|400px]]
|}

=== ffmpeg ===
{| border="0"
|- valign=top
|
:'''Auto Detect FFmpeg On Next Restart'''
::The next time Kodi restarts it will search for installations of ffmpeg and update the settings location
:'''FFmpeg Usage'''
::Options are None (Do not use FFmpeg), Libraries (Use FFmpeg shared libraries) and Executable (Use FFmpeg executable)
:'''- Library Location'''
::(If Usage set to "Libraries") The location of the ffmpeg libraries
:'''- Library Location'''
::(If Usage set to "Executable") The location of the ffmpeg executable
| [[File:AudioBooks-Settings3.JPG|400px]]
|}

=== Operations ===
{| border="0"
|- valign=top
|
:'''Clean AudioBook Cover Cache'''
::Removes any audiobook covers that have been cached
:'''Clear AudioBook Details Cache'''
::Clears any data cached about the audiobooks (inc. read markers)
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables AudioBook debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
| [[File:AudioBooks-Settings2.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* AudioBooks debug from the AudioBooks addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the AudioBooks Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=239859 AudioBooks Forum]

File:AudioBooks-Settings3.JPG

2016-09-18T08:19:04Z

Rob webset: MsUpload

MsUpload

File:AudioBooks-Settings2.JPG

2016-09-18T08:18:39Z

Rob webset: Rob webset uploaded a new version of "File:AudioBooks-Settings2.JPG"

MsUpload

File:AudioBooks-Settings1.JPG

2016-09-18T08:16:29Z

Rob webset: Rob webset uploaded a new version of "File:AudioBooks-Settings1.JPG"

MsUpload

Add-on:VideoScreensaver

2016-08-28T15:27:10Z

Rob webset:

{{Addon
|Name=VideoScreensaver
|provider-name=robwebset
|ID=screensaver.video
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Screensaver that plays a video file
|Description=Plays a video when the screensaver starts, this can be a custom video or one of the built in videos
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=210943
|Website=
|Source=https://github.com/robwebset/screensaver.video
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.video/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
VideoScreensaver is a screensaver that will play a video file when the screensaver starts. It will support playing either a user specified video file, or one of several pre-defined video files.
 
 
== Forum And Issue Report Pages ==
If you have any questions, found an issue to report or would just like to know a little more you can take part in the forum discussions at:

[http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]
 
 
== Built-In Screensaver Videos ==
The following screensaver videos are supplied with the addon. They can be enabled, downloaded and previewed via the Video -> Addons -> VideoScreensaver menu. There is a context menu that allows you to preview and remove each screensaver video.

=== Apple TV Collection ===
==== China ====
{|
| [[File:VideoSecreensaver-appletv-China-D1.JPG|China - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D2.JPG|China - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D3.JPG|China - Day 3|none|thumb|250px]]
|}
==== Hawaii ====
{|
| [[File:VideoSecreensaver-appletv-Hawaii-D1.JPG|Hawaii - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D2.JPG|Hawaii - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D3.JPG|Hawaii - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-D4.JPG|Hawaii - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D5.JPG|Hawaii - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D6.JPG|Hawaii - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-N1.JPG|Hawaii - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-N2.JPG|Hawaii - Night 2|none|thumb|250px]]
|}
==== London ====
{|
| [[File:VideoSecreensaver-appletv-London-D1.JPG|London - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-D2.JPG|London - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N1.JPG|London - Night 2|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-London-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== New York ====
{|
| [[File:VideoSecreensaver-appletv-NewYork-D1.JPG|New York - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D2.JPG|New York - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D3.JPG|New York - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-NewYork-N1.JPG|London - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== San Francisco ====
{|
| [[File:VideoSecreensaver-appletv-SanFrancisco-D1.JPG|San Francisco - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D2.JPG|San Francisco - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D3.JPG|San Francisco - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-D4.JPG|San Francisco - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D5.JPG|San Francisco - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D6.JPG|San Francisco - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N1.JPG|San Francisco - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N2.JPG|San Francisco - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N3.JPG|San Francisco - Night 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N4.JPG|San Francisco - Night 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N5.JPG|San Francisco - Night 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N6.JPG|San Francisco - Night 6|none|thumb|250px]]
|}

=== Aquarium Collection ===
{|
| [[File:Aquarium001.png|Aquarium 1 - [846MB] - 400p|none|thumb|250px]]
| [[File:Aquarium002-720p.png|Aquarium 2 - [2.7GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium003.PNG|Aquarium 3 - [2.4GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Aquarium004.JPG|Aquarium 4 - [780MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium005.png|Aquarium 5 - [3.0GB] - 720p|none|thumb|250px]]
|}
=== Beach Collection ===
{|
| [[File:VideoScreensaver-Beach001.JPG|Beach 1 - [2.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach002.JPG|Beach 2 - [838MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach003.JPG|Beach 3 - [3.4GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Beach004.JPG|Beach 4 - [768MB] - 720p|none|thumb|250px]]
|}
=== Clock Collection ===
{|
| [[File:VideoScreensaver-Clock001.JPG|Clock 1 - [1.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Clock002.JPG|Clock 2 - [1.3GB] - 360p|none|thumb|250px]]
|}
=== Fireplace Collection ===
{|
| [[File:Fireplace001-720p.png|Fireplace 1 - [965MB] - 720p|none|thumb|250px]]
| [[File:Fireplace002.png|Fireplace 2 - [827MB] - 480p|none|thumb|182px]]
| [[File:Fireplace003-1080p.png|Fireplace 3 - [2.1GB] - 1080p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Fireplace004.PNG|Fireplace 4 - [2.7GB] - 720p|none|thumb|250px]]
|}
=== Miscellaneous Collection ===
{|
| [[File:VideoScreensaver-Christmas001.JPG|Christmas 1 - [777MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-JohnnyCastaway001.JPG|Johnny Castaway 1 - [75MB] - 480p|none|thumb|168px]]
| [[File:VideoScreensaver-Matrix001.JPG|Matrix 1 - [909MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Ocean001.JPG|Ocean 1 - [1.1GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-RetroSciFi001.JPG|Retro Sci-Fi 1 - [200MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-StarTrekTNG001.JPG|Star Trek TNG 1 - [54MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Watermill001.JPG|Watermill 1 - [549MB] - 1080p|none|thumb|250px]]
|}
=== Snow Collection ===
{|
| [[File:VideoScreensaver-Snow001.JPG|Snow 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow002.JPG|Snow 2 - [677MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow003.JPG|Snow 3 - [1.2GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Snow004.JPG|Snow 4 - [1.5GB] - 720p|none|thumb|250px]]
|}
=== Space Collection ===
{|
| [[File:VideoScreensaver-Space001.PNG|Space 1 - [970MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Space002.JPG|Space 2 - [563MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Space003.png|Space 3 - [2.2GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Space004.PNG|Space 4 - [1.2GB] - 720p|none|thumb|250px]]
|}
=== Waterfall Collection ===
{|
| [[File:VideoScreensaver-Waterfall001.JPG|Waterfall 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall002.JPG|Waterfall 2 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall003.JPG|Waterfall 3 - [2.4GB] - 720p|none|thumb|250px]]
|}
=== Woodland Collection ===
{|
| [[File:VideoScreensaver-Woodland001.JPG|Woodland 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Woodland002.JPG|Woodland 2 - [664MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Woodland003.JPG|Woodland 3 - [1.0GB] - 720p|none|thumb|250px]]
|}

 
 
== Built-In Overlay Images ==
The following overlay images are supplied with the addon.
{|
| [[File:PictureFrame1.png|Picture Frame 1|none|thumb|250px]]
| [[File:WindowFrame1.png|Window Frame 1|none|thumb|232px]]
| [[File:WindowFrame2.png|Window Frame 2|none|thumb|230px]]
|}
 
 
== Weather ==
VideoScreensaver can display the latest weather information in the top left hand corner of the screen if you wish. This feature makes use of the standard set of Weather addons available in the official Kodi repository, and can be configured via the VideoScreensaver settings.
 
 
== Clocks ==
VideoScreensaver has special handling for clock videos. This enables the correct current time to be displayed. This is assuming the video is either 12 hours (for an analog clock) or 24 hours (for a digial clock) and starts at midnight/12 o'clock. The built in "Clock" screensaver videos will handle this and show the correct time. If you have a custom video you wish to be shown as a clock, then this can be done my naming it with the name "clock" in the filename.
 
 
== Custom Collections ==
VideoScreensaver can handle the import of custom collections. This allows users to make their own collections of videos and make them available for others to share. The file format to import is as follows:

<source lang="xml">
<videoscreensaver>
<collection>Collection Name</collection>
<video>
<name>Video Name 1</name>
<filename>collection-filename1.mkv</filename>
<image>http://location/of/fame-image1.png</image>
<duration>3602</duration>
<primary>http://location/of/video2.mkv</primary>
</video>
<video>
<name>Video Name 2</name>
<filename>collection-filename2.mkv</filename>
<image>http://location/of/fame-image2.png</image>
<duration>2000</duration>
<primary>http://location/of/video1.mkv</primary>
</video>
</videoscreensaver>
</source>

As many "video" elements can be added as required for the collection. The filename should be unique from the other video files available, it is advised that the name of the collection is pre-pended to the filename. The "image" and duration elements are optional and the primary element contains the full URL to the source video file.

This file can then be imported via the Video -> Addons -> VideoScreensaver menu item.
 
 
== Schedule ==
It is possible to schedule which video is used at which time of day via the [[Add-on:VideoScreensaver#Schedule_2|Schedule Settings]]. The rules to apply for schedules can either be defined directly in the settings, or defined in an XML file which is then referenced from the settings.

<source lang="xml">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<schedule>
<rule id="1" start="10:24" end="14:37" day="monday", video="myvideo.mkv" overlay="myoverlay.png" />
<rule id="2" start="16:00" end="18:00" video="myvideo2.mkv" overlay="myoverlay2.png" />
</schedule>
</source>

The "day" attribute is optional and if set must be one of the values (monday, tuesday, wednesday, thursday, friday, saturday, sunday), the default is every day

If no video is specified in the schedule settings, then it will fall back to the default rules from the screensaver settings.
 
 
== Settings ==
This section details all the settings options for VideoScreensaver
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Use All Files In A Folder'''
::Will play a selection of video files from a directory instead of a single file
:'''Limit Session To Single Collection/Folder'''
::When the screensaver starts it will only play videos that are part of a single collection or folder on the file system.
:'''Include Nested Folders'''
::Will include video files from sub directories as well as the root directory
:'''Select Video Folder/File'''
::Prompts for the video files to use as a screensaver
:'''Repeat Type For Multiple Files'''
::Repeat All - Will loop through all the videos in the folder
::Repeat One - Will randomly select one video and keep repeating that video
:'''Overlay Image'''
::Allows for either a built in or user defined image to be overlayed on top of the video file
| [[File:Settings1.JPG|400px]]
|}

=== Configuration ===
{| border="0"
|- valign=top
|
:'''Show Time'''
::Displays the current time and data in the top right hand corner when the screensaver is active
:'''Show Weather'''
::Displays weather information in the top left hand corner
:'''- Select Weather Addon'''
::Selects the weather addon to display the weather details
:'''Start Video At Random Point'''
::When the video starts, will start at a random point into the duration of the video
:'''Prevent Screensaver Starting If Playing Media'''
::If there is media playing (i.e. Music or Video) and the screensaver is due to start, then if this is enabled, the screensaver will be prevented from starting.
:'''Change Volume When Screensaver Starts'''
::Allow the volume to be changed when the screensaver starts
:'''- Set Volume To'''
::The value to set the volume to when the screensaver starts
:'''- Use Audio Engine Suspend For 0 Volume'''
::If the screensaver volume is set to 0, then this option will suspend the Kodi Audio Engine rather than just reducing the volume to zero (This is useful if your system is set to passthrough audio)
:'''Dim Level'''
::How much to dim the screensaver video when it starts (0 = No Dim)
:'''Stop Screensaver Automatically'''
::Allow the screensaver to stop automatically after it has been playing for a given length of time. After stopping, the screensaver will start again after the default time of inactivity.
:'''- Stop Screensaver After (Minutes)'''
::Duration to let the screensaver play before stoping it
:'''- Shutdown After Automatic Stop'''
::After automatic shutdown has been triggered perform the default shutdown method set in the System -> Power Saving -> Shutdown Function
| [[File:Settings4.JPG|400px]]
|}

=== Startup ===
{| border="0"
|- valign=top
|
:'''Reset Volume On Startup'''
::Will reset the Kodi volume on startup of the system - this is useful if you always run your system at a set volume and use the TV or external audio system to change the volume (This way if the system crashes while playing a Video Screensaver, it will not leave the volume in an inconsistent state)
:'''- Set Volume On Startup To'''
::The value to set the Kodi volume to on startup
:'''Launch Screensaver On Startup'''
::When Kodi first starts the screensaver will start playing
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables VideoScreensaver debug logging into the Kodi log file
| [[File:VideoScreensaver-Settings5.JPG|400px]]
|}

=== Schedule ===
{| border="0"
|- valign=top
|
:'''Schedule Settings'''
::This can take the following values: Off (No scheduling enabled), Settings (Configure via the settings menu, see options below) and File (Load configuration from a file, see the [[Add-on:VideoScreensaver#Schedule|schedule section]])
:'''Number Of Schedule Rules'''
::The number of different schedule rules to be configured
:'''''Rule X'''''
::
:'''Start Time'''
::The time of day that this rule starts being used
:'''Stop Time'''
::The time of day that this rule stops being used
:'''Day'''
::The day of the week that this rule starts being used
:'''Select Video File'''
::The video file to play while this rule is active
:'''Overlay Image'''
::The overlay image to use while this rule is active
| [[File:VideoScreensaver-Settings6.JPG|400px]]
|}

 
 
== Detecting If VideoScreensaver Is Running ==
The way that VideoScreensaver has been implemented in order to play a video as a screensaver, it will not be recorded via the normal "xbmc.Monitor" onScreensaverActivated() or onScreensaverDeactivated() method. In fact when the screensaver starts you will get both an onScreensaverActivated() and onScreensaverDeactivated() message before the VideoScreensaver starts playing.
 
If you wanted to work out if VideoScreensaver is active from another script then you can check for the "VideoScreensaverRunning" property being set:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverRunning")</source>
This will return the value "true" if it is running.
 
It is also worth noting, that while the screensaver is starting up it will set the "VideoScreensaverStarting" property, that can be checked as follows:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverStarting")</source>
This will return the value "true" if it is currently starting.
 
 
== Known Issues ==
=== Auto-Shutdown Will Not Activate While VideoScreensaver Is Running ===
If you enable Kodi Auto-Shutdown options in Kodi System Settings they will not trigger while VideoScreensaver is active - this is because the video being played as part of the screensaver will make Kodi "active". The impact of this can be lessened by enabling "Stop Screensaver Automatically" and setting "Shutdown After Automatic Stop"
=== Changing Screensaver volume will not work when using audio Pass-Through ===
If you have Audio-Passthrough enabled in your audio settings then the ability to reduce the volume of the screensaver will not function. This is because you have removed Kodi's control of the audio. If you wish to set the volume to zero, then there is an option to "[[Add-on:VideoScreensaver#Configuration|Suspend The Audio Engine]]"
=== Using password protected profiles will prompt before screensaver starts ===
If you have a password protected profile and try and launch VideoScreensaver, then you will be prompted for the password '''''before''''' the screensaver starts instead of after. One alternative is to use [[Add-on:PinSentry|PinSentry]] instead of profiles.
 
 

== FAQ ==
=== Where are the built in videos stored after download? ===
The location of the video files will vary depending on the OS where Kodi is installed. The location can be retrieved by switching the "Video Selection" option in settings to "User Defined". This will then display the full path in the "Select Videos Folder/File" setting.
=== Can Kodi play music or radio while showing a screensaver video? ===
Unfortunately this is not possible. This is because Kodi can only play one media type at a time.
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* VideoScreensaver debug from the VideoScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the VideoScreensaver Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]

File:VideoScreensaver-Woodland003.JPG

2016-08-28T15:25:16Z

Rob webset: MsUpload

MsUpload

Add-on:VideoScreensaver

2016-08-28T14:56:16Z

Rob webset:

{{Addon
|Name=VideoScreensaver
|provider-name=robwebset
|ID=screensaver.video
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Screensaver that plays a video file
|Description=Plays a video when the screensaver starts, this can be a custom video or one of the built in videos
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=210943
|Website=
|Source=https://github.com/robwebset/screensaver.video
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.video/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
VideoScreensaver is a screensaver that will play a video file when the screensaver starts. It will support playing either a user specified video file, or one of several pre-defined video files.
 
 
== Forum And Issue Report Pages ==
If you have any questions, found an issue to report or would just like to know a little more you can take part in the forum discussions at:

[http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]
 
 
== Built-In Screensaver Videos ==
The following screensaver videos are supplied with the addon. They can be enabled, downloaded and previewed via the Video -> Addons -> VideoScreensaver menu. There is a context menu that allows you to preview and remove each screensaver video.

=== Apple TV Collection ===
==== China ====
{|
| [[File:VideoSecreensaver-appletv-China-D1.JPG|China - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D2.JPG|China - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D3.JPG|China - Day 3|none|thumb|250px]]
|}
==== Hawaii ====
{|
| [[File:VideoSecreensaver-appletv-Hawaii-D1.JPG|Hawaii - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D2.JPG|Hawaii - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D3.JPG|Hawaii - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-D4.JPG|Hawaii - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D5.JPG|Hawaii - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D6.JPG|Hawaii - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-N1.JPG|Hawaii - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-N2.JPG|Hawaii - Night 2|none|thumb|250px]]
|}
==== London ====
{|
| [[File:VideoSecreensaver-appletv-London-D1.JPG|London - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-D2.JPG|London - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N1.JPG|London - Night 2|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-London-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== New York ====
{|
| [[File:VideoSecreensaver-appletv-NewYork-D1.JPG|New York - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D2.JPG|New York - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D3.JPG|New York - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-NewYork-N1.JPG|London - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== San Francisco ====
{|
| [[File:VideoSecreensaver-appletv-SanFrancisco-D1.JPG|San Francisco - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D2.JPG|San Francisco - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D3.JPG|San Francisco - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-D4.JPG|San Francisco - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D5.JPG|San Francisco - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D6.JPG|San Francisco - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N1.JPG|San Francisco - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N2.JPG|San Francisco - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N3.JPG|San Francisco - Night 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N4.JPG|San Francisco - Night 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N5.JPG|San Francisco - Night 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N6.JPG|San Francisco - Night 6|none|thumb|250px]]
|}

=== Aquarium Collection ===
{|
| [[File:Aquarium001.png|Aquarium 1 - [846MB] - 400p|none|thumb|250px]]
| [[File:Aquarium002-720p.png|Aquarium 2 - [2.7GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium003.PNG|Aquarium 3 - [2.4GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Aquarium004.JPG|Aquarium 4 - [780MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium005.png|Aquarium 5 - [3.0GB] - 720p|none|thumb|250px]]
|}
=== Beach Collection ===
{|
| [[File:VideoScreensaver-Beach001.JPG|Beach 1 - [2.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach002.JPG|Beach 2 - [838MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach003.JPG|Beach 3 - [3.4GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Beach004.JPG|Beach 4 - [?.?GB] - 720p|none|thumb|250px]]
|}
=== Clock Collection ===
{|
| [[File:VideoScreensaver-Clock001.JPG|Clock 1 - [1.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Clock002.JPG|Clock 2 - [1.3GB] - 360p|none|thumb|250px]]
|}
=== Fireplace Collection ===
{|
| [[File:Fireplace001-720p.png|Fireplace 1 - [965MB] - 720p|none|thumb|250px]]
| [[File:Fireplace002.png|Fireplace 2 - [827MB] - 480p|none|thumb|182px]]
| [[File:Fireplace003-1080p.png|Fireplace 3 - [2.1GB] - 1080p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Fireplace004.PNG|Fireplace 4 - [2.7GB] - 720p|none|thumb|250px]]
|}
=== Miscellaneous Collection ===
{|
| [[File:VideoScreensaver-Christmas001.JPG|Christmas 1 - [777MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-JohnnyCastaway001.JPG|Johnny Castaway 1 - [75MB] - 480p|none|thumb|168px]]
| [[File:VideoScreensaver-Matrix001.JPG|Matrix 1 - [909MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Ocean001.JPG|Ocean 1 - [1.1GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-RetroSciFi001.JPG|Retro Sci-Fi 1 - [200MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-StarTrekTNG001.JPG|Star Trek TNG 1 - [54MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Watermill001.JPG|Watermill 1 - [549MB] - 1080p|none|thumb|250px]]
|}
=== Snow Collection ===
{|
| [[File:VideoScreensaver-Snow001.JPG|Snow 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow002.JPG|Snow 2 - [677MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow003.JPG|Snow 3 - [1.2GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Snow004.JPG|Snow 4 - [?.?GB] - 720p|none|thumb|250px]]
|}
=== Space Collection ===
{|
| [[File:VideoScreensaver-Space001.PNG|Space 1 - [970MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Space002.JPG|Space 2 - [563MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Space003.png|Space 3 - [2.2GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Space004.PNG|Space 4 - [?.?GB] - 720p|none|thumb|250px]]
|}
=== Waterfall Collection ===
{|
| [[File:VideoScreensaver-Waterfall001.JPG|Waterfall 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall002.JPG|Waterfall 2 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall003.JPG|Waterfall 3 - [2.4GB] - 720p|none|thumb|250px]]
|}
=== Woodland Collection ===
{|
| [[File:VideoScreensaver-Woodland001.JPG|Woodland 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Woodland002.JPG|Woodland 2 - [?.?GB] - 720p|none|thumb|250px]]
|}

 
 
== Built-In Overlay Images ==
The following overlay images are supplied with the addon.
{|
| [[File:PictureFrame1.png|Picture Frame 1|none|thumb|250px]]
| [[File:WindowFrame1.png|Window Frame 1|none|thumb|232px]]
| [[File:WindowFrame2.png|Window Frame 2|none|thumb|230px]]
|}
 
 
== Weather ==
VideoScreensaver can display the latest weather information in the top left hand corner of the screen if you wish. This feature makes use of the standard set of Weather addons available in the official Kodi repository, and can be configured via the VideoScreensaver settings.
 
 
== Clocks ==
VideoScreensaver has special handling for clock videos. This enables the correct current time to be displayed. This is assuming the video is either 12 hours (for an analog clock) or 24 hours (for a digial clock) and starts at midnight/12 o'clock. The built in "Clock" screensaver videos will handle this and show the correct time. If you have a custom video you wish to be shown as a clock, then this can be done my naming it with the name "clock" in the filename.
 
 
== Custom Collections ==
VideoScreensaver can handle the import of custom collections. This allows users to make their own collections of videos and make them available for others to share. The file format to import is as follows:

<source lang="xml">
<videoscreensaver>
<collection>Collection Name</collection>
<video>
<name>Video Name 1</name>
<filename>collection-filename1.mkv</filename>
<image>http://location/of/fame-image1.png</image>
<duration>3602</duration>
<primary>http://location/of/video2.mkv</primary>
</video>
<video>
<name>Video Name 2</name>
<filename>collection-filename2.mkv</filename>
<image>http://location/of/fame-image2.png</image>
<duration>2000</duration>
<primary>http://location/of/video1.mkv</primary>
</video>
</videoscreensaver>
</source>

As many "video" elements can be added as required for the collection. The filename should be unique from the other video files available, it is advised that the name of the collection is pre-pended to the filename. The "image" and duration elements are optional and the primary element contains the full URL to the source video file.

This file can then be imported via the Video -> Addons -> VideoScreensaver menu item.
 
 
== Schedule ==
It is possible to schedule which video is used at which time of day via the [[Add-on:VideoScreensaver#Schedule_2|Schedule Settings]]. The rules to apply for schedules can either be defined directly in the settings, or defined in an XML file which is then referenced from the settings.

<source lang="xml">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<schedule>
<rule id="1" start="10:24" end="14:37" day="monday", video="myvideo.mkv" overlay="myoverlay.png" />
<rule id="2" start="16:00" end="18:00" video="myvideo2.mkv" overlay="myoverlay2.png" />
</schedule>
</source>

The "day" attribute is optional and if set must be one of the values (monday, tuesday, wednesday, thursday, friday, saturday, sunday), the default is every day

If no video is specified in the schedule settings, then it will fall back to the default rules from the screensaver settings.
 
 
== Settings ==
This section details all the settings options for VideoScreensaver
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Use All Files In A Folder'''
::Will play a selection of video files from a directory instead of a single file
:'''Limit Session To Single Collection/Folder'''
::When the screensaver starts it will only play videos that are part of a single collection or folder on the file system.
:'''Include Nested Folders'''
::Will include video files from sub directories as well as the root directory
:'''Select Video Folder/File'''
::Prompts for the video files to use as a screensaver
:'''Repeat Type For Multiple Files'''
::Repeat All - Will loop through all the videos in the folder
::Repeat One - Will randomly select one video and keep repeating that video
:'''Overlay Image'''
::Allows for either a built in or user defined image to be overlayed on top of the video file
| [[File:Settings1.JPG|400px]]
|}

=== Configuration ===
{| border="0"
|- valign=top
|
:'''Show Time'''
::Displays the current time and data in the top right hand corner when the screensaver is active
:'''Show Weather'''
::Displays weather information in the top left hand corner
:'''- Select Weather Addon'''
::Selects the weather addon to display the weather details
:'''Start Video At Random Point'''
::When the video starts, will start at a random point into the duration of the video
:'''Prevent Screensaver Starting If Playing Media'''
::If there is media playing (i.e. Music or Video) and the screensaver is due to start, then if this is enabled, the screensaver will be prevented from starting.
:'''Change Volume When Screensaver Starts'''
::Allow the volume to be changed when the screensaver starts
:'''- Set Volume To'''
::The value to set the volume to when the screensaver starts
:'''- Use Audio Engine Suspend For 0 Volume'''
::If the screensaver volume is set to 0, then this option will suspend the Kodi Audio Engine rather than just reducing the volume to zero (This is useful if your system is set to passthrough audio)
:'''Dim Level'''
::How much to dim the screensaver video when it starts (0 = No Dim)
:'''Stop Screensaver Automatically'''
::Allow the screensaver to stop automatically after it has been playing for a given length of time. After stopping, the screensaver will start again after the default time of inactivity.
:'''- Stop Screensaver After (Minutes)'''
::Duration to let the screensaver play before stoping it
:'''- Shutdown After Automatic Stop'''
::After automatic shutdown has been triggered perform the default shutdown method set in the System -> Power Saving -> Shutdown Function
| [[File:Settings4.JPG|400px]]
|}

=== Startup ===
{| border="0"
|- valign=top
|
:'''Reset Volume On Startup'''
::Will reset the Kodi volume on startup of the system - this is useful if you always run your system at a set volume and use the TV or external audio system to change the volume (This way if the system crashes while playing a Video Screensaver, it will not leave the volume in an inconsistent state)
:'''- Set Volume On Startup To'''
::The value to set the Kodi volume to on startup
:'''Launch Screensaver On Startup'''
::When Kodi first starts the screensaver will start playing
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables VideoScreensaver debug logging into the Kodi log file
| [[File:VideoScreensaver-Settings5.JPG|400px]]
|}

=== Schedule ===
{| border="0"
|- valign=top
|
:'''Schedule Settings'''
::This can take the following values: Off (No scheduling enabled), Settings (Configure via the settings menu, see options below) and File (Load configuration from a file, see the [[Add-on:VideoScreensaver#Schedule|schedule section]])
:'''Number Of Schedule Rules'''
::The number of different schedule rules to be configured
:'''''Rule X'''''
::
:'''Start Time'''
::The time of day that this rule starts being used
:'''Stop Time'''
::The time of day that this rule stops being used
:'''Day'''
::The day of the week that this rule starts being used
:'''Select Video File'''
::The video file to play while this rule is active
:'''Overlay Image'''
::The overlay image to use while this rule is active
| [[File:VideoScreensaver-Settings6.JPG|400px]]
|}

 
 
== Detecting If VideoScreensaver Is Running ==
The way that VideoScreensaver has been implemented in order to play a video as a screensaver, it will not be recorded via the normal "xbmc.Monitor" onScreensaverActivated() or onScreensaverDeactivated() method. In fact when the screensaver starts you will get both an onScreensaverActivated() and onScreensaverDeactivated() message before the VideoScreensaver starts playing.
 
If you wanted to work out if VideoScreensaver is active from another script then you can check for the "VideoScreensaverRunning" property being set:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverRunning")</source>
This will return the value "true" if it is running.
 
It is also worth noting, that while the screensaver is starting up it will set the "VideoScreensaverStarting" property, that can be checked as follows:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverStarting")</source>
This will return the value "true" if it is currently starting.
 
 
== Known Issues ==
=== Auto-Shutdown Will Not Activate While VideoScreensaver Is Running ===
If you enable Kodi Auto-Shutdown options in Kodi System Settings they will not trigger while VideoScreensaver is active - this is because the video being played as part of the screensaver will make Kodi "active". The impact of this can be lessened by enabling "Stop Screensaver Automatically" and setting "Shutdown After Automatic Stop"
=== Changing Screensaver volume will not work when using audio Pass-Through ===
If you have Audio-Passthrough enabled in your audio settings then the ability to reduce the volume of the screensaver will not function. This is because you have removed Kodi's control of the audio. If you wish to set the volume to zero, then there is an option to "[[Add-on:VideoScreensaver#Configuration|Suspend The Audio Engine]]"
=== Using password protected profiles will prompt before screensaver starts ===
If you have a password protected profile and try and launch VideoScreensaver, then you will be prompted for the password '''''before''''' the screensaver starts instead of after. One alternative is to use [[Add-on:PinSentry|PinSentry]] instead of profiles.
 
 

== FAQ ==
=== Where are the built in videos stored after download? ===
The location of the video files will vary depending on the OS where Kodi is installed. The location can be retrieved by switching the "Video Selection" option in settings to "User Defined". This will then display the full path in the "Select Videos Folder/File" setting.
=== Can Kodi play music or radio while showing a screensaver video? ===
Unfortunately this is not possible. This is because Kodi can only play one media type at a time.
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* VideoScreensaver debug from the VideoScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the VideoScreensaver Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]

Add-on:VideoScreensaver

2016-08-28T14:52:22Z

Rob webset:

{{Addon
|Name=VideoScreensaver
|provider-name=robwebset
|ID=screensaver.video
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Screensaver that plays a video file
|Description=Plays a video when the screensaver starts, this can be a custom video or one of the built in videos
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=210943
|Website=
|Source=https://github.com/robwebset/screensaver.video
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.video/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
VideoScreensaver is a screensaver that will play a video file when the screensaver starts. It will support playing either a user specified video file, or one of several pre-defined video files.
 
 
== Forum And Issue Report Pages ==
If you have any questions, found an issue to report or would just like to know a little more you can take part in the forum discussions at:

[http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]
 
 
== Built-In Screensaver Videos ==
The following screensaver videos are supplied with the addon. They can be enabled, downloaded and previewed via the Video -> Addons -> VideoScreensaver menu. There is a context menu that allows you to preview and remove each screensaver video.

=== Apple TV Collection ===
==== China ====
{|
| [[File:VideoSecreensaver-appletv-China-D1.JPG|China - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D2.JPG|China - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D3.JPG|China - Day 3|none|thumb|250px]]
|}
==== Hawaii ====
{|
| [[File:VideoSecreensaver-appletv-Hawaii-D1.JPG|Hawaii - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D2.JPG|Hawaii - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D3.JPG|Hawaii - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-D4.JPG|Hawaii - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D5.JPG|Hawaii - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D6.JPG|Hawaii - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-N1.JPG|Hawaii - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-N2.JPG|Hawaii - Night 2|none|thumb|250px]]
|}
==== London ====
{|
| [[File:VideoSecreensaver-appletv-London-D1.JPG|London - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-D2.JPG|London - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N1.JPG|London - Night 2|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-London-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== New York ====
{|
| [[File:VideoSecreensaver-appletv-NewYork-D1.JPG|New York - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D2.JPG|New York - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D3.JPG|New York - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-NewYork-N1.JPG|London - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== San Francisco ====
{|
| [[File:VideoSecreensaver-appletv-SanFrancisco-D1.JPG|San Francisco - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D2.JPG|San Francisco - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D3.JPG|San Francisco - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-D4.JPG|San Francisco - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D5.JPG|San Francisco - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D6.JPG|San Francisco - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N1.JPG|San Francisco - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N2.JPG|San Francisco - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N3.JPG|San Francisco - Night 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N4.JPG|San Francisco - Night 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N5.JPG|San Francisco - Night 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N6.JPG|San Francisco - Night 6|none|thumb|250px]]
|}

=== Aquarium Collection ===
{|
| [[File:Aquarium001.png|Aquarium 1 - [846MB] - 400p|none|thumb|250px]]
| [[File:Aquarium002-720p.png|Aquarium 2 - [2.7GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium003.PNG|Aquarium 3 - [2.4GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Aquarium004.JPG|Aquarium 4 - [780MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium005.png|Aquarium 5 - [3.0GB] - 720p|none|thumb|250px]]
|}
=== Beach Collection ===
{|
| [[File:VideoScreensaver-Beach001.JPG|Beach 1 - [2.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach002.JPG|Beach 2 - [838MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach003.JPG|Beach 3 - [3.4GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach004.JPG|Beach 4 - [?.?GB] - 720p|none|thumb|250px]]
|}
=== Clock Collection ===
{|
| [[File:VideoScreensaver-Clock001.JPG|Clock 1 - [1.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Clock002.JPG|Clock 2 - [1.3GB] - 360p|none|thumb|250px]]
|}
=== Fireplace Collection ===
{|
| [[File:Fireplace001-720p.png|Fireplace 1 - [965MB] - 720p|none|thumb|250px]]
| [[File:Fireplace002.png|Fireplace 2 - [827MB] - 480p|none|thumb|182px]]
| [[File:Fireplace003-1080p.png|Fireplace 3 - [2.1GB] - 1080p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Fireplace004.PNG|Fireplace 4 - [2.7GB] - 720p|none|thumb|250px]]
|}
=== Miscellaneous Collection ===
{|
| [[File:VideoScreensaver-Christmas001.JPG|Christmas 1 - [777MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-JohnnyCastaway001.JPG|Johnny Castaway 1 - [75MB] - 480p|none|thumb|168px]]
| [[File:VideoScreensaver-Matrix001.JPG|Matrix 1 - [909MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Ocean001.JPG|Ocean 1 - [1.1GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-RetroSciFi001.JPG|Retro Sci-Fi 1 - [200MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-StarTrekTNG001.JPG|Star Trek TNG 1 - [54MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Watermill001.JPG|Watermill 1 - [549MB] - 1080p|none|thumb|250px]]
|}
=== Snow Collection ===
{|
| [[File:VideoScreensaver-Snow001.JPG|Snow 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow002.JPG|Snow 2 - [677MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow003.JPG|Snow 3 - [1.2GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow004.JPG|Snow 4 - [?.?GB] - 720p|none|thumb|250px]]
|}
=== Space Collection ===
{|
| [[File:VideoScreensaver-Space001.PNG|Space 1 - [970MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Space002.JPG|Space 2 - [563MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Space003.png|Space 3 - [2.2GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Space004.PNG|Space 4 - [?.?GB] - 720p|none|thumb|250px]]
|}
=== Waterfall Collection ===
{|
| [[File:VideoScreensaver-Waterfall001.JPG|Waterfall 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall002.JPG|Waterfall 2 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall003.JPG|Waterfall 3 - [2.4GB] - 720p|none|thumb|250px]]
|}
=== Woodland Collection ===
{|
| [[File:VideoScreensaver-Woodland001.JPG|Woodland 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Woodland002.JPG|Woodland 2 - [?.?GB] - 720p|none|thumb|250px]]
|}

 
 
== Built-In Overlay Images ==
The following overlay images are supplied with the addon.
{|
| [[File:PictureFrame1.png|Picture Frame 1|none|thumb|250px]]
| [[File:WindowFrame1.png|Window Frame 1|none|thumb|232px]]
| [[File:WindowFrame2.png|Window Frame 2|none|thumb|230px]]
|}
 
 
== Weather ==
VideoScreensaver can display the latest weather information in the top left hand corner of the screen if you wish. This feature makes use of the standard set of Weather addons available in the official Kodi repository, and can be configured via the VideoScreensaver settings.
 
 
== Clocks ==
VideoScreensaver has special handling for clock videos. This enables the correct current time to be displayed. This is assuming the video is either 12 hours (for an analog clock) or 24 hours (for a digial clock) and starts at midnight/12 o'clock. The built in "Clock" screensaver videos will handle this and show the correct time. If you have a custom video you wish to be shown as a clock, then this can be done my naming it with the name "clock" in the filename.
 
 
== Custom Collections ==
VideoScreensaver can handle the import of custom collections. This allows users to make their own collections of videos and make them available for others to share. The file format to import is as follows:

<source lang="xml">
<videoscreensaver>
<collection>Collection Name</collection>
<video>
<name>Video Name 1</name>
<filename>collection-filename1.mkv</filename>
<image>http://location/of/fame-image1.png</image>
<duration>3602</duration>
<primary>http://location/of/video2.mkv</primary>
</video>
<video>
<name>Video Name 2</name>
<filename>collection-filename2.mkv</filename>
<image>http://location/of/fame-image2.png</image>
<duration>2000</duration>
<primary>http://location/of/video1.mkv</primary>
</video>
</videoscreensaver>
</source>

As many "video" elements can be added as required for the collection. The filename should be unique from the other video files available, it is advised that the name of the collection is pre-pended to the filename. The "image" and duration elements are optional and the primary element contains the full URL to the source video file.

This file can then be imported via the Video -> Addons -> VideoScreensaver menu item.
 
 
== Schedule ==
It is possible to schedule which video is used at which time of day via the [[Add-on:VideoScreensaver#Schedule_2|Schedule Settings]]. The rules to apply for schedules can either be defined directly in the settings, or defined in an XML file which is then referenced from the settings.

<source lang="xml">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<schedule>
<rule id="1" start="10:24" end="14:37" day="monday", video="myvideo.mkv" overlay="myoverlay.png" />
<rule id="2" start="16:00" end="18:00" video="myvideo2.mkv" overlay="myoverlay2.png" />
</schedule>
</source>

The "day" attribute is optional and if set must be one of the values (monday, tuesday, wednesday, thursday, friday, saturday, sunday), the default is every day

If no video is specified in the schedule settings, then it will fall back to the default rules from the screensaver settings.
 
 
== Settings ==
This section details all the settings options for VideoScreensaver
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Use All Files In A Folder'''
::Will play a selection of video files from a directory instead of a single file
:'''Limit Session To Single Collection/Folder'''
::When the screensaver starts it will only play videos that are part of a single collection or folder on the file system.
:'''Include Nested Folders'''
::Will include video files from sub directories as well as the root directory
:'''Select Video Folder/File'''
::Prompts for the video files to use as a screensaver
:'''Repeat Type For Multiple Files'''
::Repeat All - Will loop through all the videos in the folder
::Repeat One - Will randomly select one video and keep repeating that video
:'''Overlay Image'''
::Allows for either a built in or user defined image to be overlayed on top of the video file
| [[File:Settings1.JPG|400px]]
|}

=== Configuration ===
{| border="0"
|- valign=top
|
:'''Show Time'''
::Displays the current time and data in the top right hand corner when the screensaver is active
:'''Show Weather'''
::Displays weather information in the top left hand corner
:'''- Select Weather Addon'''
::Selects the weather addon to display the weather details
:'''Start Video At Random Point'''
::When the video starts, will start at a random point into the duration of the video
:'''Prevent Screensaver Starting If Playing Media'''
::If there is media playing (i.e. Music or Video) and the screensaver is due to start, then if this is enabled, the screensaver will be prevented from starting.
:'''Change Volume When Screensaver Starts'''
::Allow the volume to be changed when the screensaver starts
:'''- Set Volume To'''
::The value to set the volume to when the screensaver starts
:'''- Use Audio Engine Suspend For 0 Volume'''
::If the screensaver volume is set to 0, then this option will suspend the Kodi Audio Engine rather than just reducing the volume to zero (This is useful if your system is set to passthrough audio)
:'''Dim Level'''
::How much to dim the screensaver video when it starts (0 = No Dim)
:'''Stop Screensaver Automatically'''
::Allow the screensaver to stop automatically after it has been playing for a given length of time. After stopping, the screensaver will start again after the default time of inactivity.
:'''- Stop Screensaver After (Minutes)'''
::Duration to let the screensaver play before stoping it
:'''- Shutdown After Automatic Stop'''
::After automatic shutdown has been triggered perform the default shutdown method set in the System -> Power Saving -> Shutdown Function
| [[File:Settings4.JPG|400px]]
|}

=== Startup ===
{| border="0"
|- valign=top
|
:'''Reset Volume On Startup'''
::Will reset the Kodi volume on startup of the system - this is useful if you always run your system at a set volume and use the TV or external audio system to change the volume (This way if the system crashes while playing a Video Screensaver, it will not leave the volume in an inconsistent state)
:'''- Set Volume On Startup To'''
::The value to set the Kodi volume to on startup
:'''Launch Screensaver On Startup'''
::When Kodi first starts the screensaver will start playing
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables VideoScreensaver debug logging into the Kodi log file
| [[File:VideoScreensaver-Settings5.JPG|400px]]
|}

=== Schedule ===
{| border="0"
|- valign=top
|
:'''Schedule Settings'''
::This can take the following values: Off (No scheduling enabled), Settings (Configure via the settings menu, see options below) and File (Load configuration from a file, see the [[Add-on:VideoScreensaver#Schedule|schedule section]])
:'''Number Of Schedule Rules'''
::The number of different schedule rules to be configured
:'''''Rule X'''''
::
:'''Start Time'''
::The time of day that this rule starts being used
:'''Stop Time'''
::The time of day that this rule stops being used
:'''Day'''
::The day of the week that this rule starts being used
:'''Select Video File'''
::The video file to play while this rule is active
:'''Overlay Image'''
::The overlay image to use while this rule is active
| [[File:VideoScreensaver-Settings6.JPG|400px]]
|}

 
 
== Detecting If VideoScreensaver Is Running ==
The way that VideoScreensaver has been implemented in order to play a video as a screensaver, it will not be recorded via the normal "xbmc.Monitor" onScreensaverActivated() or onScreensaverDeactivated() method. In fact when the screensaver starts you will get both an onScreensaverActivated() and onScreensaverDeactivated() message before the VideoScreensaver starts playing.
 
If you wanted to work out if VideoScreensaver is active from another script then you can check for the "VideoScreensaverRunning" property being set:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverRunning")</source>
This will return the value "true" if it is running.
 
It is also worth noting, that while the screensaver is starting up it will set the "VideoScreensaverStarting" property, that can be checked as follows:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverStarting")</source>
This will return the value "true" if it is currently starting.
 
 
== Known Issues ==
=== Auto-Shutdown Will Not Activate While VideoScreensaver Is Running ===
If you enable Kodi Auto-Shutdown options in Kodi System Settings they will not trigger while VideoScreensaver is active - this is because the video being played as part of the screensaver will make Kodi "active". The impact of this can be lessened by enabling "Stop Screensaver Automatically" and setting "Shutdown After Automatic Stop"
=== Changing Screensaver volume will not work when using audio Pass-Through ===
If you have Audio-Passthrough enabled in your audio settings then the ability to reduce the volume of the screensaver will not function. This is because you have removed Kodi's control of the audio. If you wish to set the volume to zero, then there is an option to "[[Add-on:VideoScreensaver#Configuration|Suspend The Audio Engine]]"
=== Using password protected profiles will prompt before screensaver starts ===
If you have a password protected profile and try and launch VideoScreensaver, then you will be prompted for the password '''''before''''' the screensaver starts instead of after. One alternative is to use [[Add-on:PinSentry|PinSentry]] instead of profiles.
 
 

== FAQ ==
=== Where are the built in videos stored after download? ===
The location of the video files will vary depending on the OS where Kodi is installed. The location can be retrieved by switching the "Video Selection" option in settings to "User Defined". This will then display the full path in the "Select Videos Folder/File" setting.
=== Can Kodi play music or radio while showing a screensaver video? ===
Unfortunately this is not possible. This is because Kodi can only play one media type at a time.
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* VideoScreensaver debug from the VideoScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the VideoScreensaver Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]

File:VideoScreensaver-Woodland002.JPG

2016-08-28T14:49:56Z

Rob webset: MsUpload

MsUpload

File:VideoScreensaver-Snow004.JPG

2016-08-28T14:49:54Z

Rob webset: MsUpload

MsUpload

File:VideoScreensaver-Space004.PNG

2016-08-28T14:49:52Z

Rob webset: MsUpload

MsUpload

File:VideoScreensaver-Beach004.JPG

2016-08-28T14:49:46Z

Rob webset: MsUpload

MsUpload

Add-on:Sleep

2016-08-26T15:48:41Z

Rob webset:

{{Addon
|Name=Sleep
|provider-name=robwebset
|ID=script.sleep
|extension point=xbmc.python.script
|provides=
|Summary=A TV like sleep timer
|Description=Add improved sleep behaviour to your Kodi system, allowing the system to shut down after a certain amount of time.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=261959
|Website=
|Source=https://github.com/robwebset/script.sleep
|Email=
|broken=
|icon url=https://github.com/robwebset/script.sleep/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The Sleep addon provides support to automatically shutdown/suspend Kodi in a similar manner to the traditional TV Sleep Timers. If has many additional features and can be launch by any of the following methods:
* From the "Programs" area of Kodi
* As a screensaver
* Via a remote control or keyboard button (Configurable which button)
 
 
== The Sleep Dialog ==
<center>[[File:Sleep-Dialog.JPG|Sleep Timer Dialog|none|thumb|300px]]</center>
The dialog to control the Sleep Addon is designed to be as simple as possible. When the dialog first opens it will show the sleep timer as disabled, the timer can be extended, by default in ten minute intervals (configurable in the settings), by performing either of the following actions:
* Pressing the configured remote or keyboard button again (For each press it will extend the timer)
* Selecting the "+10" button on the dialog
If the sleep timer is currently set if can be reduced or cancelled by selecting either the "-10" button or the cancel button.
 
The sleep timer will also allow you to have Kodi shutdown after a video finishes playing. If there is a video playing when the sleep timer is set, it will shutdown after it completes. If there is not currently a video playing it will shutdown after the next played video completes. (Note: The Sleep timer will only shutdown the system if the video completes playing, if the video is stopped manually, then sleep timer will not shutdown - this is by design).
 
 
== Shutdown Warnings ==
When the Sleep timer is about to expire and shutdown the system it will again display the shutdown dialog with a progress bar showing how long it is until the shutdown will commence. While this dialog is displayed the timer can be:
* Extended (In the same manner as it was originally set)
* Cancelled (By selecting the cancel button)
* Left to expire and shutdown Kodi.
In addition to the shutdown dialog, it is possible to configure the Sleep Addon to display a notification of how long is left before shutdown will be performed (for example 30, 20, 10 minutes left).
 
 
== Remote Control or Keyboard Setup ==
It is possible to configure the Sleep Addon to response to a keyboard or remote control button press. This can be done by either selecting one of the predefined options in the Addon settings or have the Sleep Addon auto detect a key/button press and then use that to allow you to control the Sleep Addon. This can be configured from the Sleep Addon Settings.
 
 
== Sleep After Idle Period ==
If you with to have the Sleep Addon detect when the system has been idle for a set period of time, and then start the notification for shutdown, this can be done by selecting Sleep as your chosen screensaver, then when the screensaver triggers, it will display the Sleep shutdown dialog.
 
 
== Settings ==
=== Sleep ===
{| border="0"
|- valign=top
|
:'''Sleep Interval Length (Minutes)'''
::How much to increase or decrease the time when the +/- button is pressed of the configured sleep key
:'''Warning Length (Seconds)'''
::How long to display the warning dialog before shutdown
:'''Maximum Sleep Time (Minutes)'''
::The maximum time that the timer can be set for, after that time the timer will loop from zero again
:'''Pause Video When Displaying Timer Dialog'''
::If the timer dialog is displayed while a video is playing, should the video be paused?
:'''Shutdown Earlier If Screensaver Starts'''
::If the timer has been set, and the screensaver starts, trigger shutdown
:'''Display Sleep Reminders'''
::If reminders for how much time remains before shutdown are required
:'''- Start Showing Reminders For Last (Minutes)'''
::If reminders are set, when they should start being displayed
:'''- Frequency To Display Reminder (Minutes)'''
::If reminders are set, how often they should be displayed
:'''Dim Screen'''
::If the timer has been set, dim the screen so that it is darker - aka "Night Time Mode"
| [[File:Sleep-Settings1.JPG|400px]]
|}
=== Controls ===
{| border="0"
|- valign=top
|
:'''Button Selection'''
::Choose which button to map to the Sleep command. Either None, Mute, Astrisk (*) or Custom
:'''Automatic Button Detection'''
::Allows a button to be automatically detected by the Sleep Addon and used to control it
:'''Manual Detection'''
::For advanced users only - allows the manual codes to be entered
| [[File:Sleep-Settings2.JPG|400px]]
|}
=== Advanced ===
{| border="0"
|- valign=top
|
:'''Shutdown Behaviour'''
::Allows the operation that is performed when the timer expires to be change.
::''Default Shutdown'' - Performs the shutdown set in the Kodi System Settings
::''HTTP Request'' - Makes a call to the given URL
::''Screensaver'' - Stats the Kodi screensaver
::''Scripts'' - Runs the given python script
:'''''Setup'''''
::
:'''Debugging'''
::Enables Sleep debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
| [[File:Sleep-Settings3.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* Sleep Addon debug from the Sleep addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the Sleep Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=261959 Sleep Forum]

Add-on:AddonSync

2016-08-20T15:07:07Z

Rob webset:

{{Addon
|Name=AddonSync
|provider-name=robwebset
|ID=service.addonsync
|extension point=xbmc.service
|provides=
|Summary=Synchronise Addon Settings Between Different Installations
|Description=Keep all Addon settings in sync across all of your installations
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=260802
|Website=
|Source=https://github.com/robwebset/service.addonsync
|Email=
|broken=
|icon url=https://github.com/robwebset/service.addonsync/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The AddonSync service allows you to set one of your Kodi installations as the "Master" and have all the other installations be Slaves. Then you can have the master installation upload to a network share, and the slave installation download them.
 
 
== Setup ==
AddonSync works on a "Master" and "Slave" approach. There can be only a single Master installation, and any number of slave installations. First set up the Master installation, this will backup all of your addon settings to a shared location.
 
 
Once you have your Master installation backing up it's settings to a shared location you can configure any number of other installations to act as slaves and update their own settings from the master copy.
 
 
== Settings ==
=== AddonSync ===
{| border="0"
|- valign=top
|
:'''Installation Type'''
::If this Kodi installation should work as the Master or Slave
:'''Central Store Location'''
::The location where AddonSync should store the addons data it needs to synchronise
:'''Run On Startup'''
::If AddonSync should backup/restore when Kodi first starts up
:'''Update Interval (Minutes)'''
::How often AddonSync should check to see if any settings have changed
:'''Restart Updated Service Addons'''
::If running as a slave and a service addon is updated, restart it to pick up the changes
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables AddonSync debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
:'''''Operations'''''
::
:'''Run Synchronisation Now'''
::Manually run the synchronise operation
| [[File:AddonSync-Settings1.JPG|400px]]
|}
=== Filter ===
{| border="0"
|- valign=top
|
:'''Addon Synchronise Selection'''
::Allows either All addons to be synchronise, or to include/exclude a set of addons
:'''Select Addons'''
::If not all addons are being synchronised, then selectes those that are included/excluded
| [[File:AddonSync-Settings2.JPG|400px]]
|}

 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* AddonSync debug from the AddonSync addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the AddonSync Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=260802 AddonSync Forum]

Add-on:WeatherScreensaver

2016-08-20T15:02:57Z

Rob webset:

{{Addon
|Name=WeatherScreensaver
|provider-name=robwebset
|ID=screensaver.weather
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Weather Screensaver
|Description=Screensaver that displays the weather.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=233520
|Website=
|Source=https://github.com/robwebset/screensaver.weather
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.weather/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The WeatherScreensaver is an addon that you can select as your screensaver and will display the weather screen in Kodi.

It will display whichever Weather add-on you have configured via the [[Weather|Kodi System Settings]].
 
 
== Settings ==
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Dim Level'''
::Allows the configuration of how much the screen should be dimmed when the screensaver starts
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables WeatherScreensaver debug logging into the Kodi log file
| [[File:WeatherScreensaver-Settings1.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* WeatherScreensaver debug from the WeatherScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the WeatherScreensaver Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=233520 WeatherScreensaver Forum]

Add-on:VideoScreensaver

2016-08-20T15:01:54Z

Rob webset:

{{Addon
|Name=VideoScreensaver
|provider-name=robwebset
|ID=screensaver.video
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Screensaver that plays a video file
|Description=Plays a video when the screensaver starts, this can be a custom video or one of the built in videos
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=210943
|Website=
|Source=https://github.com/robwebset/screensaver.video
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.video/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
VideoScreensaver is a screensaver that will play a video file when the screensaver starts. It will support playing either a user specified video file, or one of several pre-defined video files.
 
 
== Forum And Issue Report Pages ==
If you have any questions, found an issue to report or would just like to know a little more you can take part in the forum discussions at:

[http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]
 
 
== Built-In Screensaver Videos ==
The following screensaver videos are supplied with the addon. They can be enabled, downloaded and previewed via the Video -> Addons -> VideoScreensaver menu. There is a context menu that allows you to preview and remove each screensaver video.

=== Apple TV Collection ===
==== China ====
{|
| [[File:VideoSecreensaver-appletv-China-D1.JPG|China - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D2.JPG|China - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-China-D3.JPG|China - Day 3|none|thumb|250px]]
|}
==== Hawaii ====
{|
| [[File:VideoSecreensaver-appletv-Hawaii-D1.JPG|Hawaii - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D2.JPG|Hawaii - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D3.JPG|Hawaii - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-D4.JPG|Hawaii - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D5.JPG|Hawaii - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-D6.JPG|Hawaii - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-Hawaii-N1.JPG|Hawaii - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-Hawaii-N2.JPG|Hawaii - Night 2|none|thumb|250px]]
|}
==== London ====
{|
| [[File:VideoSecreensaver-appletv-London-D1.JPG|London - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-D2.JPG|London - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N1.JPG|London - Night 2|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-London-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-London-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== New York ====
{|
| [[File:VideoSecreensaver-appletv-NewYork-D1.JPG|New York - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D2.JPG|New York - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-D3.JPG|New York - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-NewYork-N1.JPG|London - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N2.JPG|London - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-NewYork-N3.JPG|London - Night 3|none|thumb|250px]]
|}
==== San Francisco ====
{|
| [[File:VideoSecreensaver-appletv-SanFrancisco-D1.JPG|San Francisco - Day 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D2.JPG|San Francisco - Day 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D3.JPG|San Francisco - Day 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-D4.JPG|San Francisco - Day 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D5.JPG|San Francisco - Day 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-D6.JPG|San Francisco - Day 6|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N1.JPG|San Francisco - Night 1|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N2.JPG|San Francisco - Night 2|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N3.JPG|San Francisco - Night 3|none|thumb|250px]]
|-
| [[File:VideoSecreensaver-appletv-SanFrancisco-N4.JPG|San Francisco - Night 4|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N5.JPG|San Francisco - Night 5|none|thumb|250px]]
| [[File:VideoSecreensaver-appletv-SanFrancisco-N6.JPG|San Francisco - Night 6|none|thumb|250px]]
|}

=== Aquarium Collection ===
{|
| [[File:Aquarium001.png|Aquarium 1 - [846MB] - 400p|none|thumb|250px]]
| [[File:Aquarium002-720p.png|Aquarium 2 - [2.7GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium003.PNG|Aquarium 3 - [2.4GB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Aquarium004.JPG|Aquarium 4 - [780MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Aquarium005.png|Aquarium 5 - [3.0GB] - 720p|none|thumb|250px]]
|}
=== Beach Collection ===
{|
| [[File:VideoScreensaver-Beach001.JPG|Beach 1 - [2.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach002.JPG|Beach 2 - [838MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Beach003.JPG|Beach 3 - [3.4GB] - 720p|none|thumb|250px]]
|}
=== Clock Collection ===
{|
| [[File:VideoScreensaver-Clock001.JPG|Clock 1 - [1.5GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Clock002.JPG|Clock 2 - [1.3GB] - 360p|none|thumb|250px]]
|}
=== Fireplace Collection ===
{|
| [[File:Fireplace001-720p.png|Fireplace 1 - [965MB] - 720p|none|thumb|250px]]
| [[File:Fireplace002.png|Fireplace 2 - [827MB] - 480p|none|thumb|182px]]
| [[File:Fireplace003-1080p.png|Fireplace 3 - [2.1GB] - 1080p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Fireplace004.PNG|Fireplace 4 - [2.7GB] - 720p|none|thumb|250px]]
|}
=== Miscellaneous Collection ===
{|
| [[File:VideoScreensaver-Christmas001.JPG|Christmas 1 - [777MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-JohnnyCastaway001.JPG|Johnny Castaway 1 - [75MB] - 480p|none|thumb|168px]]
| [[File:VideoScreensaver-Matrix001.JPG|Matrix 1 - [909MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Ocean001.JPG|Ocean 1 - [1.1GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-RetroSciFi001.JPG|Retro Sci-Fi 1 - [200MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-StarTrekTNG001.JPG|Star Trek TNG 1 - [54MB] - 720p|none|thumb|250px]]
|-
| [[File:VideoScreensaver-Watermill001.JPG|Watermill 1 - [549MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Woodland001.JPG|Woodland 1 - [1.3GB] - 720p|none|thumb|250px]]
|}
=== Snow Collection ===
{|
| [[File:VideoScreensaver-Snow001.JPG|Snow 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow002.JPG|Snow 2 - [677MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Snow003.JPG|Snow 3 - [1.2GB] - 720p|none|thumb|250px]]
|}
=== Space Collection ===
{|
| [[File:VideoScreensaver-Space001.PNG|Space 1 - [970MB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Space002.JPG|Space 2 - [563MB] - 1080p|none|thumb|250px]]
| [[File:VideoScreensaver-Space003.png|Space 3 - [2.2GB] - 720p|none|thumb|250px]]
|}
=== Waterfall Collection ===
{|
| [[File:VideoScreensaver-Waterfall001.JPG|Waterfall 1 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall002.JPG|Waterfall 2 - [1.3GB] - 720p|none|thumb|250px]]
| [[File:VideoScreensaver-Waterfall003.JPG|Waterfall 3 - [2.4GB] - 720p|none|thumb|250px]]
|}
 
 
== Built-In Overlay Images ==
The following overlay images are supplied with the addon.
{|
| [[File:PictureFrame1.png|Picture Frame 1|none|thumb|250px]]
| [[File:WindowFrame1.png|Window Frame 1|none|thumb|232px]]
| [[File:WindowFrame2.png|Window Frame 2|none|thumb|230px]]
|}
 
 
== Weather ==
VideoScreensaver can display the latest weather information in the top left hand corner of the screen if you wish. This feature makes use of the standard set of Weather addons available in the official Kodi repository, and can be configured via the VideoScreensaver settings.
 
 
== Clocks ==
VideoScreensaver has special handling for clock videos. This enables the correct current time to be displayed. This is assuming the video is either 12 hours (for an analog clock) or 24 hours (for a digial clock) and starts at midnight/12 o'clock. The built in "Clock" screensaver videos will handle this and show the correct time. If you have a custom video you wish to be shown as a clock, then this can be done my naming it with the name "clock" in the filename.
 
 
== Custom Collections ==
VideoScreensaver can handle the import of custom collections. This allows users to make their own collections of videos and make them available for others to share. The file format to import is as follows:

<source lang="xml">
<videoscreensaver>
<collection>Collection Name</collection>
<video>
<name>Video Name 1</name>
<filename>collection-filename1.mkv</filename>
<image>http://location/of/fame-image1.png</image>
<duration>3602</duration>
<primary>http://location/of/video2.mkv</primary>
</video>
<video>
<name>Video Name 2</name>
<filename>collection-filename2.mkv</filename>
<image>http://location/of/fame-image2.png</image>
<duration>2000</duration>
<primary>http://location/of/video1.mkv</primary>
</video>
</videoscreensaver>
</source>

As many "video" elements can be added as required for the collection. The filename should be unique from the other video files available, it is advised that the name of the collection is pre-pended to the filename. The "image" and duration elements are optional and the primary element contains the full URL to the source video file.

This file can then be imported via the Video -> Addons -> VideoScreensaver menu item.
 
 
== Schedule ==
It is possible to schedule which video is used at which time of day via the [[Add-on:VideoScreensaver#Schedule_2|Schedule Settings]]. The rules to apply for schedules can either be defined directly in the settings, or defined in an XML file which is then referenced from the settings.

<source lang="xml">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<schedule>
<rule id="1" start="10:24" end="14:37" day="monday", video="myvideo.mkv" overlay="myoverlay.png" />
<rule id="2" start="16:00" end="18:00" video="myvideo2.mkv" overlay="myoverlay2.png" />
</schedule>
</source>

The "day" attribute is optional and if set must be one of the values (monday, tuesday, wednesday, thursday, friday, saturday, sunday), the default is every day

If no video is specified in the schedule settings, then it will fall back to the default rules from the screensaver settings.
 
 
== Settings ==
This section details all the settings options for VideoScreensaver
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Use All Files In A Folder'''
::Will play a selection of video files from a directory instead of a single file
:'''Limit Session To Single Collection/Folder'''
::When the screensaver starts it will only play videos that are part of a single collection or folder on the file system.
:'''Include Nested Folders'''
::Will include video files from sub directories as well as the root directory
:'''Select Video Folder/File'''
::Prompts for the video files to use as a screensaver
:'''Repeat Type For Multiple Files'''
::Repeat All - Will loop through all the videos in the folder
::Repeat One - Will randomly select one video and keep repeating that video
:'''Overlay Image'''
::Allows for either a built in or user defined image to be overlayed on top of the video file
| [[File:Settings1.JPG|400px]]
|}

=== Configuration ===
{| border="0"
|- valign=top
|
:'''Show Time'''
::Displays the current time and data in the top right hand corner when the screensaver is active
:'''Show Weather'''
::Displays weather information in the top left hand corner
:'''- Select Weather Addon'''
::Selects the weather addon to display the weather details
:'''Start Video At Random Point'''
::When the video starts, will start at a random point into the duration of the video
:'''Prevent Screensaver Starting If Playing Media'''
::If there is media playing (i.e. Music or Video) and the screensaver is due to start, then if this is enabled, the screensaver will be prevented from starting.
:'''Change Volume When Screensaver Starts'''
::Allow the volume to be changed when the screensaver starts
:'''- Set Volume To'''
::The value to set the volume to when the screensaver starts
:'''- Use Audio Engine Suspend For 0 Volume'''
::If the screensaver volume is set to 0, then this option will suspend the Kodi Audio Engine rather than just reducing the volume to zero (This is useful if your system is set to passthrough audio)
:'''Dim Level'''
::How much to dim the screensaver video when it starts (0 = No Dim)
:'''Stop Screensaver Automatically'''
::Allow the screensaver to stop automatically after it has been playing for a given length of time. After stopping, the screensaver will start again after the default time of inactivity.
:'''- Stop Screensaver After (Minutes)'''
::Duration to let the screensaver play before stoping it
:'''- Shutdown After Automatic Stop'''
::After automatic shutdown has been triggered perform the default shutdown method set in the System -> Power Saving -> Shutdown Function
| [[File:Settings4.JPG|400px]]
|}

=== Startup ===
{| border="0"
|- valign=top
|
:'''Reset Volume On Startup'''
::Will reset the Kodi volume on startup of the system - this is useful if you always run your system at a set volume and use the TV or external audio system to change the volume (This way if the system crashes while playing a Video Screensaver, it will not leave the volume in an inconsistent state)
:'''- Set Volume On Startup To'''
::The value to set the Kodi volume to on startup
:'''Launch Screensaver On Startup'''
::When Kodi first starts the screensaver will start playing
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables VideoScreensaver debug logging into the Kodi log file
| [[File:VideoScreensaver-Settings5.JPG|400px]]
|}

=== Schedule ===
{| border="0"
|- valign=top
|
:'''Schedule Settings'''
::This can take the following values: Off (No scheduling enabled), Settings (Configure via the settings menu, see options below) and File (Load configuration from a file, see the [[Add-on:VideoScreensaver#Schedule|schedule section]])
:'''Number Of Schedule Rules'''
::The number of different schedule rules to be configured
:'''''Rule X'''''
::
:'''Start Time'''
::The time of day that this rule starts being used
:'''Stop Time'''
::The time of day that this rule stops being used
:'''Day'''
::The day of the week that this rule starts being used
:'''Select Video File'''
::The video file to play while this rule is active
:'''Overlay Image'''
::The overlay image to use while this rule is active
| [[File:VideoScreensaver-Settings6.JPG|400px]]
|}

 
 
== Detecting If VideoScreensaver Is Running ==
The way that VideoScreensaver has been implemented in order to play a video as a screensaver, it will not be recorded via the normal "xbmc.Monitor" onScreensaverActivated() or onScreensaverDeactivated() method. In fact when the screensaver starts you will get both an onScreensaverActivated() and onScreensaverDeactivated() message before the VideoScreensaver starts playing.
 
If you wanted to work out if VideoScreensaver is active from another script then you can check for the "VideoScreensaverRunning" property being set:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverRunning")</source>
This will return the value "true" if it is running.
 
It is also worth noting, that while the screensaver is starting up it will set the "VideoScreensaverStarting" property, that can be checked as follows:
<source lang="xml">xbmcgui.Window(10000).getProperty("VideoScreensaverStarting")</source>
This will return the value "true" if it is currently starting.
 
 
== Known Issues ==
=== Auto-Shutdown Will Not Activate While VideoScreensaver Is Running ===
If you enable Kodi Auto-Shutdown options in Kodi System Settings they will not trigger while VideoScreensaver is active - this is because the video being played as part of the screensaver will make Kodi "active". The impact of this can be lessened by enabling "Stop Screensaver Automatically" and setting "Shutdown After Automatic Stop"
=== Changing Screensaver volume will not work when using audio Pass-Through ===
If you have Audio-Passthrough enabled in your audio settings then the ability to reduce the volume of the screensaver will not function. This is because you have removed Kodi's control of the audio. If you wish to set the volume to zero, then there is an option to "[[Add-on:VideoScreensaver#Configuration|Suspend The Audio Engine]]"
=== Using password protected profiles will prompt before screensaver starts ===
If you have a password protected profile and try and launch VideoScreensaver, then you will be prompted for the password '''''before''''' the screensaver starts instead of after. One alternative is to use [[Add-on:PinSentry|PinSentry]] instead of profiles.
 
 

== FAQ ==
=== Where are the built in videos stored after download? ===
The location of the video files will vary depending on the OS where Kodi is installed. The location can be retrieved by switching the "Video Selection" option in settings to "User Defined". This will then display the full path in the "Select Videos Folder/File" setting.
=== Can Kodi play music or radio while showing a screensaver video? ===
Unfortunately this is not possible. This is because Kodi can only play one media type at a time.
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* VideoScreensaver debug from the VideoScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the VideoScreensaver Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=210943 VideoScreensaver Forum]

Add-on:VideoExtras

2016-08-20T15:00:36Z

Rob webset:

{{Addon
|Name=VideoExtras
|provider-name=robwebset
|ID=script.videoextras
|extension point=xbmc.python.script
|provides=
|Summary=Add Video Extras to your Movies and TV shows.
|Description=Provides a way to add Video Extras to your Video library. Look at the wiki for setup instructions.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=214289
|Website=
|Source=https://github.com/robwebset/script.videoextras
|Email=
|broken=
|icon url=https://github.com/robwebset/script.videoextras/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
VideoExtras is an addon to allow you to store, list and play the "extras" for a given Movie or TV Series. (i.e. The extras that often come on DVD's or Blu-Rays)

:''Note:'' This Addon will allow you to view the Extras Videos you already own - it will NOT download extras for you from the internet. (Although there is an option to use YouTube and Vimeo to search and view for extra video content)
 
== Forum and Issue Report Pages ==
If you have any questions, found an issue to report or would just like to know a little more you can take part in the forum discussions at:

:[http://forum.kodi.tv/showthread.php?tid=214289 VideoExtras Forum]

 
== Quickstart Guide ==
This Quickstart guide is aimed at first time users of VideoExtras, who also have some freedom to re-arrange their video content to fit best with VideoExtras.
==== Install VideoExtras ====
VideoExtras is in the official repo, so you should be able to install it like any other addon.
==== Arranging Your Video Files ====
Although VideoExtras will support most structures (with various configuration changes), the easiest and best structure is as follows:

:''../<Movie Name>/<movie name>.ext''
:''../<Movie Name>/Extras/<extras name 1>.ext''
:''../<Movie Name>/Extras/<extras name 2>.ext''
:''...''
:where .ext is any video extension compatible with Kodi
More details of extras setup can be found in the [[Add-on:VideoExtras#File_Naming_Convention|File Naming Convention Section]]

==== Stopping The Extras Being Scanned Into Your Library ====
Now that you have copied your Extras files into the correct directories, you do not want them to be accidently picked up/scanned as a Movie or TV Series in their own right. To stop this you need to add "excludes" into the advancedsettings.xml file. This can be done for you by clicking on the [[Add-on:VideoExtras#Extras|"Update advancedsettings.xml File"]] operation on the first tab of the VideoExtras settings, or you could always do it yourself [[Add-on:VideoExtras#Kodi_File_Exclusions|manually]].
==== Scanning Media Into Your Library ====
Once you have updated the advancedsettings.xml file it should now be safe to perform any scans you wish to pull media into your library. At this point, the scanner should skip over any Extras files.
==== Viewing Your Extras ====
In order to view the Extras you have now stored with your Movies or TV Shows you will need one of the following 2 things:
* To update the default Confluence Skin, this can either be done [[Add-on:VideoExtras#Skin_Modifications|manually]] or by navigating to the Advanced tab of the VideoExtras settings and clicking on [[Add-on:VideoExtras#Advanced|"Update Confluence Skin"]].
* Use one of the non default [[Add-on:VideoExtras#Skins_With_Build_In_Support|skins that has built in support]] for VideoExtras
==== You Are Now Up And Running ====
That's it! You should now be able to navigate to your extras by either going to the Video Information Dialog for the given video, or by going via: ''[[Add-on:VideoExtras#Video_Extras_Browser|Videos -> Addons -> VideoExtras]]''
 
There are plenty more things you can do to improve your user experience such as adding [[Add-on:VideoExtras#Images:_Thumbnails.2C_Icons_and_Fanart|icons/fanart/thumbnails]] or giving detailed [[Add-on:VideoExtras#NFO_Files|titles or plots]]. However, this is a quickstart guide, and you should take a look at the rest of the wiki for those features.
 
 
== Using VideoExtras ==
Now that you have [[Add-on:VideoExtras#Quickstart_Guide|configured]] VideoExtras, you can start using it. If you are using Confluence with the supplied [[Add-on:VideoExtras#Viewing_Your_Extras|Confluence update]] then any Movies or TV Shows that have extras will be highlighted with an overlay image:
<center> [[File:VideoExtras-ThumbnailOverlay.JPG|VideoExtras Overlay|center|thumb|200px]]</center>
 Then if you navigate into the Video Information Screen you should see an Extras button available:
<center> [[File:VideoExtras-VideoInfoDialog.JPG|VideoExtras Button (Video Information Screen)|center|thumb|400px]]</center>
 Selecting this button will then result in seeing the list of extras available:
<center> [[File:VideoExtras-DetailedListScreen.JPG|VideoExtras - Extras list|center|thumb|400px]]</center>
 
 

== Video Extras Browser ==
The VideoExtras browser allows you to view all the Movies/Tv Shows/Music Videos that have extras, and then watch those extras. You can load the extras browser in the following ways:
# Via the [[Add-on:VideoExtras#Database|VideoExtras Settings screen]] "Database" -> "Browse Extras"
# From the Programs Menu -> VideoExtras
# Videos -> Addons -> VideoExtras
 
 
== Online Video Platforms Support ==
{| border="0"
|- valign=top
|
It you have the '''[[Add-on:YouTube|YouTube]]''' or '''[[Add-on:Vimeo|Vimeo]]''' addons installed and the options enabled in the [[Add-on:VideoExtras#Advanced|settings]] you can be forwarded directly to the videos that would result in a search of "<Movie Name> Extras", or by calling up the context menu there are options to search for other parameters.
|[[File:VideoExtras Youtube Support.png|VideoExtras Youtube Support|right|thumb|400px]]
[[File:VideoExtras Vimeo Support.png|VideoExtras Vimeo Support|right|thumb|400px]]
|}
 
 

== Settings ==
This section details all the settings options for VideoExtras
==== Extras ====
{| border="0"
|- valign=top
|
:'''Extras Directory Name'''
::The name of the sub directory that stores all the extras files
:'''Search Nested Directories'''
::If directories below the selected TV Show or Movie should be searched for more extras. This is useful if you select a given TV Show and have all your seasons for that show in separate directories under that show. This means that all extras will be displayed when viewed via the root TV Show, and only the seasons extras if selected from inside a given season.
:'''Enable Extras with File Tag'''
::Finds extras based on a "tag", listing anything containing that tag
:'''Extras File Name Tag'''
::If "Enable Extras with File Tag" was enabled, this gives the name to search for as the tag
:'''Use Detailed List Screen'''
::Displays a more advanced listing screen which displays resume points and a watched flag
:'''Window to show after exiting detailed list'''
::(If detailed list screen is enabled) - Which screen to go to after exiting the detailed list screen, options are: "Video Selection", "Information", "Home"
:'''Menu to show after playing an extra'''
::(If detailed list screen is disabled) - Which screen to go to after playing an extra, options are: "Extras", "Video Selection", "Information", "Home"
:'''''Operations'''''
::
:'''Update advancedsettings.xml File'''
::Will update (or create if it does not already exist) the advancedsettings.xml file so that your extras files are not accidently read into the library and incorrectly detected as actual Movies or TV Shows
| [[File:VideoExtras-Settings1.JPG|VideoExtras Settings - Extras tab|right|thumb|400px]]
|}

==== File System ====
{| border="0"
|- valign=top
|
:'''Use Custom Extras Location'''
::If extras are not stored with the Movies/TV Shows, this allows them to be stored in a different directory structure.
:'''Path'''
::The path that the extras are located in (Only if ''"Use Custom Extras Location"'' is enabled)
:'''Custom Movies Sub-Folder'''
::The name of the folder under the ''"Path"'' where Movie extras are stored (Note: a directory with the movie name will be located under this directory containing the extras for that movie)
:'''Custom TV Shows Sub-Folder'''
::The name of the folder under the ''"Path"'' where TV Shows extras are stored (Note: a directory with the TV Show name will be located under this directory containing the extras for that TV Show)
:'''Custom Music Video Sub-Folder'''
::The name of the folder under the ''"Path"'' where Music Video extras are stored (Note: a directory with the Music Video name will be located under this directory containing the extras for that Music Video)
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables VideoExtras debug logging into the Kodi log file
| [[File:VideoExtras-Settings2.JPG|VideoExtras Settings - File System tab|right|thumb|400px]]
|}

==== Database ====
{| border="0"
|- valign=top
|
:'''Enable Database Support'''
::Enables the use of the Extras stand-alone database, this enables the display and storing of data such as
:::* Which extras have been viewed already
:::* Resume playing an extra from the last stop point
:'''''Operations'''''
::
:'''Clean Database'''
::Clears the extras database (resets all play states for the extras) - Note: This does not do anything to the default Kodi database.
:'''Browse Extras'''
::Loads the Video Extras Browser plugin.
| [[File:VideoExtras-Settings3.JPG|VideoExtras Settings - Database tab|right|thumb|400px]]
|}

==== Advanced ====
{| border="0"
|- valign=top
|
:'''Enable YouTube Search Support'''
::Enabling this option will allow you to search for extra content for your video on YouTube (Requires the [[Add-on:YouTube|YouTube]] add-on)
:'''Enable Vimeo Search Support'''
::Enabling this option will allow you to search for extra content for your video on Vimeo (Requires the [[Add-on:Vimeo|Vimeo]] add-on)
:'''Force Extras Button Display'''
::Will always display the "Extras" button on the Video Information screen (Normal behaviour is to only show the button if there are extra's detected for the given video.
:'''Exclude Files Regular Expression'''
::Regular expression for files that will be deemed "Not to be extras" even if there are present in the Extras directory.
:'''Allow caching of extras on startup'''
::Used to cache the video extras available so that it can be used for icon overlays in some skins, if you do not wish to see icon overlays (or do not use a skin that supports them) then disable this option.
:'''Use Custom Images'''
::Allows you to change the images used in the skin to highlight if extras exist (Note: Changing these values will only be visable after a restart of Kodi)
:'''- Overlay Image'''
::(If Use Custom Images is enabled) The image that is drawn over the top of the thumbnail/cover
:'''- List Image'''
::(If Use Custom Images is enabled) The image that is used when adding to a list
:'''''Operations'''''
::
:'''Update Confluence Skin'''
::Will add VideoExtras support to the default confluence skin
| [[File:VideoExtras-Settings4.JPG|VideoExtras Settings - Advanced tab|right|thumb|400px]]
|}
 
 

== File Naming Convention ==
For your video extras files to be found they must follow a specific naming convention. VideoExtras currently supports extras videos from Movies, TV Shows and Music Videos. Here are the supported conventions:
 
=== Extras Folder ===
''(Recommended Method)''
 
If you put all of your movies in their own folder you can simply add an "Extras" sub folder and add all of your bonus content in that directory. (The name of this folder can be changed via the settings menu). The script will simply display the filename (without extension) in the UI. By default the list of videos will appear in alphabetical order.
 
=== Same Directory (Tagging) ===

If for some reason you don't want to create an "Extras" folder or you want to associate a bonus feature with a specific TV show episode there is an alternative naming convention which uses tagging. Simply use the same name as the file you want to associate the extra feature with and then append "-extras-" followed immediately (no spaces) by the name you want to displayed on the GUI for the extra, e.g. ''<main video name>-extras-<displayed name>.mkv'' . This default tag "-extras-" can be changed via the settings menu and MUST be turned on in order for the tagging to work.

This method will work whether your movies are in their own self-contained folder or all together in one folder only.

'''Example:''' So if you wanted to associate an Extended Pilot feature with the first episode of a tv show named "s1e1.mkv", you would create a file name "s1e1-extras-Extended Pilot.mkv". When the script displays this file in the UI it will strip out all the extra stuff and just show "Extended Pilot". To customize the displayed order here you can use NFO files or manual mode, just as in folder mode. Example of manual mode: "s1e1-extras-[#]Extended Pilot.mkv" where # is a number from 1 to 99.

'''Warning:''' if you don't append the <displayed name> after the tag -extras-, the file name will be displayed on the GUI instead, including the tag -extras-.
 

=== Remote Location ===

If you did not want your extras stored in the same directory structure as your Movies, TV Shows or Music Videos, then there is a settings option "Use Custom Extras Location" that can be set to point to a different location. The format of this location should have 3 directories at the top level: "Movies", "TvShows" and "MusicVideos". Under each of these should be directories (That match the name of the directories containing the Movies, TV Shows and Music Videos) containing the extras files.
 
e.g.

:Movies/Die Hard
:TvShows/Blake's 7
:TvShows/Blake's 7/Series 1
:TvShows/Blake's 7/Series 2

In this case, when clicking on the "TV Information" for the whole Blake's 7 Series you would see all files in "TvShows/Blake's 7" and the two sub-folders (if nested search is enabled), if viewing Episode Information for an episode in series 1 of Blake's 7 then you would only see the extras in "Blake's 7/Series 1"
 
 
Note: When using a custom path VideoExtras will first check for a directory name that matches the directory containing the actual TV Show or Movie. (As described above) If that is not found, then it will use the text title of the Movie or TV Show as the directory name to look for with the following replacements:
* : (Colon) removed from the name
* / or \\ (Forward or back slash) replaced with -
* . (dot) removed from the end of the name
* Non ascii characters are removed
 
 
With this method (based on where this root directory is), there may not be a need to add the "File Exclusions" section into [http://kodi.wiki/view/Advancedsettings.xml advanced settings].
 
 

== Kodi File Exclusions ==

Since these are video files sprinkled in among all of your other video files we need to tell the kodi scanner to ignore these files. If we don't then the scanner will try and match them up with one of the online sites and you probably won't be happy with the results. To do this we just need to add some new regular expressions to the [http://kodi.wiki/view/Advancedsettings.xml advanced settings]. This can be done for you by clicking on the [[Add-on:VideoExtras#Extras|"Update advancedsettings.xml File"]] operation on the first tab of the VideoExtras settings, or you can do this manually using some of the information below. It is recommended to add these settings and reboot Kodi for them to take effect BEFORE any library scan takes place, so the scanner doesn't try to parse them.

<source lang="xml">
<advancedsettings>
<video>
<excludefromscan action="append">
<regexp>-extras-</regexp>
<regexp>/Extras/</regexp>
<regexp>/extras/</regexp>
<regexp>[\\/]Extras[\\/]</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludefromscan>
<excludetvshowsfromscan action="append">
<regexp>-extras-</regexp>
<regexp>/Extras/</regexp>
<regexp>/extras/</regexp>
<regexp>[\\/]Extras[\\/]</regexp>
<regexp>[\\/]extras[\\/]</regexp>
</excludetvshowsfromscan>
</video>
</advancedsettings>
</source>

''In this example the default name "Extras" has been used for the directory containing the extras, if you have changed this in the settings, then this name should also be changed to match.''

Obs.:

1) If you executed a library scan before the regexps have been put in place and found extra material accidentally scanned to your library, you can either remove/rename the extra material and conduct a 'clean library' under Kodi video settings or, delete the video sources and rescan them again after the regexps are operating properly.

2) Beware that if any of your sources contains the word 'extras' in it, e.g. a source named 'Extrasy' or 'Extrascent', nothing new that you put in it will be scanned to the library. This is because that source matches the exclude rule RegExp:'Extras'. To solve this either rename your source or change the default name 'extras', which VideoExtras operates with, to anything different.
 
 

== Images: Thumbnails, Icons and Fanart ==
=== Custom Artwork ===
In order to have thumbnails or custom fanart images displayed on your Extras listings (and player overlay) you can either reference them via an NFO file (see NFO section), or by having the image in the same directory as the extras file. Images referenced via NFO (locally or remotely) will have priority over any other. Thumbnail/icon images in the same directory as extras will be picked up in the following order:

* <filename>.tbn/png/jpg
* <filename>-poster.tbn/png/jpg
* <filename>-thumb.tbn/png/jpg
* poster.tbn/png/jpg (assigns same thumb to all those extras without one)
* folder.tbn/png/jpg (assings same thumb to all those extras without one)

For fanart, the images are picked up in the following order :
* <filename>-fanart.tbn/png/jpg
* fanart.tbn/png/jpg

obs: should you experience image caching persistency of old <filename>-poster/thumb.ext after replacing them by new ones at folder level, this is due to the way Kodi handles the caching of certain images. If you need an immediate solution and don't want to wait for Kodi to cache the new images, there is a script available that solves this issue at database level [http://Just%20to%20help%20with%20the%20cleansing%20of%20thumbs%20cached%20in%20XBMC%20to%20allow%20VideoExtras%20to%20display%20updated%20thumbs%20for%20your%20extras here] called Texture Cache Maintenance utility by MilhouseVH. There aren't cases reported of image caching persistency when using the naming convention <filename>.tbn/png/jpg

=== Default Artwork ===
* '''If no custom fanart:''' fanart is automatically inherited from the parent video file, if there's any.
* '''If no custom thumb (poster):''' default thumb is VideoExtras image icon and will only be displayed in the video overlay whilst playing the extra and not in the extras list.
 
 

== NFO Files ==

The recommended method to give a name or sort order to your "Extras" is to add an NFO for each extra file. This follows the standard Kodi method of having the same name as the file with the extension being replaced with ".nfo" (Sitting in the same directory as the original file). This nfo can take any of the followoing formats (These are in line with the default Kodi behaviour), additional data in these files will be ignored as it is not relevant for the extras file. (Note: The only mandatory element is the "title")

=== Movie NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<movie>
<title>Who knows</title>
<sorttitle>Who knows 1</sorttitle>
<plot>Something happens</plot>
<thumb>thumbnail.jpg</thumb>
<fanart>background.jpg</fanart>
</movie>
</source>

=== TV Show NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<tvshow>
<title>Who knows</title>
<sorttitle>Who knows 1</sorttitle>
<plot>Something happens</plot>
<thumb>http://forum.kodi.tv/images/xbmc/xbmc-lettering.png</thumb>
<fanart>http://forum.kodi.tv/images/xbmc/xbmc-lettering.png</fanart>
</tvshow>
</source>

=== TV Episode NFO Format ===
<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<episodedetails>
<title>Who knows</title>
<season>2</season>
<episode>1</episode>
<plot>Something happens</plot>
<thumb>C:\MyThumbs\Who.Knows.tbn</thumb>
<fanart>C:\MyFanart\myart.png</fanart>
</episodedetails>
</source>

=== Legacy Naming Format ===
The following are the legacy naming formats, they are supported in the short term only to allow easy migration from DVDExtras to VideoExtras. (If an NFO file is specified, the settings in that file will be used)
 
 
By default the list of videos will appear in alphabetical order. If you would like to specify a custom order just start the filename with brackets containing the text to sort on. For example you could create files "[0]Deleted Scenes.mkv", "[1]Bloopers.mkv", and "[2]Behind The Scenes.mkv". In this case instead of sorting on the name it will sort on the numbers. The bracket portion of the filename will not be displayed in the UI.
 
 
For extras tagged on a per file basis (rather and all in a sub-directory) the name will be taken from anything after the extras tag. So append "-extras-Display name here" will result in the name "Display name here". To customize the order here you can use the same format as the extras folder. Example: "s01e01-extras-[99]Extended Pilot.mkv"
 
 
== "videoextras.nfo" Files ==

If you do not have your video extras files stored in a standard location (as already described in the previous sections) then it is possible to create a file with the name "videoextras.nfo" in the same directory as your Movie or TV Show. This file must be of the following format:

<source lang="xml">
<?xml version='1.0' encoding='UTF-8'?>
<videoextras>
<file>..\..\Extras\Extras01.mkv</file>
<directory>C:\Kodi\Sample-Data\Movies\Extras</directory>
</videoextras>
</source>

You can have multiple "file" or "directory" entries in the "videoextras.nfo" file (or none of one type). The "file" will result in just the given file being listed in the extras. The "directory" will result in the entire contents of the directory being listed.
: ''Note: It is only logical to use this approach if you have each movie in it's own directory, as adding a videoextras.nfo file to a directory containing multiple movies will result in every movie in that directory picking up the extras defined in the videoextras.nfo file''
=== Common extras content for Movie Sets ===
The videoextras.nfo's capabilities are useful to assign common extras content to movies within a set (collection), thus we would have only one physical copy of the 'Extras' folder somewhere whilst each videoextras.nfo is pointing at it.
 
 
== Skin Information ==
=== Skins With Build In Support ===
The following skins (except Confluence, since it requires the hooks) have built-in support for Video Extras , so require no user skin modifications:
{| class="wikitable"
|-
! Skin !! Hook Support !! Detailed Screen Support !! Detailed Screen Skin Location !! Hooks Location
|-
| [[Add-on:Confluence|Confluence]] || <center>No</center>|| <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/xbmc/xbmc/blob/master/addons/skin.confluence/720p/DialogVideoInfo.xml DialogVideoInfo.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=145080 Confluence Modified] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=139712 Immersive] || <center>Yes</center> || <center>Yes</center> || <center>Immersive</center> || <center>[https://github.com/Sranshaft/skin.immersive/blob/master/720p/DialogVideoInfo.xml DialogVideoInfo.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=165481 Xperience1080++] || <center>Yes</center> || <center>Yes</center> || <center>Xperience1080++</center> || <center></center>
|-
| [[Add-on:Aeon_MQ_5|Aeon MQ 5]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Aeon_Nox|Aeon Nox 5]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/BigNoid/Aeon-Nox/blob/master/1080i/custom_1119_ExtrasDialog.xml custom_1119_ExtrasDialog.xml]</center>
|-
| [http://forum.kodi.tv/showthread.php?tid=185290 Aeon Nox 4.1.9.x] || <center>Yes</center> || <center>Yes</center> || <center>Aeon Nox 4.1.9.x</center> || <center></center>
|-
| [[Add-on:Rapier|Rapier]] || <center>Yes</center> || <center>Yes</center> || <center>Rapier</center> || <center></center>
|-
| [http://forum.kodi.tv/showthread.php?tid=170954 Artic mk. ii] || <center>Yes</center> || <center>Yes</center> || <center>Artic</center> || <center></center>
|-
| [[Add-on:Metropolis| Metropolis]] ([http://forum.kodi.tv/showthread.php?tid=99317&pid=1726112#pid1726112 coming soon!]) || <center></center> || <center></center> || <center></center> || <center></center>
|-
| [[Add-on:XTV-SAF| xTV-SAF]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Transparency!|Transparency!]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center>[https://github.com/ronie/skin.transparency/blob/master/720p/custom_DialogExtras.xml custom_DialogExtras.xml]</center>
|-
| [[Add-on:Titan MediaBrowser| Titan MediaBrowser]] || <center>Yes</center> || <center>Yes</center> || <center>VideoExtras</center> || <center></center>
|-
| [[Add-on:Black_Glass_Nova|Black Glass Nova 3.x]] || <center>Yes</center> || <center>Yes</center> || <center>Black Glass Nova</center> || <center>[https://github.com/Tgxcorporation/skin.blackglassnova/blob/master/1080i/DialogVideoInfo.xml DialogVideoInfo.xml]</center>
|-
|}
 
If your skin does not support the "Detailed List Screen", then you can either:
# Switch the "Detailed List Screen" off - reverting to the basic list dialog
# Convert the Window XML file in the addon and post a link to it in the forum.
# Use the default "Detailed List Screen" (May not fit in visually with the skin you are using)

Obs: due to a natural delay between the dates of release of possible latest features (and fixed issues too) and actual implementation of these updates in the supported skins, such as support for Music Videos, these skins may still require some manual changes as per [[Add-on:VideoExtras#Skin_Modifications|item 10.2]] in certain skins with built-in support.
 
 

=== Confluence Skin Support ===
A request has been made to the Kodi official repo to have VideoExtras included in the Confluence skin:
https://github.com/xbmc/xbmc/pull/4827
Unfortunately this did not get approved to go into the official repository.
 
 
Instead of this, there is an option that will update the Confluence skin for you in the settings. Just navigate to the [[Add-on:VideoExtras#Advanced|"Update Confluence Skin"]] operation in the VideoExtras settings.
 
 

;Note:
For this update to work, the directory containing the Confluence skin must have write permissions set. To get around this:
* ''' on Windows Vista, 7 and 8.x:''' right click Kodi and select "Run As administrator" and (if it prompts), click "Yes". Then navigate to the "Update Confluence Skin" operation in the VideoExtras settings. (If you select this option without doing a "run as administrator", it will say that it has updated the file successfully, but actually it won't.) - This is believed to only be an issue if you have "User Access Control" enabled 

As Confluence is the default skin, its directory is not user-modifiable on non-Windows systems. To get around this, it is recommended to copy the Confluence skin's directory from it's existing location to the standard location for user installed add-ons: 
* '''On Ubuntu Linux:''' the operation would be to copy the directory "/usr/share/kodi/addons/skin.confluence/" to "/home/<username>/.kodi/addons/". 
Upon restarting Kodi, you should now be able to use the "Update Confluence Skin" feature. 
 

=== Skin Modifications ===
A skin modification is required in order to see the extras button in the UI and enjoy all the features. This is a fairly simple process but will depend on your selected skin. The file that needs modified is DialogVideoInfo.xml. The following code is needed for the default confluence skin, which would result in the new, [https://dl.dropboxusercontent.com/u/56161346/XBMC/VideoExtras/DialogVideoInfo%20062015/DialogVideoInfo.xml modified DialogVideoInfo.xml] (as per June 2015) with support for VideoExtras:

Add to the top of the file (after <window>):
<source lang="xml">
<onload condition="System.HasAddon(script.videoextras)">
RunScript(script.videoextras,check,"$INFO[ListItem.FilenameAndPath]")</onload>
</source>

Add to near the foot of the file after the last control statement:

<source lang="xml">
<control type="button" id="105">
<description>Extras</description>
<include>ButtonInfoDialogsCommonValues</include>
<label>Extras</label>
<onclick>RunScript(script.videoextras,display,"$INFO[ListItem.FilenameAndPath]")</onclick>
<visible>System.HasAddon(script.videoextras)
+ [Container.Content(movies) | Container.Content(episodes) | Container.Content(TVShows)
| Container.Content(musicvideos)]
+ IsEmpty(Window(movieinformation).Property("HideVideoExtrasButton"))</visible>
</control>
</source>
You should be able to use something similar for other skins.

==== Location of XML ====
The DialogVideoInfo.xml's location listed by skin:
;Confluence
* '''Ubuntu Linux:''' /home/<username>/.kodi/addons/skin.confluence/720p/
* '''Ubuntu Linux (alternative):''': /usr/share/kodi/addons/skin.confluence/720p/
* '''OS X:''' /Applications/Kodi.app/Contents/Resources/Kodi/addons/skin.confluence/720p
* '''Windows 7/8.1:''' Program Files (x86)\Kodi\addons\skin.confluence\720p
;Aeon Nox 4
* '''Ubuntu Linux:''' /home/<username>/.kodi/addons/skin.aeon.nox/1080i/
* '''Windows 7/8.1:''' Program Files (x86)\Kodi\addons\skin.aeon.nox\1080i\

Obs.: Remember to create a backup of any file before altering it i.e. DialogVideoInfo.xml.old.

=== Icon Overlay on Video List Screen (Advanced Skinners Only) ===
If you are a skinner and wish to add support for some form of indication that a Movie/TV Show has extras, there is a way, it is not perfect but should get the overlays working. The first part is that you need to have "Allow caching of extras on startup" enabled in the VideoExtras settings. You then need the following in your skin:

<source lang="xml">
<control type="image">
<posx>950</posx>
<posy>14</posy>
<width>16</width>
<height>16</height>
<texture fallback="blank.png">$INFO[ListItem.DBID,special://profile/addon_data/script.videoextras/movies/,.png]</texture>
<visible>System.HasAddon(script.videoextras) + Window.IsVisible(Videos) + Container.Content(Movies)</visible>
</control>
</source>

This example would possibly be added to the confluence skin at line 554 to add an icon to movies on the "biglist" screen. There are 3 different values that can be used:

{| class="wikitable"
|-
| movies || Container.Content(Movies)
|-
| tvshows|| Container.Content(TVShows)
|-
| musicvideos|| Container.Content(MusicVideos)
|}

Where the first column supplies the value used in the <texture> element, and the second for the <visible> element.
 
 
There is a default image that is used to represent the existance of Video Extras, but this can be overridden by the skin by putting a file called "videoextras_overlay.png" in the skins "media" directory, or by updating the [[Add-on:VideoExtras#Advanced|VideoExtras settings]].
 
 
IMPORTANT: This is for advanced skinners only, please only post on the forum if you '''own the skin you are trying to update''' - this is because it will require lots of changes to patch an existing skin, and this feature is only intended to support skins that will support VideoExtras "Out Of The Box".
 
 

=== Request To Skinners (Detailed List Screen) ===
VideoExtras uses a custom window to show the extras, I have written the Window XML files for Confluence. With the large array of different skins available it is not possible to write versions for every skin. If you would be willing to support Video Extras I would really like to include a skin specific Window XML file for your skin and would be greatful for any contribution.
 
The files are very small, so hopefully will not take long to convert for your skin.
 
 

== Known Issues ==
=== Cast List In Summary Screen Not Populated ===
There is a known issue that when you return from the detailed list screen that shows the extras back to the summary screen, the Cast section is not populated, the following was posted for this, but there is no solution:
http://forum.kodi.tv/showthread.php?tid=173502
 
=== Back Navigation For YouTube Incorrect ===
The Videos -> Addon -> VideoExtras Youtube route seems to work how you would expect, however the Video Information -> Extras route gives the option, but when you exit the YouTube list of files it will return to the "Home" screen and not back to the Extras screen.
 
 

== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* VideoExtras debug from the VideoExtras addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 

== Donations ==
If you have found VideoExtras useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=214289 VideoExtras Forum]

Add-on:TvTunesScreensaver

2016-08-20T14:59:31Z

Rob webset:

{{Addon
|Name=TvTunesScreensaver
|provider-name=robwebset
|ID=screensaver.tvtunes
|extension point=xbmc.ui.screensaver
|provides=
|Summary=Plays your themes while showing images for each TV Show or Movie
|Description=The TvTunes Screensaver makes use of the themes configured in your library to use them as a screensaver.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=272157
|Website=
|Source=https://github.com/robwebset/screensaver.tvtunes
|Email=
|broken=
|icon url=https://github.com/robwebset/screensaver.tvtunes/raw/master/icon.png}}

== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
TvTunes Screensaver is a versatile screensaver that can be used to:
* View artwork for TV Shows and Movies
* Play TV or Movie themes while showing artwork
* Show a set of different images in various display formats

It was originally designed to work well with [[Add-on:TvTunes|TvTunes]] but can also be used to just display images if you would rather theme audio was not played in the background.

 

== Screensaver Formats ==
The following formats are available within TvTunes Screensaver
{| border="0"
|- valign=top
|'''Slider''' - This will slide the images into view from either the left, right, top or bottom of the screen.
| [[File:TvTunes-Screensaver-Slider.JPG|400px]]
|- valign=top
|'''Crossfade''' - will fade one image in over the top of the next image
| [[File:TvTunes-Screensaver-Crossfade.JPG|400px]]
|- valign=top
|'''TableDrop''' - will drop each image onto the screen at random overlaps and angles
| [[File:TvTunes-Screensaver-Tabledrop.JPG|400px]]
|- valign=top
|'''StarWars''' - will show a stream of images similar to the Star Wars intro sequence
| [[File:TvTunes-Screensaver-Starwars.JPG|400px]]
|- valign=top
|'''RandomZoomIn''' - will randomly zoom in to each image in turn
| [[File:TvTunes-Screensaver-RandomZoomIn.JPG|400px]]
|- valign=top
|'''AppleTVLike''' - like the Apple TV Screensaver, will scroll a mix of images up from the bottom of the screen
| [[File:TvTunes-Screensaver-AppleTVLike.JPG|400px]]
|- valign=top
|'''GridSwitch''' - will show several images at the same time in a grid format
| [[File:TvTunes-Screensaver-GridSwitch.JPG|400px]]
|- valign=top
|'''Random''' - will randomly show one of the above screensaver formats
|
|}

There are several options for each of the different screen saver that control the speed images move or how frequently the image changes.
 

== Settings ==
=== Screensaver ===
{| border="0"
|- valign=top
|
:'''Screensaver'''
::Select which format of screensaver to use
:'''Image Source'''
::Select if the Movie, TV Show or custom path is used to show images for the screensaver
:'''- Image Type'''
::Which type of images to use for the screensaver i.e. Fanart, Thumbnails, Cast
| [[File:TvTunesScreensaver-Settings1.JPG|400px]]
|}
 
=== Themes ===
{| border="0"
|- valign=top
|
:'''Play Themes During Screensaver'''
::If a theme is available, play it while showing the images for the given Movie or TV Show
:'''- Only Show Images When A Theme Exists'''
::Only add a Movie or TV Show to the screensaver if it has a theme
:'''- Repeat Rules'''
::When to move to the next set of images for a different Movie or TV Show
:'''Include Artwork Downloader Images'''
::If the [[Add-on:Artwork Downloader|Artwork Downloader Addon]] is installed and has stored images with the Movie or TV Show, also show those images
:'''Dim Level'''
::If to dim the screen when the screensaver runs
| [[File:TvTunesScreensaver-Settings2.JPG|400px]]
|}
 
=== File System ===
{| border="0"
|- valign=top
|
:'''''Debugging'''''
::
:'''Enable debug logging'''
::Enables TvTunesScreensaver debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
| [[File:TvTunesScreensaver-Settings3.JPG|400px]]
|}

 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* TvTunesScreensaver debug from the TvTunesScreensaver addon settings menu
Please do not paste the log into the forum thread, just link to it.
 

== Donations ==
If you have found TvTunesScreensaver useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=272157 TvTunesScreensaver Forum]

Add-on:Suitability

2016-08-20T14:56:54Z

Rob webset:

{{Addon
|Name=Suitability
|provider-name=robwebset
|ID=script.suitability
|extension point=xbmc.python.script
|provides=
|Summary=Check if a movie or TV show is family friendly
|Description=Supplies details for how suitable a movie or TV show is for children.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=255113
|Website=
|Source=https://github.com/robwebset/script.suitability
|Email=
|broken=
|icon url=https://github.com/robwebset/script.suitability/raw/master/icon.png}}


== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The Suitability addon allows you to get an "overview" of the content of a movie, things like the sex/violence/language content, so you can make a judgement as to the suitability for your children. (Or your grandmother!)

The addon uses the following sites to retrieve information:
* [http://www.kids-in-mind.com Kids-In-Mind]
* [http://www.commonsensemedia.org Common Sense Media]
* [http://www.dove.org The Dove Foundation]
* [http://www.movieguide.org Movie Guide]

Suitability allows you to view a summary star rating of the movie content and then drill down to view the detailed text description of the movies content. It is available via the movie context menu or launched from the Kodi Programs section (where you will be prompted for a movie name to search for) or there is also an option in settings to add it to the Confluence Movie Information Dialog.
 
 
== Summary Display ==
The summary screen shows a star rating, the categories for each provider will differ as each source site is slightly different.
 
<center>[[File:Suitability-Summary1.JPG|300px]]</center>
 
The details button will show a text description of the films content, while the right hand button will allow you to toggle through all the available providers.
 
 
== Details Display ==
The details screen will describe the content of the film to give you a better understanding of the rating available via the summary screen.
 
<center>[[File:Suitability-Details1.JPG|600px]]</center>
 
The summary button will switch to the summary view for the given provider, while the right hand button will allow you to toggle through all the available providers.
 
 
== Settings ==
This section details all the settings options for Suitability
=== Suitability ===
{| border="0"
|- valign=top
|
:'''Default Source'''
::The first site to display the movie ratings from
:'''Default View'''
::If the initial screen to display is the summary or the detailed view
:'''Show Suitability On Context Menu (Restart Required)'''
::If a link to Suitability should be added to the Movie context menu
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables Suitability debug logging into the Kodi log file
:'''''Operations'''''
::
:'''Update Confluence Skin'''
::Adds a Suitability button to the Movie Information dialog in confluence.                
| [[File:Suitability-Settings1.JPG|400px]]
|}

=== Providers ===
{| border="0"
|- valign=top
|
:'''Common Sense Media'''
::Enable, disable and set the order for the supplier to be used
:'''Kids In Mind'''
::Enable, disable and set the order for the supplier to be used
:'''Dove Foundation'''
::Enable, disable and set the order for the supplier to be used
:'''Movie Guide (.org)'''
::Enable, disable and set the order for the supplier to be used                        
| [[File:Suitability-Settings2.JPG|400px]]
|}

 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* Suitability debug from the Suitability addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the Suitability Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=255113 Suitability Forum]

Add-on:Sonos

2016-08-20T14:23:35Z

Rob webset:

{{Addon
|Name=Sonos
|provider-name=robwebset
|ID=script.sonos
|extension point=xbmc.python.script
|provides=
|Summary=Sonos Controller
|Description=Supports simple Sonos Controls and notifications from Kodi. Look at the wiki for more details.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=183020
|Website=
|Source=https://github.com/robwebset/script.sonos
|Email=
|broken=
|icon url=https://github.com/robwebset/script.sonos/raw/master/icon.png}}

== Introduction ==
You can install this addon from: [[Repository:robwebset]]
 
 
The Kodi Sonos addon allows you to control your Sonos system from Kodi. It is implemented (for those who like to know) as a script, plugin and service. In addition to controlling your Sonos system it also allows you to be notified (via a popup) whenever a new track starts and link the audio volume control of Kodi to the audio volume of the Sonos system. There is also a full "Artist View" controller that will display images and descriptions of the artists currently playing on the Sonos System.
 
 
== Sonos Controller ==
The Sonos Controller can be launched in two different ways:
* From Programs -> Sonos
* From the Browser Menu (See below)

There are two different formats of controller. They both offer the same expected features:

* Display Artist Name
* Display Track Name
* Display Album Name
* Display Album Artwork
* Display Track Duration and Current Position
* Volume Display and Operations (Mute, Change Volume)
* Control Operations (Play, Pause, Stop, Next, Previous, Seek)
* Adjustment Operations (Loop, Random, Crossfade)

The standard controller supports just this set of features, and the data is read from the source files that the Sonos system is playing or streaming.
<center>[[File:Controller-Default.JPG|300px]]</center>

The advanced controllers will also support additional information which is retrieved from the internet. These are available when you enable the option "Display Artist Information" in the settings. These include:

{|
|-
| [[File:Controller-Artist-1.JPG|400px]]
| Controller, Slideshow, Biography, Albums by the same artist
|-
| [[File:Controller-Artist-2.JPG|400px]]
| Controller, Slideshow
|-
| [[File:Controller-Artist-3.JPG|400px]]
| Slideshow Only (No Controller)
''Note:'' This screen works well if you also have Notifications enabled (with "Do Not Display Notification If Controller Is Showing" unset) so that you also get notified what the artist and title of each track that starts is.
|-
| [[File:Sonos-Controller-Artist-4.JPG|400px]]
| Controller, Slideshow, Lyrics
''Note:'' This screen will only show the lyrics when used with Helix (v14) or later (Kodi needs to be restarted after the initial install of the [[Add-on:CU LRC Lyrics|CU LRC Lyrics]] addon)
|}
 

== Notifications ==
The notifications option (if enabled) will display a small popup whenever the track being played by the Sonos system changes. This popup will display the Track Title, Artist and Album Artwork.
<center>
{|
|- align=center
| [[File:Notification-Sonos.JPG|300px]] || [[File:Notification-XBMC.JPG|300px]]
|- align=center
| Sonos Notification Format || Kodi Notification Format
|}
</center>
 
 
== Sonos Browser ==
The Sonos Browser can be launched from "Music -> Add-ons -> Sonos", this will give the folowing options:
 
{| border="0"
|- valign=top
|
* '''Launch Sonos Controller''' - Start the Sonos Controller
* '''Music Library''' - List the locally stored tracks on your server
* '''Radio Stations''' - List the radio stations saved in "My Radio Stations"
* '''Sonos Playlists''' - List your Sonos playlists
* '''Queue''' - List the currently queued tracks to play on the Sonos system
* '''Speech''' - Get your Sonos system to talk
| [[File:Browser-1.JPG|400px]]
 
|- valign=top
|
By right clicking on the Music Library to get the context menu, you will then have the option of "Update The Music Library" so that the current tracks are synchronised with the Sonos system.
 
The Music Library section can be navigated to view and select tracks to play or add to the current queue. You can navigate directly down to a given track and select it. This will cause that track to be played immediately on the Sonos System.
| [[File:Browser-2.JPG|400px]]
 
|- valign=top
|
If you were to right click to get the context menu on a track, album or artist you will get a menu that will enable you to
* '''Play Now''' - Plays the given selection
* '''Add To Queue''' - Adds the given selection to the end of the current queue
* '''Replace Queue''' - Clears the current queue and adds the given selection to the queue
| [[File:Browser-3.JPG|400px]]
 
|- valign=top
|
If you were to right click to get the context menu when viewing the queue you will be able to
* '''Play Track''' - Plays the given selection
* '''Remove Track''' - Removes the given track from the current queue
* '''Clear Queue''' - Removes all items from the queue
| [[File:Browser-4.JPG|400px]]
 
|- valign=top
|
The Speech section will allow you to request that your Sonos system read out the messages you request.
* '''Enter Speech Text To Play...''' - Specify some text to be spoken immediately
* '''Enter Speech Text To Save...''' - Specify some text that can be saved and reused in future
* After a space, the remainder of the screen will show any saved text in alphabetical order.
When specifying text to be spoken there are some key words that will be substituted
* '''%greet''' - A greeting based on the time of day (Good Morning, Good Afternoon, Good Evening)
* '''%day''' - The current day (e.g. Monday, Tuesday ...)
* '''%date''' - The current date (e.g. 3rd September)
* '''%time''' - The current time (e.g. 19:14)
You can delete any saved messages by calling up the context menu and selecting "Remove Saved Text"
| [[File:Browser-5.JPG|400px]]
|}
 
 
== Settings ==
The Sonos addon does not require any other programs installed. It will communicate directly with your Sonos speaker to perform operations.
 
The following settings are available:
=== Speaker ===
{| border="0"
|- valign=top
|
:'''Search For Sonos Speakers...'''
::Attempt to auto detect any Sonos speakers on the network
:'''IP Address'''
::The IP Address of your speaker
:'''Zone Name (Optional)'''
::The Zone Name which the Speaker belongs to (This will be auto populated if a search is done)
:'''- Automatically Update IP Address On Startup'''
::This will result in the Sonos Addon searching for Speakers in the given Zone, and setting their IP address automatically (Useful if the IP addresses of your speakers change and you want Kodi to auto-detect them each time the system starts)
:'''''Debugging'''''
::
:'''Enable Debug logging'''
::Enables Sonos debug logging into the Kodi log file
| [[File:Settings-Speaker.JPG|400px]]
|}

=== Controller ===
{| border="0"
|- valign=top
|
:'''Display Artist Information'''
::Displays images and artist information while items are playing when the controller is selected (using [[Add-on:Artist Slideshow|ArtistSlideshow]] and [[Add-on:CU LRC Lyrics|CU LRC Lyrics]])
:'''- Layout'''
::A selection of various layouts of the screen when the Artist Information is shown
:'''- Make Artist Slideshow Image Full Screen'''
::When enabled will display the artist slideshow image full screen instead of in a frame
:'''- Hide Sonos Logo'''
::Stops the Sonos logo being displayed on the controller screen
:'''Controller Refresh Interval (Seconds)'''
::Sets how often the controller screen should refresh and check for changes of track being played
:'''Avoid Duplicate Key Presses (Seconds)'''
::When using a remote control and holding down a button (such as volume) it will send many requests to increase the volume - this setting allows you to ensure only one press is detected every X seconds. (This prevents flooding the Sonos system with requests).
:'''Volume Change Increments'''
::When the volume increase/decrease button, how much to change the volume by (default is 3%)
| [[File:Settings-Controller.JPG|400px]]
|}

=== Automation ===
{| border="0"
|- valign=top
|
:'''Link Kodi Volume With Sonos Speaker (Requires Restart)'''
::Whenever you change the Kodi volume, the Sonos volume will be set to the same percentage value (Note: Changes in the Sonos Volume are not reflected in Kodi - this is one way only)
:'''Redirect Volume Controls To Sonos (Requires Restart)'''
::Change the default behaviour for Kodi volume and mute operations from the keyboard or remote control to send them to Sonos instead.
:'''Switch Sonos To Line-In On Kodi Startup (Requires Restart)'''
::When Kodi starts, it will send a message to the Sonos speaker to switch it to line-in
:'''Switch Sonos To Line-In On Media Start (Requires Restart)'''
::When Kodi starts playing any form of media, it will send a message to the Sonos speaker to switch it to line-in
:'''Automatically Pause Sonos When Kodi Plays Media (Restart Required)'''
::If you start playing any form of media in Kodi, then a pause command will be sent to the Sonos system to ensure it stops playing
:'''- Automatically Resume Sonos (Seconds) [0 = Off]'''
::If The Sonos Addon paused the Sonos system because of Kodi playing media, how many seconds to wait before resuming Sonos playback
:'''Launch Controller On Kodi Startup'''
::Will launch the Sonos Controller automatically when Kodi starts
:'''Status Checks Per Second (Restart Required)'''
::Will increase the number of times a second the addon will check for status changes such as volume changes. Use this setting with care, as it will increase the processing power used on your machine.
| [[File:Settings-Automation.JPG|400px]]
|}

=== Plugin ===
{| border="0"
|- valign=top
|
:'''Batch Size'''
::The number of records to retrieve from Sonos in one chunk, looping to get all the records in this batch size. (Default = 100)
:'''Maximum Entries In Displayed Lists'''
::Limits the number of entries that are retrieved from the Sonos system when generating lists (e.g. The Queue). (Default = 1000)
:'''Use Skin Icons Instead Of Sonos Icons'''
::Allows the change of the plugin section to use the default icons suplied by skin instead of the Sonos icons
| [[File:Settings-Plugin.JPG|400px]]
|}

=== Notifications ===
{| border="0"
|- valign=top
|
:'''Enable Notifications (Restart Required)'''
::Enables or disables the popup notification of track change
:'''Display Notification For (Seconds)'''
::How long to display the track information on the screen
:'''Notification Check Frequency (Seconds)'''
::The frequency in which the service check which track is playing on the Sonos speaker
:'''Do Not Display Notification If Video Is Playing'''
::Prevents the popup notification displaying while a video file is playing
:'''Do Not Display Notification If Controller Is Showing'''
::In most cases this would be "true" (default) so that the popup does not display the notification while the controller is showing. However when using certain Artist Slideshow supported controller sceens, there is no display of the current artist name or track, this allos the notification to show while these screens are being used.
:'''Use Default Kodi Notification Dialog'''
::Uses the default Kodi popup dialog instead of the custom Sonos one
 
| [[File:Settings-Notifications.JPG|400px]]
|}
 
 
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* Sonos debug from the Sonos addon settings menu
Please do not paste the log into the forum thread, just link to it.
 
 
== Donations ==
If you have found the Sonos Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
 
 
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=183020 Sonos Forum]