Add-on:VideoScreensaver: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:
|Language=
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|License=GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007
|Forum=http://forum.kodi.tv/showthread.php?tid=210943
|Forum=http://forum.kodi.tv/showthread.php?tid=292708
|Website=
|Website=
|Source=https://github.com/robwebset/screensaver.video
|Source=https://github.com/robwebset/screensaver.video

Revision as of 14:27, 1 October 2016

VideoScreensaver
https://github.com/robwebset/screensaver.video/raw/master/icon.png

Author: robwebset

Type: Screensaver
Repo:

License: GPL v3.0
Source: Source code
Summary: Screensaver that plays a video file
Home icon grey.png   ▶ Add-ons ▶ VideoScreensaver
Attention talk.png 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:

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

China - Day 1
China - Day 2
China - Day 3

Hawaii

Hawaii - Day 1
Hawaii - Day 2
Hawaii - Day 3
Hawaii - Day 4
Hawaii - Day 5
Hawaii - Day 6
Hawaii - Night 1
Hawaii - Night 2

London

London - Day 1
London - Day 2
London - Night 2
London - Night 2
London - Night 3

New York

New York - Day 1
New York - Day 2
New York - Day 3
London - Night 1
London - Night 2
London - Night 3

San Francisco

San Francisco - Day 1
San Francisco - Day 2
San Francisco - Day 3
San Francisco - Day 4
San Francisco - Day 5
San Francisco - Day 6
San Francisco - Night 1
San Francisco - Night 2
San Francisco - Night 3
San Francisco - Night 4
San Francisco - Night 5
San Francisco - Night 6

Aquarium Collection

Aquarium 1 - [846MB] - 400p
Aquarium 2 - [2.7GB] - 720p
Aquarium 3 - [2.4GB] - 720p
Aquarium 4 - [780MB] - 720p
Aquarium 5 - [3.0GB] - 720p

Beach Collection

Beach 1 - [2.5GB] - 720p
Beach 2 - [838MB] - 720p
Beach 3 - [3.4GB] - 720p
Beach 4 - [768MB] - 720p

Clock Collection

Clock 1 - [1.5GB] - 720p
Clock 2 - [1.3GB] - 360p

Fireplace Collection

Fireplace 1 - [965MB] - 720p
Fireplace 2 - [827MB] - 480p
Fireplace 3 - [2.1GB] - 1080p
Fireplace 4 - [2.7GB] - 720p

Miscellaneous Collection

Christmas 1 - [777MB] - 1080p
Johnny Castaway 1 - [75MB] - 480p
Matrix 1 - [909MB] - 720p
Ocean 1 - [1.1GB] - 720p
Retro Sci-Fi 1 - [200MB] - 1080p
Star Trek TNG 1 - [54MB] - 720p
Watermill 1 - [549MB] - 1080p

Snow Collection

Snow 1 - [1.3GB] - 720p
Snow 2 - [677MB] - 1080p
Snow 3 - [1.2GB] - 720p
Snow 4 - [1.5GB] - 720p

Space Collection

Space 1 - [970MB] - 720p
Space 2 - [563MB] - 1080p
Space 3 - [2.2GB] - 720p
Space 4 - [1.2GB] - 720p

Waterfall Collection

Waterfall 1 - [1.3GB] - 720p
Waterfall 2 - [1.3GB] - 720p
Waterfall 3 - [2.4GB] - 720p

Woodland Collection

Woodland 1 - [1.3GB] - 720p
Woodland 2 - [664MB] - 720p
Woodland 3 - [1.0GB] - 720p



Built-In Overlay Images

The following overlay images are supplied with the addon.

Picture Frame 1
Window Frame 1
Window Frame 2



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

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

Configuration

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

Startup

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
VideoScreensaver-Settings5.JPG

Schedule

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 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
VideoScreensaver-Settings6.JPG



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