Difference between revisions of "NFO files/Music videos"

From Official Kodi Wiki
Jump to: navigation, search
(Updated for v18)
 
Line 1: Line 1:
{|class="infobox" style="width:200px"
+
{{NFO_content}}
! NFO Contents
 
|-
 
|
 
* '''[[NFO_files|NFO Files]]'''
 
** '''[[NFO_files/Movies|Movies]]'''
 
** '''[[NFO files/TV shows|TV Shows]]'''
 
** '''[[NFO files/Music|Music]]'''
 
** '''[[NFO files/Music videos|Music Videos]]'''
 
|}
 
{{mininav|[[NFO_files]]}}
 
  
 +
{{mininav|[[NFO files]]}}
  
  
Line 28: Line 19:
  
 
== Known Issues ==
 
== Known Issues ==
No known issues currently exist.
+
* v18 introduced a bug where any class of nfo file can be scanned into any part of the video library. See [https://github.com/xbmc/xbmc/issues/16112 Issue 16112]
 +
 
  
  
 +
= nfo Name and Location =
 +
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''
  
= nfo Placement =
+
Correct placement of the nfo file is essential. Failing to save the file with the correct name and in the correct location, as detailed below, will force Kodi to either:
Correct placement of the nfo file is essential. '''Regardless of what settings you have set for the source and scraper, Kodi will always search for and scrape a nfo file if it is available.''' Failing to save the file in the correct location, as detailed below, will force Kodi to either:
 
 
#Scrape the metadata from the online source set in your scraper or,  
 
#Scrape the metadata from the online source set in your scraper or,  
 
#If you have ''Local Info Only'' set as your scraper, then no entry will be made into the library.
 
#If you have ''Local Info Only'' set as your scraper, then no entry will be made into the library.
  
  
 
== Music Videos ==
 
 
Music Videos require one nfo for '''each''' music video in the folder. These nfo files need to be named exactly as the Music Video file is named, but with the nfo extension.
 
Music Videos require one nfo for '''each''' music video in the folder. These nfo files need to be named exactly as the Music Video file is named, but with the nfo extension.
  
<div style="{{linear-gradient|bottom|#fffec7, #ffc7ff}}">
+
The below image shows an example of correct naming and placement of the artwork alongside the '''''[[nfo]]''''' file and the Music Video media file.
'''''Naming & Saving conventions for your Music Videos *.nfo files:'''''
 
{|
 
|- valign="top"
 
| width=200px |'''''Saved Music Videos as'''''
 
| width=300px |'''''File Name'''''
 
| width=600px |'''''Save Location'''''
 
|- valign="top"
 
| width=200px |All formats
 
| width=300px |<MusicVideoFileName>.nfo
 
| width=600px |f:\MyMusicVideos\<MusicVideoFileName>.nfo
 
|}
 
</div>
 
  
 
+
<gallery mode="packed" widths="500px" heights="290px">
The below image shows an example of correct naming and placement of the artwork alongside the '''''[[nfo]]''''' file and the Music Video media file.
 
<gallery widths=450px heights=250px>
 
 
File:Artwork-MusicVideoExample01.jpg|Correct naming and placement of media, nfo and artwork files.
 
File:Artwork-MusicVideoExample01.jpg|Correct naming and placement of media, nfo and artwork files.
 
</gallery>
 
</gallery>
Line 70: Line 47:
 
! NFO (xml) Tag || Required || Multiple || Notes
 
! NFO (xml) Tag || Required || Multiple || Notes
 
|-
 
|-
|<musicvideo></musicvideo> || Yes || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
+
|<musicvideo></musicvideo> || scope="cell" ! style="background-color:#ff9c95;" | Yes || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
 
|-
 
|-
 
|<title></title> || No || No || Name of music video
 
|<title></title> || No || No || Name of music video
Line 82: Line 59:
 
|<album></album> || No || No || Name of album the song appears on
 
|<album></album> || No || No || Name of album the song appears on
 
|-
 
|-
|<outline></outline> || || || Not Used
+
|<outline></outline> || No || No || Not Used
 
|-
 
|-
|<plot></plot> || || || Can contain more information on multiple lines, will be wrapped
+
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
 
|-
 
|-
 
|<tagline></tagline> || No || No || Not Used
 
|<tagline></tagline> || No || No || Not Used
 
|-
 
|-
|<runtime></runtime> || No || No || Not Used
+
|<runtime></runtime> || No || No || Duration of Music Video in minutes
 
|-
 
|-
 
|<thumb preview=""></thumb> || No || Yes || Path to TV Show and Season artwork
 
|<thumb preview=""></thumb> || No || Yes || Path to TV Show and Season artwork
Line 94: Line 71:
 
|<mpaa></mpaa> || No || No || Not Used
 
|<mpaa></mpaa> || No || No || Not Used
 
|-
 
|-
|<playcount></playcount> || || || Setting this to 1, or greater, will mark the Music Video as watched on import if the ''importwatchedstate'' flag is set in advancedsettings.xml
+
|<playcount></playcount> || No || No || Setting this to 1, or greater, will mark the Music Video as watched on import if the ''importwatchedstate'' flag is set in advancedsettings.xml
|-
 
|<lastplayed></lastplayed> || No || No || Date the music video was last played. Requires advancedsettings.xml entry for import
 
|-
 
|<file></file> || No || No || Not Used. Exported in Single File Export only
 
|-
 
|<path></path> || No || No || Not used on Import. Exported in Single File Export only
 
|-
 
|<filenameandpath></filenameandpath> || No || No || Not used on Import. Exported in Single File Export only
 
|-
 
|<basepath></basepath> || No || No || Not used on Import. Exported in Single File Export only
 
 
|-
 
|-
 
|<id></id> || No || No || Not Used
 
|<id></id> || No || No || Not Used
 
|-
 
|-
|<genre clear="true"></genre> || No || Yes || Supports "clear" attribute
+
|<genre></genre> || No || Yes || Genre
 
|-
 
|-
|<tag></tag> || No || Yes || User created tags
+
|<tag></tag> || No || Yes || Video tags. See: ''[[Video library tags]]''
 
|-
 
|-
|<director clear="true"></director> || No || No || Director of the music video
+
|<director></director> || No || No || Director of the music video
 
|-
 
|-
 
|<year></year> || No || No || Year released
 
|<year></year> || No || No || Year released
Line 118: Line 85:
 
|<status></status> || No || No || Not Used
 
|<status></status> || No || No || Not Used
 
|-
 
|-
|<code><code></code></code> || || || Not Used
+
|<code><code></code></code> || No || No || Not Used
 
|-
 
|-
 
|<aired></aired> || No || No || Not Used
 
|<aired></aired> || No || No || Not Used
 
|-
 
|-
|<studio clear="true"></studio> || No || Yes || Supports "clear" attribute
+
|<studio></studio> || No || Yes || Production studio
 
|-
 
|-
 
|<trailer></trailer> || No || No || Not used
 
|<trailer></trailer> || No || No || Not used
 
|-
 
|-
 
|
 
|
<fileinfo>
+
    <fileinfo>
  <streamdetails>
+
        <streamdetails>
    <audio>
+
            <video>
      <codec></codec>
+
                <codec></codec>
      <language></language>
+
                <aspect></aspect>
      <channels></channels>
+
                <width></width>
    </audio>
+
                <height></height>
  </streamdetails>
+
                <durationinseconds></durationinseconds>
</fileinfo>
+
                <stereomode></stereomode>
 +
            </video>
 +
            <audio>
 +
                <codec></codec>
 +
                <language></language>
 +
                <channels></channels>
 +
            </audio>
 +
        </streamdetails>
 +
    </fileinfo>
 
|| No || No || While it is possible to manually set the information contained within the <streamdetails> tag, there is little point in doing so.  
 
|| No || No || While it is possible to manually set the information contained within the <streamdetails> tag, there is little point in doing so.  
 
Kodi will always overwrite this data when it plays back the video file.<br />  
 
Kodi will always overwrite this data when it plays back the video file.<br />  
 
In other words, no matter how many times you try to manually set it, it will be overwritten the moment the video is played
 
In other words, no matter how many times you try to manually set it, it will be overwritten the moment the video is played
 
|-
 
|-
|<artist clear="true"></artist> || No || No || The artist of the song
+
|<artist></artist> || No || Yes || The artist of the song
 
|-
 
|-
 
|
 
|
Line 150: Line 125:
 
|-
 
|-
 
|<dateadded></dateadded> || No || No || Date the file was added to library. Can be altered in advancedsettings.xml
 
|<dateadded></dateadded> || No || No || Date the file was added to library. Can be altered in advancedsettings.xml
|-
 
|
 
<art>
 
  <fanart></fanart>
 
  <poster></poster>
 
</art>
 
|| No || No || Currently selected artwork.  Exported to single file only, not imported
 
 
|}
 
