Add-on:VideoScreensaver
VideoScreensaver | ||||||||||||||
|
Add-ons | VideoScreensaver |
Need help with this add-on? See here. |
Plays a video when the screensaver starts, this can be a custom video or one of the built in videos
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:
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
Hawaii
London
New York
San Francisco
Aquarium Collection
Beach Collection
Clock Collection
Fireplace Collection
Miscellaneous Collection
Snow Collection
Space Collection
Waterfall Collection
Woodland Collection
Built-In Overlay Images
The following overlay images are supplied with the addon.
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:
<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>
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 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.
<?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>
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
Configuration
Startup
Schedule
|
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:
xbmcgui.Window(10000).getProperty("VideoScreensaverRunning")
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:
xbmcgui.Window(10000).getProperty("VideoScreensaverStarting")
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 "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 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 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 VideoScreensaver Forum