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.
103 lines
3.9 KiB
Dart
103 lines
3.9 KiB
Dart
part of '../../jellyfin_client.dart';
|
|
|
|
/// Music browsing + playback-adjacent reads: artist discography, album track
|
|
/// listings, instant mix, and lyrics. Endpoint conventions follow the
|
|
/// Jellyfin web client's music surface (cross-checked against the Kotlin
|
|
/// SDK), mirroring the style notes at the top of `browse.dart`.
|
|
mixin _JellyfinMusicMethods on _JellyfinClientInternals {
|
|
/// Albums credited to [artist], newest first. Queries `AlbumArtistIds`
|
|
/// rather than `ParentId` because Jellyfin links albums to artists via
|
|
/// tags — an artist's albums are usually not its folder children.
|
|
@override
|
|
Future<List<MediaItem>> fetchArtistAlbums(MediaItem artist) async {
|
|
final response = await _http.get(
|
|
'/Items',
|
|
queryParameters: {
|
|
'userId': connection.userId,
|
|
'AlbumArtistIds': artist.id,
|
|
'IncludeItemTypes': 'MusicAlbum',
|
|
'Recursive': 'true',
|
|
'SortBy': 'PremiereDate,ProductionYear,SortName',
|
|
'SortOrder': 'Descending',
|
|
'Fields': _musicAlbumRowFields,
|
|
'EnableUserData': 'false',
|
|
...jellyfinImageQueryParameters,
|
|
},
|
|
);
|
|
throwIfHttpError(response);
|
|
return _mapItems(_itemsArray(response.data));
|
|
}
|
|
|
|
/// Tracks of [albumId] in disc/track order. `AlbumIds` (not `ParentId`) so
|
|
/// tag-based albums whose files share one physical folder still resolve;
|
|
/// `ParentIndexNumber,IndexNumber` yields correct multi-disc ordering.
|
|
@override
|
|
Future<List<MediaItem>> fetchAlbumTracks(String albumId) async {
|
|
final response = await _http.get(
|
|
'/Items',
|
|
queryParameters: {
|
|
'userId': connection.userId,
|
|
'AlbumIds': albumId,
|
|
'IncludeItemTypes': 'Audio',
|
|
'Recursive': 'true',
|
|
'SortBy': 'ParentIndexNumber,IndexNumber,SortName',
|
|
'SortOrder': 'Ascending',
|
|
'Fields': _musicTrackRowFields,
|
|
...jellyfinImageQueryParameters,
|
|
},
|
|
);
|
|
throwIfHttpError(response);
|
|
return _mapItems(_itemsArray(response.data));
|
|
}
|
|
|
|
/// Server-built radio seeded from a track/album/artist/playlist id.
|
|
@override
|
|
Future<List<MediaItem>> fetchInstantMix(String itemId, {int limit = 100}) async {
|
|
final response = await _http.get(
|
|
'/Items/${_segment(itemId)}/InstantMix',
|
|
queryParameters: {
|
|
'userId': connection.userId,
|
|
'Limit': limit.toString(),
|
|
'Fields': _browseFields,
|
|
...jellyfinImageQueryParameters,
|
|
},
|
|
);
|
|
throwIfHttpError(response);
|
|
return _mapItems(_itemsArray(response.data));
|
|
}
|
|
|
|
/// Lyrics for [track] from Jellyfin's `/Audio/{id}/Lyrics`. `LyricDto`
|
|
/// carries per-line `Start` offsets in ticks when the source is an LRC /
|
|
/// synced provider; `IsSynced` is absent on some server versions, so
|
|
/// synced-ness is inferred from any line carrying a `Start`. A Jellyfin 404
|
|
/// means the track has no lyrics → `null`; Emby is rejected before the request.
|
|
@override
|
|
Future<Lyrics?> fetchLyrics(MediaItem track) async {
|
|
if (!dialect.supportsLyrics) {
|
|
// Emby 4.9.5 binds `Lyrics` as an audio container and starts a failing ffmpeg transcode, so this call is harmful.
|
|
return null;
|
|
}
|
|
try {
|
|
final response = await _http.get('/Audio/${_segment(track.id)}/Lyrics');
|
|
throwIfHttpError(response);
|
|
final data = response.data;
|
|
if (data is! Map<String, dynamic>) return null;
|
|
final rawLines = data['Lyrics'];
|
|
if (rawLines is! List) return null;
|
|
final lines = <LyricLine>[];
|
|
var synced = false;
|
|
for (final raw in rawLines) {
|
|
if (raw is! Map<String, dynamic>) continue;
|
|
final startMs = jellyfinTicksToMs(raw['Start']);
|
|
if (startMs != null) synced = true;
|
|
lines.add(LyricLine(text: raw['Text'] as String? ?? '', startMs: startMs));
|
|
}
|
|
if (lines.isEmpty) return null;
|
|
return Lyrics(synced: synced, lines: lines);
|
|
} on MediaServerHttpException catch (e) {
|
|
if (e.statusCode == 404) return null;
|
|
rethrow;
|
|
}
|
|
}
|
|
}
|