|}
  
  
  
= Sample nfo Files =
+
= Template nfo =
 +
A template NFO File is provided below that can be copied into your own file and completed. It is a simplified file:
 +
*System generated tags are removed
 +
*Assumes local artwork is being used
 +
*Assumes no online information is available, so items like Ratings have no relevance
 +
*This will be the first time scanned into library so watched status and play counts are not required.
 +
If any of these removed tags are required, simply add the appropriate tags, and refer to the Sample NFO File in the next section to confirm correct usage.
 +
 
 +
<syntaxhighlight lang="xml" line='line'>
 +
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
 +
<musicvideo>
 +
    <title></title>
 +
    <userrating></userrating>
 +
    <track></track>
 +
    <album></album>
 +
    <plot></plot>
 +
    <genre></genre>
 +
    <director></director>
 +
    <premiered></premiered>
 +
    <studio></studio>
 +
    <artist></artist>
 +
</musicvideo>
 +
</syntaxhighlight>
 +
 
 +
 
 +
 
 +
= Sample nfo =
 
Sample Music Video nfo from Single File Export
 
Sample Music Video nfo from Single File Export
  
 
{{collapse top| Music Video nfo file  (click 'expand' to view)}}
 
{{collapse top| Music Video nfo file  (click 'expand' to view)}}
<musicvideo>
+
<syntaxhighlight lang="xml" line='line'>
  <title>Where the Streets Have No Name</title>
