Custom Metadata Provider what to return on match

Dev Community Dev/API Corner
1

Hello all,

In my custom provider I’m currently returning all the metadata in the match response, however I noticed Plex still calls my /metadata endpoint where I also return all the metadata, so my question is what is the minimal amount of metadata do I need to return on the match request?

Also in the documentation they have this:

Image endpoint (Recommended)

The Metadata feature should also provide a /images path for calls to specific items, e.g. /library/metadata/tmdb-movie-123/images. This endpoint should return a MediaContainer object containing and Image Array of all the available image assets for that item.

Example:

{
  "MediaContainer": {
    "offset": 0,
    "totalSize": 3,
    "identifier": "tv.plex.provider.metadata",
    "size": 3,
    "Image": [
      {
        "type": "coverPoster",
        "url": "https://image.tmdb.org/t/p/original/qk3eQ8jW4opJ48gFWYUXWaMT4l.jpg",
      },
      {
        "type": "background",
        "url": "https://image.tmdb.org/t/p/original/3uE9SUywNbj1qSAuYCGgbTTYku5.jpg",
      },
      {
        "type": "clearLogo",
        "url": "https://image.tmdb.org/t/p/original/rIi0lY2UftYuKDJ4OlIefDdijve.png",
      }
    ]
  }
}

However the MediaContainer object doesn’t have a Image property, at least not in the definition given on the GitHub documentation

MediaContainer

The root object that contains metadata and pagination information.

Field Type Description
offset integer The starting position in the result set (always 0 for single items)
totalSize integer Total number of items in the response (always 1 for single items)
identifier string The provider identifier (e.g., “tv.plex.provider.metadata”)
size integer Number of items in the current response (always 1 for single items)
Metadata array Array containing a single movie metadata object

Will Plex accept a MediaContainer with an Image property or should it be a MediaObject with a Metadata object that only has an Image array, and I assume all the other required properties of a Metadata object?

Thanks

Allen

2

I answered my own question, I tried both ways and Metadata object with a Image array works