Media stubs: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Adjust intro)
(Page cleared for overhaul)
Line 1: Line 1:
{{Mininav|[[Video library]]|[[Video management|Management]] }}
<section begin="intro" />As of v11 (Eden), Kodi has support for offline media stub files. These are files that represent a media outside of the digital infrastructure (eg, DVD's, Bluray, UHD Bluray, etc) and allow Kodi's library to catalogue your "offline" media collection, as well as ask for the media when selected for playback. They will look like any other entry in the library, but a notice box will pop requesting insertion of the disk. Messages can be displayed in the notice box, such as "DVD on second shelf in cellar".<section end="intro" />


== Creating stubs ==
The intended way for this to work is '''e.g.''' Two DVD's you want to add to your Kodi library, Finding Nemo, and Bug's Life. You would create two empty text files where ever you store the rest of your digital media files called:
* Finding Nemo (2003).disc
* Bug's Life (1998).disc
== Messages ==
{{note|Due to a bug in v12 to v14, stubs won't display their custom message if {{kodi}} does not detect an optical drive connected to your HTPC.}}
When you try to play a media stub file, Kodi will present a dialog box with the static message, "Please insert the following disc:", on the first line and the item's library title on the second line. An Eject/Load button is available to open the optical drive tray or, for a slot-loading drive, eject any currently inserted media. When a disc is inserted in the drive, the Play button is enabled and selecting it will begin playback of the disc.
You can also replace the title and/or add a custom message to be displayed when attempting to play a media stub file. This is accomplished by adding the following to the blank text file that is used for the stub:
<syntaxhighlight lang="xml" enclose="div">
<discstub>
  <title>Alternative Title</title>
  <message>Message to be displayed</message>
</discstub>
</syntaxhighlight>
This message will be displayed on the third line of the dialog box. You may use this message to provide additional information, such as the disc number/side to be inserted or, if you use a special numbering scheme for organizing your DVD/Bluray collection, the location number of the expected disc.
== Media flags ==
You can optionally add media source flags to the filename before ".stub", if the skin you are using supports them. This can be used to indicate the type of media ('''DVD''', '''BLURAY''', '''VHS''', etc) that the movie resides on, which will be labeled within the {{kodi}} interface.
{{#lst:Add-on:Confluence|flags}}
For more info on this, see [[Media flags#Media source|Media flags/Media source]]. In cooperation with Confluence Skin's (and possibly others) feature to search for words like DVD, Bluray, and HDDVD in the file name it is possible to create a disc stub file that will show correct media flags in the skin.
For example, if you have Finding Nemo on DVD, you could create an empty file called:
<code>Finding Nemo (2003).dvd.disc</code>
and add it to your library. In the library this file will show up with the DVD media flag in the Confluence Skin and when selected you will be prompted to insert the Finding Nemo DVD.
== Modifying the file extension used for stubs ==
By default these files have a .disc extension. You can modify the file extensions that are recognized as media stub files via the<code>''' <discstubextensions>'''</code> tag in [[Advancedsettings.xml#.3Cdiscstubextensions.3E|advancedsettings.xml]].
{{Helix updated}}
[[Category:Manual]]
[[Category:Video library]]

Revision as of 02:00, 14 July 2018

Retrieved from "https://kodi.wiki/index.php?title=Media_stubs&oldid=139673"