+
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  <userrating>8</userrating>
+
<musicvideo>
  <top250>0</top250>
+
    <title>Dancing Queen</title>
  <track>-1</track>
+
    <userrating>0</userrating>
  <album>The Joshua Tree</album>
+
    <top250>0</top250>
  <outline></outline>
+
    <track>3</track>
  <plot>"With or Without You" is a song by Irish rock band U2. It is the third track from their 1987 album, The Joshua Tree, and was released as the album's first single on 21 March 1987.</plot>
+
    <album>Arrival</album>
  <tagline></tagline>
+
    <outline></outline>
  <runtime>0</runtime>
+
    <plot>Dancing Queen est un des tubes emblématiques de l&apos;ère disco produits par le groupe suédois ABBA en 1976. Ce tube connaît un regain de popularité en 1994 lors de la sortie de Priscilla, folle du désert, et fait « presque » partie de la distribution du film Muriel.&#x0A;Le groupe a également enregistré une version espagnole de ce titre, La reina del baile, pour le marché d&apos;Amérique latine. On peut retrouver ces versions en espagnol des succès de ABBA sur l&apos;abum Oro. Le 18 juin 1976, ABBA a interprété cette chanson lors d&apos;un spectacle télévisé organisé en l&apos;honneur du roi Charles XVI Gustave de Suède, qui venait de se marier. Le titre sera repris en 2011 par Glee dans la saison 2, épisode 20.</plot>
  <thumb preview="http://www.theaudiodb.com/images/media/album/thumb/the-joshua-tree-4e424fba428d5.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/the-joshua-tree-4e424fba428d5.jpg</thumb>
+
    <tagline></tagline>
  <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f...-tree-5348fa767262d.jpg">https://assets.fanart.tv/fanart/music/a3c...2/albumcover/the-joshua-tree-5348fa767262d.jpg</thumb>
+
    <runtime>2</runtime>
  <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f...-tree-591dc8c2f14be.jpg">https://assets.fanart.tv/fanart/music/a3c...2/albumcover/the-joshua-tree-591dc8c2f14be.jpg</thumb>
+
    <thumb preview="https://www.theaudiodb.com/images/media/album/thumb/arrival-4ee244732bbde.jpg/preview">https://www.theaudiodb.com/images/media/album/thumb/arrival-4ee244732bbde.jpg</thumb>
  <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f...-tree-4e424fba428d5.jpg">https://assets.fanart.tv/fanart/music/a3c...2/albumcover/the-joshua-tree-4e424fba428d5.jpg</thumb>
