github/plexpy
1
0
Fork 0
mirror of https://github.com/Tautulli/Tautulli.git synced 2025-03-12 04:35:40 -07:00
Code Issues Packages Projects Releases Wiki Activity

v2.15.0

JonnyWong16 2024-11-24 15:05:08 -08:00
parent cd1d57e37a
commit 5aa552575e
1 changed files with 23 additions and 3 deletions

26
Exporter-Guide.md

@ -95,13 +95,13 @@ The exporter has several predefined export levels. The export levels are separat
## <a id="image-export">Image Exports</a>
[Poster/cover images and background artwork](./images/exporter_images.png) can be exported along with the metadata. Images will be exported to a `.images` folder alongside the data file with the extension `.thumb.jpg` for posters/covers and `.art.jpg` for background artwork. When downloading an export from the [metadata exports table](./images/exporter_table.png), the images will be included in a `zip` archive with the data file.
[Poster/cover images and background artwork](./images/exporter_images.png) can be exported along with the metadata. Images will be exported to a `.images` folder alongside the data file with the extension `.thumb.jpg` for posters/covers, `.art.jpg` for background artwork, and `.logo.jpg` for logos. When downloading an export from the [metadata exports table](./images/exporter_table.png), the images will be included in a `zip` archive with the data file.
* **Warning:** Exporting images may take a long time!
* **Note:** Images will only be exported by the selected image export level for the following supported media types:
* Movies, shows, seasons, artists, albums, collections and collection items, playlist items
* **Note:** Additional images for _any_ media type can be exported by adding `thumbFile` for posters/covers and `artFile` for background artwork to the custom metadata fields. Adding the custom field will export _all_ images of that type regardless of the selected image export level.
* **Note:** Additional images for _any_ media type can be exported by adding `thumbFile` for posters/covers, `artFile` for background artwork, and `logoFile` for logos to the custom metadata fields. Adding the custom field will export _all_ images of that type regardless of the selected image export level.
* e.g. Adding `episodes.thumbFile` to the custom metadata fields will export all episode thumbnails even though it is not included in the supported image export media types.
### <a id="image-export-level">Image Export Levels</a>
@ -120,10 +120,15 @@ The exporter has several predefined export levels. The export levels are separat
| **Level 2** | Selected and Locked Artwork Only | Only currently selected background artwork images which have been changed from the default artwork. |
| **Level 9** | All Selected Artwork | All background artwork images for the supported media types. |
| Logo Image Export Level | Name | Description |
| :---: | --- | --- |
| **Level 0** | None / Custom | No logo images will be exported. Specific logos can be exported by adding `logoFile` to the custom metadata fields. |
| **Level 1** | Uploaded and Selected Logos Only | Only custom logo images which have been uploaded manually and are currently selected as the active artwork. |
| **Level 2** | Selected and Locked Logos Only | Only currently selected logo images which have been changed from the default logo. |
| **Level 9** | All Selected Logos | All logo images for the supported media types. |
## <a id="media-type-field">Media Type Fields</a>
### <a id="movie">Movies</a>
<details>
@ -147,6 +152,7 @@ The exporter has several predefined export levels. The export levels are separat
| `guid` | | ✓ | ✓ | ✓ | ✓ |
| `hasCreditsMarker` | | ✓ | ✓ | ✓ | ✓ |
| `hasPreviewThumbnails` | | | | ✓ | ✓ |
| `hasVoiceActivity` | | | | ✓ | ✓ |
| `key` | | | | ✓ | ✓ |
| `languageOverride` | | | | | ✓ |
| `lastRatedAt` | | | | ✓ | ✓ |
@ -154,6 +160,9 @@ The exporter has several predefined export levels. The export levels are separat
| `librarySectionID` | | | | | ✓ |
| `librarySectionKey` | | | | | ✓ |
| `librarySectionTitle` | | | | | ✓ |
| `logo` | | | | | ✓ |
| `logoFile` | Refer to [Image Exports](#image-export) | | | | |
| `logoProvider` | | | | | ✓ |
| `metadataDirectory` | | | | | ✓ |
| `originalTitle` | | ✓ | ✓ | ✓ | ✓ |
| `originallyAvailableAt` | | ✓ | ✓ | ✓ | ✓ |
@ -227,6 +236,7 @@ The exporter has several predefined export levels. The export levels are separat
| `media.container` | | ✓ | ✓ | ✓ | ✓ |
| `media.duration` | | ✓ | ✓ | ✓ | ✓ |
| `media.has64bitOffsets` | | | | | ✓ |
| `media.hasVoiceActivity` | | | | | ✓ |
| `media.hdr` | | ✓ | ✓ | ✓ | ✓ |
| `media.height` | | ✓ | ✓ | ✓ | ✓ |
| `media.id` | | | | | ✓ |
@ -285,6 +295,7 @@ The exporter has several predefined export levels. The export levels are separat
| `media.parts.audioStreams.streamType` | | | | | ✓ |
| `media.parts.audioStreams.title` | | | | ✓ | ✓ |
| `media.parts.audioStreams.type` | | | | | ✓ |
| `media.parts.subtitleStreams.canAutoSync` | | | | | ✓ |
| `media.parts.subtitleStreams.codec` | | | | ✓ | ✓ |
| `media.parts.subtitleStreams.container` | | | | ✓ | ✓ |
| `media.parts.subtitleStreams.default` | | | | ✓ | ✓ |
@ -396,6 +407,9 @@ The exporter has several predefined export levels. The export levels are separat
| `librarySectionID` | | | | | ✓ |
| `librarySectionKey` | | | | | ✓ |
| `librarySectionTitle` | | | | | ✓ |
| `logo` | | | | | ✓ |
| `logoFile` | Refer to [Image Exports](#image-export) | | | | |
| `logoProvider` | | | | | ✓ |
| `metadataDirectory` | | | | | ✓ |
| `network` | | ✓ | ✓ | ✓ | ✓ |
| `originalTitle` | | ✓ | ✓ | ✓ | ✓ |
@ -549,6 +563,7 @@ The exporter has several predefined export levels. The export levels are separat
| `hasCreditsMarker` | | ✓ | ✓ | ✓ | ✓ |
| `hasIntroMarker` | | ✓ | ✓ | ✓ | ✓ |
| `hasPreviewThumbnails` | | | | ✓ | ✓ |
| `hasVoiceActivity` | | | | ✓ | ✓ |
| `index` | | | | | ✓ |
| `key` | | | | ✓ | ✓ |
| `lastRatedAt` | | | | ✓ | ✓ |
@ -628,6 +643,7 @@ The exporter has several predefined export levels. The export levels are separat
| `media.container` | | ✓ | ✓ | ✓ | ✓ |
| `media.duration` | | ✓ | ✓ | ✓ | ✓ |
| `media.has64bitOffsets` | | | | | ✓ |
| `media.hasVoiceActivity` | | | | | ✓ |
| `media.hdr` | | ✓ | ✓ | ✓ | ✓ |
| `media.height` | | ✓ | ✓ | ✓ | ✓ |
| `media.id` | | | | | ✓ |
@ -686,6 +702,7 @@ The exporter has several predefined export levels. The export levels are separat
| `media.parts.audioStreams.streamType` | | | | | ✓ |
| `media.parts.audioStreams.title` | | | | ✓ | ✓ |
| `media.parts.audioStreams.type` | | | | | ✓ |
| `media.parts.subtitleStreams.canAutoSync` | | | | | ✓ |
| `media.parts.subtitleStreams.codec` | | | | ✓ | ✓ |
| `media.parts.subtitleStreams.container` | | | | ✓ | ✓ |
| `media.parts.subtitleStreams.default` | | | | ✓ | ✓ |
@ -1205,6 +1222,7 @@ The exporter has several predefined export levels. The export levels are separat
| `hasCreditsMarker` | | ✓ | ✓ | ✓ | ✓ |
| `hasIntroMarker` | | ✓ | ✓ | ✓ | ✓ |
| `hasPreviewThumbnails` | | | | ✓ | ✓ |
| `hasVoiceActivity` | | | | ✓ | ✓ |
| `index` | | | | | ✓ |
| `key` | | | | ✓ | ✓ |
| `lastRatedAt` | | | | ✓ | ✓ |
@ -1284,6 +1302,7 @@ The exporter has several predefined export levels. The export levels are separat
| `media.container` | | ✓ | ✓ | ✓ | ✓ |
| `media.duration` | | ✓ | ✓ | ✓ | ✓ |
| `media.has64bitOffsets` | | | | | ✓ |
| `media.hasVoiceActivity` | | | | | ✓ |
| `media.hdr` | | ✓ | ✓ | ✓ | ✓ |
| `media.height` | | ✓ | ✓ | ✓ | ✓ |
| `media.id` | | | | | ✓ |
@ -1342,6 +1361,7 @@ The exporter has several predefined export levels. The export levels are separat
| `media.parts.audioStreams.streamType` | | | | | ✓ |
| `media.parts.audioStreams.title` | | | | ✓ | ✓ |
| `media.parts.audioStreams.type` | | | | | ✓ |
| `media.parts.subtitleStreams.canAutoSync` | | | | | ✓ |
| `media.parts.subtitleStreams.codec` | | | | ✓ | ✓ |
| `media.parts.subtitleStreams.container` | | | | ✓ | ✓ |
| `media.parts.subtitleStreams.default` | | | | ✓ | ✓ |