Skip to content

Media Importers

Sascha Montellese edited this page Mar 14, 2021 · 7 revisions

This page describes existing and potential media importers capable of importing media items from a specific provider.

Kodi core importers

The following importers are part of Kodi core:

UPnP media importer

The UPnP media importer is written in C++ and is part of Kodi core. It uses Kodi's UPnP integration based on Platinum SDK. Kodi automatically detects other UPnP servers as potential media providers. Furthermore each Kodi installation with UPnP sharing enabled is a potential media provider for other Kodi installations.

Features

  • Can automatically detect potential providers
  • Can import full lists of media items
  • Can update playback related metadata (watched, playcount, resume point) on the provider

Missing features

  • Cannot automatically detect changes on the provider
  • Cannot provide changesets of imported media items
  • Cannot update metadata on the provider

Instructions

Used as Server Only

  • Settings>Services>UPnP/DLNA
    • Enable UPnP Support - Enable

Used as Client or as Client & Server

  • Settings>Settings>UPnP/DLNA

    • Enable UPnP Support - Enable (for Server and Client)
    • Import Media Items from UPnP Servers - Enable (for Client Only)
  • Settings>Media Sources

    • All Media Providers or Active Media Providers (Either should work).
      • You should see your UPnP Server here, select it
      • Choose Add Imports,
        • Select the desired media type, and confirm options on Import Dialog
        • Repeat as required

Add-on media importer

The add-on media importer is written in C++ and is part of Kodi core. It provides a new extension point kodi.mediaimporter for add-ons and therefore allows developers to write completely new media importers as add-ons. The add-on media importer supports several features while most of them are optional.

Features

  • Can automatically detect potential providers using the discovery script
  • Can manually add providers using the protocol attribute, the <canlookupprovider> tag and the library script
  • Can import full or partial list of media items using the library script
  • Can observe providers for changes and pass them to Kodi immediately as a changeset using the observer script
  • Can define provider specific settings
  • Can provide import specific settings

kodi.mediaimporter extension point

See kodi.mediaimporter for a detailed documentation of the new extension point for add-ons.

Available media importer add-ons

The following media importer add-ons are available:

  • mediaimporter.emby - supports importing media items from Emby / Jellyfin servers.
    Source Code
    Setup Instructions
  • mediaimporter.plex - supports importing media items from Plex Media Servers.
    Source Code

Stub media importer

Use mediaimporter.stub as a base to write your own media importer add-on.