Difference between revisions of "Media stubs"

From Official Kodi Wiki
Jump to: navigation, search
m (This page needsa updating and a PR on this has been left to rot on GIT https://github.com/xbmc/xbmc/pull/551)
(A little update and cleanup, if someone has more information on this please update this page.)
Line 1: Line 1:
 
{{cleanup}}
 
{{cleanup}}
<section begin="intro" />As of v11 (Eden), XBMC now 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 catalog your "offline" media collection, as well as ask for the media when selected for playback.<section end="intro" />
+
{{greenv|Information:|Contains information on how to add offline media (Physical Discs) to the XBMC library.}}
 +
<section begin="intro" />As of v11 (Eden), XBMC now 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==
 +
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).dvd
 +
* Bug's Life (1998).dvd
 +
 +
==Supported stub file types and default extensions==
 +
{| class="wikitable"
 +
!Stub file types
 +
!Default extensions
 +
|-
 +
|'''DVD disc'''
 +
|'''.dvd'''
 +
|-
 +
|'''BluRay disc'''
 +
|'''.blu'''
 +
|-
 +
|'''HDDVD disc'''
 +
|'''.hdd'''
 +
|-
 +
|'''VHS tape'''
 +
|'''.vhs'''
 +
|}
 +
{{note|You can also add media source flags (if the skin you are using supports them) to indicate the type of media (DVD, BR, VHS, etc) in the GUI. For more info on this, see [[Media flags#Media source]].}}
  
 
By default these files have a .disc extension (modifiable via [[advancedsettings.xml|advancedsettings.xml]]).  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.
 
By default these files have a .disc extension (modifiable via [[advancedsettings.xml|advancedsettings.xml]]).  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==
 +
Depending on which type of stub the user tries to play XBMC will present the user with corresponding feedback. For things like HDDVD, XBMC will simply tell the user that playback is not possible. For DVDs the XBMC will present a new Dialog introduced, called CGUIDialogPlayEjectCancel. It will prompt the user to insert the DVD and offer to play it right away (Play button only becomes available if/when the DVD is in the drive).
  
You can also add media source flags (if the skin you are using supports them) to indicate the type of media (DVD, BR, VHS, etc) in the GUI. For more info on this, see [[Media flags#Media source]].
+
{{note|You can also add a custom message to be displayed when attempting to play a Disc Stub file.}}
 
+
This is accomplished by treating the disc stub file as an .xml file with the following layout:
 
 
You can also add a custom message to be displayed when attempting to play a Disc Stub file. This is accomplished by treating the disc stub file as an xml file with the following layout:
 
 
 
  
 
<source lang="xml">
 
<source lang="xml">
Line 17: Line 40:
 
</discstub>
 
</discstub>
 
</source>
 
</source>
 
  
 
The message will be displayed on the second line of the dialog box that asks you to insert a disc when selecting a disc stub file for playback.  This added feature allows users who use a numbered library for their disc media to also take advantage of this new Disc Stub file support in XBMC.
 
The message will be displayed on the second line of the dialog box that asks you to insert a disc when selecting a disc stub file for playback.  This added feature allows users who use a numbered library for their disc media to also take advantage of this new Disc Stub file support in XBMC.
  
 
+
==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]]

Revision as of 12:32, 21 January 2013

Cleanup.png This page or section may require cleanup, updating, spellchecking, reformatting and/or updated images. Please improve this page if you can. The discussion page may contain suggestions.

Information: Contains information on how to add offline media (Physical Discs) to the XBMC library.

As of v11 (Eden), XBMC now 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).dvd
  • Bug's Life (1998).dvd

2 Supported stub file types and default extensions

Stub file types Default extensions
DVD disc .dvd
BluRay disc .blu
HDDVD disc .hdd
VHS tape .vhs

Note: You can also add media source flags (if the skin you are using supports them) to indicate the type of media (DVD, BR, VHS, etc) in the GUI. For more info on this, see Media flags#Media source.

By default these files have a .disc extension (modifiable via advancedsettings.xml). 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

Depending on which type of stub the user tries to play XBMC will present the user with corresponding feedback. For things like HDDVD, XBMC will simply tell the user that playback is not possible. For DVDs the XBMC will present a new Dialog introduced, called CGUIDialogPlayEjectCancel. It will prompt the user to insert the DVD and offer to play it right away (Play button only becomes available if/when the DVD is in the drive).

Note: You can also add a custom message to be displayed when attempting to play a Disc Stub file. This is accomplished by treating the disc stub file as an .xml file with the following layout:

<discstub>
  <message>Message to be displayed</message>
</discstub>

The message will be displayed on the second line of the dialog box that asks you to insert a disc when selecting a disc stub file for playback. This added feature allows users who use a numbered library for their disc media to also take advantage of this new Disc Stub file support in XBMC.

4 Notes

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