NFO files/Music videos: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(Updated for v19)
Line 1: Line 1:
{{NFO_content}}
{{NFO_content}}
{{mininav|[[NFO files]]}}
{{mininav|[[NFO files]]}}


 
__TOC__
= Requirements =
The order of importing metadata is as follows:
#nfo file. If no nfo file exists, then
#Depending on your scraper settings for your source, either
##Online scraper sites- if a scraper is set in your source settings
##Nothing- if Local Info Only is set
 
When Kodi locates the nfo file it will load the *.nfo file and:
#If the file is a metadata nfo, Kodi will import the meta-data directly into the library from the .nfo file or
#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.
#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.




 
= Introduction =
== Known Issues ==
The Music Video library uses the Video Library database. Music Video entries displayed in {{kodi}} can also access information from the Music Library if the same artist and album that contains the music video song is also in the Music Library.
* 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]




Line 25: Line 12:
= nfo Name and Location =
= 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.}}'''
'''{{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.}}'''
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:
#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.


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.
Line 47: Line 29:
! NFO (xml) Tag || Required || Multiple || Notes
! NFO (xml) Tag || Required || Multiple || Notes
|-
|-
|<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
|<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
|<title></title> || {{Yes}} || No || Name of music video
|-
|-
|<userrating></userrating> || No || No || Personal rating applied by the user
|<userrating></userrating> || No || No || Personal rating applied by the user
Line 61: Line 43:
|<outline></outline> || No || No || Not Used
|<outline></outline> || No || No || Not Used
|-
|-
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
|<plot></plot> || No || No || Review / information of music video
|-
|-
|<tagline></tagline> || No || No || Not Used
|<tagline></tagline> || No || No || Not Used
|-
|-
|<runtime></runtime> || No || No || Duration of Music Video in minutes
|<runtime></runtime> || No || No || Minutes only. If ommitted, {{kodi}} will add runtime upon scanning
|-
|-
|<thumb preview=""></thumb> || No || Yes || Path to TV Show and Season artwork
|<thumb aspect="thumb" preview=""></thumb> || No || Yes || Path to TV Show and Season artwork
|-
|-
|<mpaa></mpaa> || No || No || Not Used
|<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
|<playcount></playcount> || No || No || Setting this to 1 or greater will mark the Music Video
|-
|<lastplayed></lastplayed> || No || No || Date last played as ''yyyy-mm-dd''
|-
|-
|<id></id> || No || No || Not Used
|<id></id> || No || No || Not Used
Line 77: Line 61:
|<genre></genre> || No || Yes || Genre
|<genre></genre> || No || Yes || Genre
|-
|-
|<tag></tag> || No || Yes || Video tags. See: ''[[Video library tags]]''
|<tag></tag> || No || Yes || Video tags. See: '''[[Video library tags]]'''
|-
|-
|<director></director> || No || Yes || Director of the music video
|<director></director> || No || Yes || Director of the music video
Line 115: Line 99:
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></artist> || No || Yes || The artist of the song
|  
<actor>
    <name>Taylor Swift</name>
    <role></role>
    <order>0</order>
    <thumb></thumb>
</actor>  
|| No || Yes || The artist of the song
|-
| <artist></artist> || {{yes}} || Yes || The artists/actors in the music video
|-
|-
|
|
Line 124: Line 117:
|| No || No || Not Used
|| No || No || Not Used
|-
|-
|<dateadded></dateadded> || No || No || Date the file was added to library. Can be altered in advancedsettings.xml
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}
|}
= 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
{{collapse top| Music Video nfo file  (click 'expand' to view)}}
<syntaxhighlight lang="xml" line='line'>
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<musicvideo>
    <title>Dancing Queen</title>
    <userrating>0</userrating>
    <top250>0</top250>
    <track>3</track>
    <album>Arrival</album>
    <outline></outline>
    <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>
    <tagline></tagline>
    <runtime>2</runtime>
    <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/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>
    <mpaa></mpaa>
    <playcount>0</playcount>
    <lastplayed></lastplayed>
    <id></id>
    <genre>Pop</genre>
    <director>John Smith</director>
    <premiered>1976-01-01</premiered>
    <year>1976</year>
    <status></status>
    <code></code>
    <aired></aired>
    <studio>Studio 54</studio>
    <trailer></trailer>
    <fileinfo>
        <streamdetails>
            <video>
                <codec>hevc</codec>
                <aspect>1.792230</aspect>
                <width>716</width>
                <height>568</height>
                <durationinseconds>143</durationinseconds>
                <stereomode></stereomode>
            </video>
            <audio>
                <codec>ac3</codec>
                <language>eng</language>
                <channels>2</channels>
            </audio>
        </streamdetails>
    </fileinfo>
    <artist>ABBA</artist>
    <resume>
        <position>0.000000</position>
        <total>0.000000</total>
    </resume>
    <dateadded>2018-09-10 09:46:06</dateadded>
</musicvideo>
</syntaxhighlight>
{{collapse bottom}}




Line 217: Line 124:
= References =
= References =
<references />
<references />




Line 222: Line 130:


{{top}}
{{top}}
{{updated|19}}


{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Video library]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Revision as of 00:09, 23 April 2021

NFO Contents

NFO Main Page


See also:


Return to:

Home icon grey.png   ▶ NFO files ▶ Music videos


Introduction

The Music Video library uses the Video Library database. Music Video entries displayed in Kodi can also access information from the Music Library if the same artist and album that contains the music video song is also in the Music Library.


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.

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.


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> Yes 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 Review / information of music video
<tagline></tagline> No No Not Used
<runtime></runtime> No No Minutes only. If ommitted, Kodi will add runtime upon scanning
<thumb aspect="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
<lastplayed></lastplayed> No No Date last played as yyyy-mm-dd
<id></id> No No Not Used
<genre></genre> No Yes Genre
<tag></tag> No Yes Video tags. See: Video library tags
<director></director> No Yes Director of the music video
<year></year> No No Year released
<status></status> No No Not Used
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

<actor>
   <name>Taylor Swift</name>
   <role></role>
   <order>0</order>
   <thumb></thumb>
</actor> 
No Yes The artist of the song
<artist></artist> Yes Yes The artists/actors in the music video
<resume>
  <position></position>
  <total></total>
</resume>
No No Not Used
<dateadded></dateadded> No No mTime of the playable video file. Can be altered in advancedsettings.xml
See... Advancedsettings.xml#videolibrary


References




Return to top