+
    <thumb preview="https://assets.fanart.tv/preview/music/d87e52c5-bb8d-4da8-b941-9f4928627dc8/albumcover/arrival-548ab7a698b49.jpg">https://assets.fanart.tv/fanart/music/d87e52c5-bb8d-4da8-b941-9f4928627dc8/albumcover/arrival-548ab7a698b49.jpg</thumb>
  <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f...-tree-58c8a09104fc6.jpg">https://assets.fanart.tv/fanart/music/a3c...2/albumcover/the-joshua-tree-58c8a09104fc6.jpg</thumb>
+
    <mpaa></mpaa>
  <mpaa></mpaa>
+
    <playcount>0</playcount>
  <playcount>5</playcount>
+
    <lastplayed></lastplayed>
  <lastplayed>2017-09-15</lastplayed>
+
    <id></id>
  <file></file>
+
    <genre>Pop</genre>
  <path>E:\Music Videos- Test\</path>
+
    <director>John Smith</director>
  <filenameandpath>E:\Music Videos- Test\U2 - Where The Streets Have No Name.mkv</filenameandpath>
+
    <premiered>1976-01-01</premiered>
  <basepath>E:\Music Videos- Test\U2 - Where The Streets Have No Name.mkv</basepath>
+
    <year>1976</year>
  <id></id>
+
    <status></status>
  <genre>Pop-Rock</genre>
+
    <code></code>
  <tag>MyTag</tag>
+
    <aired></aired>
  <tag>Tag2</tag>
+
    <studio>Studio 54</studio>
  <director>Meiert Avis</director>
+
    <trailer></trailer>
  <year>1987</year>
+
    <fileinfo>
  <status></status>
+
        <streamdetails>
  <code><code></code></code>
+
            <video>
  <aired></aired>
+
                <codec>hevc</codec>
  <studio>Windmill Lane</studio>
+
                <aspect>1.792230</aspect>
  <trailer></trailer>
+
                <width>716</width>
  <fileinfo>
+
                <height>568</height>
    <streamdetails>
+
                <durationinseconds>143</durationinseconds>
      <audio>
+
                <stereomode></stereomode>
        <codec>mp3</codec>
+
            </video>
        <language></language>
+
            <audio>
        <channels>2</channels>
+
                <codec>ac3</codec>
      </audio>
+
                <language>eng</language>
    </streamdetails>
+
                <channels>2</channels>
  </fileinfo>
+
            </audio>
  <artist>U2</artist>
+
        </streamdetails>
  <resume>
+
    </fileinfo>
    <position>0.000000</position>
+
    <artist>ABBA</artist>
    <total>0.000000</total>
+
    <resume>
  </resume>
+
        <position>0.000000</position>
  <dateadded>2014-10-23 08:18:47</dateadded>
+
        <total>0.000000</total>
  <art>
+
    </resume>
    <fanart>E:\Music Videos- Test\U2 - Where The Streets Have No Name-fanart.jpg</fanart>
+
    <dateadded>2018-09-10 09:46:06</dateadded>
    <poster>E:\Music Videos- Test\U2 - Where The Streets Have No Name-poster.jpg</poster>
+
</musicvideo>
  </art>
+
</syntaxhighlight>
</musicvideo>
 
 
{{collapse bottom}}
 
{{collapse bottom}}
  
  
  
= Technical Notes =
+
= References =
There are differences in tags used by Single File Export and Separate File Export. Though testing reveals that transposing tages between the two has no detrimental affect on the scrape.
+
<references />
 
 
{|class="prettytable"
 
! XML Tag
 
! Exported in
 
Single File
 
! Exported in
 
Separate File
 
! Notes
 
|-
 
|<file></file> || Yes || No ||
 
|-
 
|<path></path> || Yes || No ||
 
|-
 
|<filenameandpath></filenameandpath> || Yes || No ||
 
|-
 
|<basepath></basepath> || Yes || No ||
 
|-
 
|
 
<art>
 
  <fanart></fanart>
 
  <poster></poster>
 
</art>
 
|| Yes || No ||
 
|}
 
 
 
  
  
Line 255: Line 223:
 
{{top}}
 
{{top}}
  
{{updated|17}}
+
{{updated|18}}
 
[[Category:FAQ]]
 
[[Category:FAQ]]
 
[[Category:Index]]
 
[[Category:Index]]

Latest revision as of 09:03, 18 August 2019

NFO Contents

See also:


Return to:

Home icon grey.png   ▶ NFO files ▶ Music videos


