_mod_JELLYFIN

Sync engine module for Jellyfin (watchlist/history indexing and writes).

Provider ID: JELLYFIN Version (module): 2.1.0

Jellyfin support in the sync engine.

Use it to sync:

watchlist
history

Setup docs:

Entry point: sync/_mod_JELLYFIN.py

Provider surface

health()
build_index(feature)
add(feature, items)
remove(feature, items)

Features

watchlist → providers/jellyfin/_watchlist.py
history → providers/jellyfin/_history.py

Capabilities

bidirectional: true
provides_ids: false
index_semantics: "present"

Config

Config block name:

Jellyfin or jellyfin

Common keys:

server, access_token, user_id
verify_ssl (default true)
watchlist_mode (favorites or playlist)
history_libraries (optional whitelist)
timeout, max_retries

Gotchas

GUID selection affects matching.

Tune *_guid_priority if matches look off.

Runtime call flow

Orchestrator
  └─ OPS.build_index(cfg, feature)
       └─ JELLYFINModule.build_index(feature)
            └─ providers/jellyfin/_{feature}.py : build_index(adapter, ...)

Writes are symmetric:

Orchestrator plan → OPS.add/remove(...)
  └─ JELLYFINModule.add/remove(feature, items, dry_run=...)
       └─ providers/jellyfin/_{feature}.py : add/remove(adapter, items)

OPS contract

name()
label()
features()
capabilities()
is_configured(cfg)
build_index(cfg, feature=...)
add(cfg, items, feature=..., dry_run=False)
remove(cfg, items, feature=..., dry_run=False)
health(cfg)

Full config reference

Config namespace:

cfg["jellyfin"] (fallback: cfg["auth"]["jellyfin"])

Fields:

server, access_token, user_id
device_id (default: crosswatch)
verify_ssl (default: true)
timeout (default: 15.0)
max_retries (default: 3)
watchlist_mode (default: favorites)
watchlist_playlist_name (default: Watchlist)
watchlist_query_limit (default: 25)
watchlist_write_delay_ms (default: 0)
watchlist_guid_priority (list)
history_query_limit (default: 25)
history_write_delay_ms (default: 0)
history_guid_priority (list)
history_libraries (list)

Dependencies:

requires: ['requests']

Previousprogress Nextoverview

Last updated 4 months ago

Was this helpful?