Expand description
TRACES: UR-002, UR-007 | DR-013 | IR-010
StructsΒ§
- Create
Playlist πResponse - Jellyfin playlist creation response
- Device
Profile π - Direct
Play πProfile - Items
Response π - JRay
Actor - A single actor returned by the JRay pluginβs βcontext at time tβ endpoint.
- JRay
Context π - Envelope returned by the JRay
jray?t=endpoint. Extra keys (futurelocations,trivia, β¦) are ignored so the client tolerates schema growth. - Jellyfin
Item π - Jellyfin
Media πSource - Jellyfin
Media πStream - Jellyfin
Playlist πItem - A playlist item from Jellyfin β wraps a regular item with an entry-scoped ID
- Jellyfin
User πData - Per-user state Jellyfin attaches to an item (favourite, played, resume).
- Negotiated
Source - Negotiated
Stream - Online
Repository - Online repository - fetches data from Jellyfin server via HTTP
- Playback
Info πRequest - Playback
Info πResponse - Playlist
Items πResponse - Jellyfin playlist items response β items include PlaylistItemId
- Subtitle
Profile π - Transcoding
Profile π
EnumsΒ§
- Image
Tags π
ConstantsΒ§
- DEVICE_
ID π - Every request this app makes identifies the same device, so the device id
alone cannot tell two transcodes of the same item apart β see
begin_video_play_session.
StaticsΒ§
- PLAYBACK_
QUALITY_ πOVERRIDE - The ceiling in force for the playback happening right now, when the viewer has moved this one item off the device default.
- STREAMING_
QUALITY π - The viewerβs durable bandwidth ceiling β the device default.
- VIDEO_
PLAY_ πSESSION - The
PlaySessionIdof the video transcode most recently opened, so the next open can stop it.
FunctionsΒ§
- adopt_
video_ play_ session - Take ownership of a transcode this process did not build a URL for, returning the session it replaces.
- begin_
video_ play_ session - Claim a transcode identity for a stream about to be opened, returning the new
PlaySessionIdand the one it replaces (if any). - build_
favorites_ πendpoint - Build the Jellyfin endpoint for a favourites listing.
- build_
get_ πitems_ endpoint - Build the Jellyfin endpoint for a folder listing.
- build_
latest_ πitems_ endpoint - Build the Jellyfin endpoint for a βrecently addedβ listing.
- build_
next_ πup_ endpoint - Build the Jellyfin endpoint for a Next Up listing.
- clear_
playback_ quality_ override - Drop any per-playback override, returning to the device default.
- decide_
playback_ kind - The direct-play / direct-stream / transcode decision.
- effective_
streaming_ quality - The ceiling that actually applies to a stream opened now: the per-playback override if the viewer set one, otherwise the device default.
- playback_
quality_ override - The per-playback override, if one is in force.
- set_
playback_ quality_ override - Move this playback to a different ceiling without disturbing the default.
- set_
streaming_ quality - Set the durable device default. Applies to every stream opened afterwards that has no per-playback override.
- streaming_
quality - The durable device default, ignoring any per-playback override.