edde746
05fd622968
Emby is Jellyfin's upstream ancestor and speaks a near-identical MediaBrowser
API, so the existing Jellyfin stack is parameterised by a `MediaBrowserDialect`
rather than forked. `JellyfinClient`, its auth service, endpoint discovery, LAN
discovery, and the add/edit connection screens all take the dialect and keep one
implementation; `MediaBackend.emby` and `ConnectionKind.emby` carry it through
the neutral models, the Drift `kind` discriminator, downloads, and caches.
Every divergence below was measured against a live Emby 4.9.5 server, not
inferred from documentation, and each is documented at its capability getter.
Jellyfin's request strings stay byte-identical so nothing about its behaviour
changes.
Routes and auth
- Emby only accepts the pre-10.9 user-scoped item routes (`/Users/{id}/Items/…`,
`/Users/{id}/PlayedItems/…`, `/Users/{id}/FavoriteItems/…`); the unprefixed
forms Jellyfin 10.11 added return 404.
- The API is also served under a legacy `/emby` prefix, and both dialects accept
the token as `X-Emby-Token` or `api_key=`.
- Emby answers only its own LAN discovery datagram ("who is EmbyServer?") and
ignores Jellyfin's; its default HTTPS port is 8920.
- No `/QuickConnect` route exists, so Quick Connect stays Jellyfin-only.
Row fields Emby withholds
- `ProductionYear`, `OfficialRating`, `PremiereDate` and `DateCreated` are absent
from list rows unless named in `Fields`, which would otherwise strip the year
and age-rating badge from every card in the app.
- `UserData.LastPlayedDate` never appears on a list row under `Fields=UserData`,
`EnableUserData=true` or the user-scoped `Ids=` form — only on the single-item
detail route, or when the Emby-specific `UserDataLastPlayedDate` token is
requested. Without it every recency-ordered surface silently degrades to
library-add time, and `JellyfinApiCache.applyWatchState` stamps
`DateTime.now()` on watched rows, so an offline watch-state pull would rewrite
the cached play time of everything it walked.
Continue Watching and Next Up
- Emby computes Next Up per series only: the library-wide `/Shows/NextUp` query
returns nothing under every parameter combination tried. The shelf is
therefore reconstructed from a played-episode recency scan plus one
`/Shows/NextUp?SeriesId=` per distinct series, bounded by a shared wall clock
that covers the scan as well — per-request timeouts cannot bound the pass
because `MediaServerHttpClient` times the connect and receive phases
independently. Rows are stamped with their series' newest play from the same
response that ordered them, so no per-series enrichment request is needed.
- `/Shows/NextUp` ignores `NextUpDateCutoff`, and no server-side played-date
filter exists to delegate to (`MinDatePlayed` and `MinDateLastPlayed` are
ignored; `MinDateLastSaved`, `MinDateCreated` and `MinPremiereDate` filter
unrelated dates), so the 365-day window is applied to the scanned dates.
- The resume route returns items with no saved position, including plain next
episodes, so the Emby resume leg reads from `/Items?Filters=IsResumable`.
- Emby is ahead of Jellyfin in one place: `/Users/{id}/Items/{id}/HideFromResume`
makes Continue Watching removal a real capability.
Everything else
- `/Sessions/Playing` and `/Sessions/Playing/Progress` reject a body with no
`PlaySessionId` (HTTP 400), so playback reporting always sends one.
- Passing any `MediaTypes` value to the playlist query returns an empty list.
- There is no aggregate `/Items/Filters` route; the four filter facets are
reassembled from `/Genres`, `/OfficialRatings`, `/Studios` and `/Tags`.
- Metadata writes take name-pair lists (`Genres: [{'Name': 'Action'}]`); the
plain string array is accepted and then silently discarded.
- Custom artwork uploads must be base64 text, not raw bytes — which was broken
for Jellyfin too and is fixed for both.
- Trickplay, media segments and lyrics 404 on Emby, so scrub previews are absent
and intro/credit markers fall back to chapter names.
Verified against a local Emby 4.9.5 and a Jellyfin 10.11.11 control server:
onboarding, browse, detail, playable stream URLs serving real bytes, subtitle
sidecars, watch-state write and restore, hubs, cross-server aggregation and
search across both backends simultaneously.
65 lines
3.1 KiB
Dart
65 lines
3.1 KiB
Dart
import '../media/media_browser_dialect.dart';
|
|
|
|
/// Route builders for the endpoints where the Jellyfin and Emby dialects of the
|
|
/// MediaBrowser API diverge.
|
|
///
|
|
/// Jellyfin 10.9 renamed a batch of user-scoped routes to unprefixed forms
|
|
/// (`/Users/{uid}/PlayedItems/{id}` → `/UserPlayedItems/{id}`) and introduced
|
|
/// `/Users/Me`. Emby only ever shipped the user-scoped spellings and fails on
|
|
/// the new ones — `/Users/Me` returns 500 `Unrecognized Guid format` because
|
|
/// `Me` is bound as a user id, and the rest 404. Keeping every divergent route
|
|
/// here lets the client parts stay dialect-agnostic.
|
|
///
|
|
/// Routes that are identical on both dialects (`/Items`, `/Users/{uid}/Views`,
|
|
/// `/Users/{uid}/Items/{id}`, `/Users/{uid}/Items/Latest`, `/Shows/*`,
|
|
/// `/Sessions/Playing*`, `/Items/{id}/PlaybackInfo`, image and stream routes)
|
|
/// deliberately do not appear here.
|
|
class MediaBrowserPaths {
|
|
const MediaBrowserPaths({required this.dialect, required this.userId});
|
|
|
|
final MediaBrowserDialect dialect;
|
|
final String userId;
|
|
|
|
String get _user => '/Users/${Uri.encodeComponent(userId)}';
|
|
|
|
static String _id(String itemId) => Uri.encodeComponent(itemId);
|
|
|
|
/// The authenticated user's own DTO — health probe and user-preference read.
|
|
String get currentUser => dialect.requiresUserScopedItemRoutes ? _user : '/Users/Me';
|
|
|
|
/// Continue Watching / resumable items.
|
|
String get resumeItems => dialect.requiresUserScopedItemRoutes ? '$_user/Items/Resume' : '/UserItems/Resume';
|
|
|
|
/// Played flag write route (`POST` to mark, `DELETE` to unmark).
|
|
String playedItem(String itemId) =>
|
|
dialect.requiresUserScopedItemRoutes ? '$_user/PlayedItems/${_id(itemId)}' : '/UserPlayedItems/${_id(itemId)}';
|
|
|
|
/// Favourite flag write route (`POST` to add, `DELETE` to remove).
|
|
String favoriteItem(String itemId) => dialect.requiresUserScopedItemRoutes
|
|
? '$_user/FavoriteItems/${_id(itemId)}'
|
|
: '/UserFavoriteItems/${_id(itemId)}';
|
|
|
|
/// Thumbs-up/down write route (`POST ?Likes=`, `DELETE` to clear).
|
|
String itemRating(String itemId) =>
|
|
dialect.requiresUserScopedItemRoutes ? '$_user/Items/${_id(itemId)}/Rating' : '/UserItems/${_id(itemId)}/Rating';
|
|
|
|
/// Trailers attached to a movie/series.
|
|
String localTrailers(String itemId) => dialect.requiresUserScopedItemRoutes
|
|
? '$_user/Items/${_id(itemId)}/LocalTrailers'
|
|
: '/Items/${_id(itemId)}/LocalTrailers';
|
|
|
|
/// Extras/behind-the-scenes children.
|
|
String specialFeatures(String itemId) => dialect.requiresUserScopedItemRoutes
|
|
? '$_user/Items/${_id(itemId)}/SpecialFeatures'
|
|
: '/Items/${_id(itemId)}/SpecialFeatures';
|
|
|
|
/// Hide an item from Continue Watching without touching its playback
|
|
/// position (`?Hide=true` to hide, `?Hide=false` to restore).
|
|
///
|
|
/// Emby-only: Jellyfin 10.11 has no equivalent under either spelling
|
|
/// (measured 404 for both `/UserItems/{id}/HideFromResume` and the
|
|
/// user-scoped form), which is why [ServerCapabilities.jellyfin] leaves
|
|
/// `continueWatchingRemoval` false while [ServerCapabilities.emby] sets it.
|
|
String hideFromResume(String itemId) => '$_user/Items/${_id(itemId)}/HideFromResume';
|
|
}
|