Skip to main content

Module online

Module online 

Source
Expand description

TRACES: UR-002, UR-007 | DR-013 | IR-010

StructsΒ§

CreatePlaylistResponse πŸ”’
Jellyfin playlist creation response
DeviceProfile πŸ”’
DirectPlayProfile πŸ”’
ItemsResponse πŸ”’
JRayActor
A single actor returned by the JRay plugin’s β€œcontext at time t” endpoint.
JRayContext πŸ”’
Envelope returned by the JRay jray?t= endpoint. Extra keys (future locations, trivia, …) are ignored so the client tolerates schema growth.
JellyfinItem πŸ”’
JellyfinMediaSource πŸ”’
JellyfinMediaStream πŸ”’
JellyfinPlaylistItem πŸ”’
A playlist item from Jellyfin β€” wraps a regular item with an entry-scoped ID
JellyfinUserData πŸ”’
Per-user state Jellyfin attaches to an item (favourite, played, resume).
NegotiatedSource
NegotiatedStream
OnlineRepository
Online repository - fetches data from Jellyfin server via HTTP
PlaybackInfoRequest πŸ”’
PlaybackInfoResponse πŸ”’
PlaylistItemsResponse πŸ”’
Jellyfin playlist items response β€” items include PlaylistItemId
SubtitleProfile πŸ”’
TranscodingProfile πŸ”’

EnumsΒ§

ImageTags πŸ”’

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 PlaySessionId of 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 PlaySessionId and 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.