aboutsummaryrefslogtreecommitdiff
path: root/doc/import/providers.md
blob: 9b438c6e3ec2357552429f369f1564e5214c8d04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Metadata Providers

## `override`

Allows for manual hardcoded metadata.

Special to this option are the `poster` and `backdrop` properties in the
`private` section. These are reference images local to _library\_path_ and
directly set the counterparts in `public`.

### Example

```yaml
id: library
sources:
  - !override
    public:
      kind: !collection
      title: "My Library"
      children:
        - movies
        - stuff
    private:
      poster: library.png
```

## `auto_children`

Scans the directory of the file currently processed for `*.yaml` and `.jelly`,
parses their ID and adds them as `children`.

## `media`

This references a media file on disk and links it to this node. Additionally it
extracts matroska metadata aswell.

> [!NOTE] 
> If `path` is a directory, then these options are applied recursively
> all files inside, automatically creating new nodes based on inferred IDs and
> linking them up.

### Example

```yaml
id: decay-2012
sources:
- !media
  path: /movies/decay.webm
  ignore_metadata: true
  ignore_attachments: false
  ignore_chapters: false
```

## `trakt`

The recommended provider for any movie, show or season. It automatically queries
other linked APIs.

### Example

```yaml
id: decay-2012
sources:
- !trakt
  kind: movie
  id: 98052
```

## `tmdb`

Just like `trakt` but uses only TMDB instead.