Difference between revisions of "Media stubs"

From Official Kodi Wiki
Jump to: navigation, search
m (Robot: Cosmetic changes)
Line 1: Line 1:
 
{{Frodo updated}}
 
{{Frodo updated}}
 
{{greenv|Information:|How to add offline media (Physical Discs) to the XBMC library via media stubs}}
 
{{greenv|Information:|How to add offline media (Physical Discs) to the XBMC library via media stubs}}
<section begin="intro" />As of v11 (Eden), XBMC has support for offline media stub files. These are files that represent a media outside of the online digital infrastructure and allow XBMC's library to catalogue your "offline" media collection, as well as ask for the media when selected for playback.<section end="intro" />
+
<section begin="intro" />As of v11 (Eden), XBMC has support for offline media stub files. These are files that represent a media outside of the online digital infrastructure and allow XBMC's library to catalogue your "offline" media collection, as well as ask for the media when selected for playback.<section end="intro" />
  
==Outline==
+
== Outline ==
 
The intended way for this to work is '''e.g.''' Two DVD's you want to add to your XBMC library, Finding Nemo, and Bug's Life. You would create two empty files where ever you store the rest of your digital media files called:
 
The intended way for this to work is '''e.g.''' Two DVD's you want to add to your XBMC library, Finding Nemo, and Bug's Life. You would create two empty files where ever you store the rest of your digital media files called:
 
* Finding Nemo (2003).disc
 
* Finding Nemo (2003).disc
 
* Bug's Life (1998).disc
 
* Bug's Life (1998).disc
  
==Supported stub file extensions and media source flags==
+
== Supported stub file extensions and media source flags ==
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]].
+
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]].
 
    
 
    
You can also add media source flags to the filename (if the skin you are using supports them) to indicate the type of media ('''DVD''', '''BLURAY''', '''VHS''', etc) in the GUI. For more info on this, see [[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: "Finding Nemo (2003).dvd.disc" and add it to your library. In the XBMC 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.
+
You can also add media source flags to the filename (if the skin you are using supports them) to indicate the type of media ('''DVD''', '''BLURAY''', '''VHS''', etc) in the GUI. For more info on this, see [[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: "Finding Nemo (2003).dvd.disc" and add it to your library. In the XBMC 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.
  
==Messages==
+
== Messages ==
When you try to play a media stub file, XBMC 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.
+
When you try to play a media stub file, XBMC 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 treating the media stub file as an .xml file with the following layout:
+
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 treating the media stub file as an .xml file with the following layout:
  
 
<source lang="xml">
 
<source lang="xml">
Line 25: Line 25:
 
</source>
 
</source>
  
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.
+
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.
  
==Notes==
+
== Notes ==
 
For more technical information on this new feature see [http://trac.xbmc.org/ticket/10384 here], [https://github.com/xbmc/xbmc/pull/76 here], and [https://github.com/xbmc/xbmc/pull/89 here].
 
For more technical information on this new feature see [http://trac.xbmc.org/ticket/10384 here], [https://github.com/xbmc/xbmc/pull/76 here], and [https://github.com/xbmc/xbmc/pull/89 here].
  
 
[[Category:XBMC Manual]]
 
[[Category:XBMC Manual]]
 
[[Category:Video Library]]
 
[[Category:Video Library]]

Revision as of 15:17, 27 April 2013

Information: How to add offline media (Physical Discs) to the XBMC library via media stubs

As of v11 (Eden), XBMC has support for offline media stub files. These are files that represent a media outside of the online digital infrastructure and allow XBMC's library to catalogue your "offline" media collection, as well as ask for the media when selected for playback.

1 Outline

The intended way for this to work is e.g. Two DVD's you want to add to your XBMC library, Finding Nemo, and Bug's Life. You would create two empty files where ever you store the rest of your digital media files called:

  • Finding Nemo (2003).disc
  • Bug's Life (1998).disc

2 Supported stub file extensions and media source flags

By default these files have a .disc extension. You can modify the file extensions that are recognized as media stub files via the <discstubextensions> tag in advancedsettings.xml.

You can also add media source flags to the filename (if the skin you are using supports them) to indicate the type of media (DVD, BLURAY, VHS, etc) in the GUI. For more info on this, see 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: "Finding Nemo (2003).dvd.disc" and add it to your library. In the XBMC 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.

3 Messages

When you try to play a media stub file, XBMC 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 treating the media stub file as an .xml file with the following layout:

<discstub>
  <title>Alternative Title</title>
  <message>Message to be displayed</message>
</discstub>

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.

4 Notes

For more technical information on this new feature see here, here, and here.