1 Requirements

The order of importing metadata is as follows:

  1. nfo file. If no nfo file exists, then
  2. Depending on your scraper settings for your source, either
    1. Online scraper sites- if a scraper is set in your source settings
    2. Nothing- if Local Info Only is set

When Kodi locates the nfo file it will load the *.nfo file and:

  1. If the file is a metadata nfo, Kodi will import the meta-data directly into the library from the .nfo file or
  2. If the file is a parsing nfo, Kodi will parse the nfo file for a direct URL to the scraper info page, then scrape the online metadata.
  3. If the file is a combination nfo, Kodi will parse the nfo file and scrape the online metadata, then import the metadata from the nfo file.


1.1 Known Issues

  • v18 introduced a bug where any class of nfo file can be scanned into any part of the video library. See Issue 16112


2 nfo Name and Location

Regardless of what settings you have set for the source and scraper, Kodi will always search for and scan the nfo file first where available.

Correct placement of the nfo file is essential. Failing to save the file with the correct name and in the correct location, as detailed below, will force Kodi to either:

  1. Scrape the metadata from the online source set in your scraper or,
  2. If you have Local Info Only set as your scraper, then no entry will be made into the library.


Music Videos require one nfo for each music video in the folder. These nfo files need to be named exactly as the Music Video file is named, but with the nfo extension.

The below image shows an example of correct naming and placement of the artwork alongside the nfo file and the Music Video media file.


3 Music Video Tags

A list of all available tags that Kodi recognises follows in this section.

NFO (xml) Tag Required Multiple Notes
<musicvideo></musicvideo> Yes No The top level parent tag for the nfo file. All other tags must be contained within these two tags
<title></title> No No Name of music video
<userrating></userrating> No No Personal rating applied by the user
<top250></top250> No No Not Used
<track></track> No No Not Used
<album></album> No No Name of album the song appears on
<outline></outline> No No Not Used
<plot></plot> No No Can contain more information on multiple lines, will be wrapped
<tagline></tagline> No No Not Used
<runtime></runtime> No No Duration of Music Video in minutes
<thumb preview=""></thumb> No Yes Path to TV Show and Season artwork
<mpaa></mpaa> No No Not Used
<playcount></playcount> No No Setting this to 1, or greater, will mark the Music Video as watched on import if the importwatchedstate flag is set in advancedsettings.xml
<id></id> No No Not Used
<genre></genre> No Yes Genre
<tag></tag> No Yes Video tags. See: Video library tags
<director></director> No No Director of the music video
<year></year> No No Year released
<status></status> No No Not Used
<code></code> No No Not Used
<aired></aired> No No Not Used
<studio></studio> No Yes Production studio
<trailer></trailer> No No Not used
   <fileinfo>
       <streamdetails>
           <video>
               <codec></codec>
               <aspect></aspect>
               <width></width>
               <height></height>
               <durationinseconds></durationinseconds>
               <stereomode></stereomode>
           </video>
           <audio>
               <codec></codec>
               <language></language>
               <channels></channels>
           </audio>
       </streamdetails>
   </fileinfo>
No No While it is possible to manually set the information contained within the <streamdetails> tag, there is little point in doing so.

Kodi will always overwrite this data when it plays back the video file.
In other words, no matter how many times you try to manually set it, it will be overwritten the moment the video is played

<artist></artist> No Yes The artist of the song
<resume>
  <position></position>
  <total></total>
</resume>
No No Not Used
<dateadded></dateadded> No No Date the file was added to library. Can be altered in advancedsettings.xml


4 Template nfo

A template NFO File is provided below that can be copied into your own file and completed. It is a simplified file:

  • System generated tags are removed
  • Assumes local artwork is being used
  • Assumes no online information is available, so items like Ratings have no relevance
  • This will be the first time scanned into library so watched status and play counts are not required.

If any of these removed tags are required, simply add the appropriate tags, and refer to the Sample NFO File in the next section to confirm correct usage.

 1 <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
 2 <musicvideo>
 3     <title></title>
 4     <userrating></userrating>
 5     <track></track>
 6     <album></album>
 7     <plot></plot>
 8     <genre></genre>
 9     <director></director>
10     <premiered></premiered>
11     <studio></studio>
12     <artist></artist>
13 </musicvideo>


5 Sample nfo

Sample Music Video nfo from Single File Export


6 References



Return to top