Overriding Metadata

There are times when you wish to override the metadata fetched from the internet with your own versions. Sapphire allows this through XML files. If you wish to override the metadata for a particular file, create an xml file in the same directory, with the same name except for the .xml extension, when Sapphire imports the data, it will also read the xml files, and use it to override all other data. For example, if you wished to override data for “300.avi”, you would create a file named “300.xml”. The format for the xml file is as follows:

<media type="Movie">
    <title>Title</title>
    <summary>Summary of Media</summary>
    <description>Description of Media</description>
    <copyright>Copyright</copyright>
    <userStarRating>5</userStarRating>
    <rating>TV-PG</rating>
    <published>2006-01-01</published>
    <genres>
        <genre primary="true">Mystery</genre>
        <genre>Drama</genre>
    </genres>
    <cast>
        <name>Kristen Bell</name>
    </cast>
    <producers>
        <name>Rob Thomas</name>
    </producers>
    <directors>
        <name>Rob Thomas</name>
    </directors>
</media>

Thanks to Eric Steil III for this example

Then, simply run the import tool, and Sapphire will read the data from this file.
Note: You do not need to complete every entry in this XML file. The data in this file is combined with data from other sources. If you wish to simply override a certain field, such as Title, make an XML file with only the Title entry, and the other fields will still remain as fetched from the internet.

A TV show would be like the following:

<media type="TV Show">
    <title>Title</title>
    <summary>Summary of Media</summary>
    <description>Description of Media</description>
    <userStarRating>5</userStarRating>
    <rating>TV-PG</rating>
    <seriesName>Veronica Mars</seriesName>
    <episodeNumber>101</episodeNumber>
    <season>1</season>
    <episode>1</episode>
    <secondEpisode>2</secondEpisode>
    <published>2006-01-01</published>
</media>

In addition, XML files can be used to direct the search for a movie or episode. The following defines all the search parameters. It also defines a time in which to capture a screenshot from the file itself (image capture doesn’t work on the AppleTV):

<media>
    <searchSeason>1</searchSeason>
    <searchEpisode>1</searchEpisode>
    <searchSecondEpisode>2</searchSecondEpisode>
    <searchIMDB>111122</searchIMDB>
    <imageTime>1:34:54</imageTime>
</media>

Search terms can be combined with override terms in cases where the network fetched version is incorrect. For example, the order on TVRage for Firefly is incorrect, so the following fetches the correct info for each file and overrides the episode numbering (named Firefly.S01E09 Ariel.xml):

<media>
    <searchEpisode>8</searchEpisode>
    <episode>9</episode>
</media>