Expand description
TRACES: UR-003, UR-004, UR-005, UR-010, UR-020, UR-021 | JA-022, JA-023, JA-024, JA-025, JA-026 | DR-001
Re-exportsΒ§
ModulesΒ§
- queue π
- Queue manipulation commands (add / remove / move / skip).
- remote π
- Remote Jellyfin session control commands (casting to another device).
- session π
- Media session state commands.
- settings π
- Audio and video playback settings commands.
- timers π
- Sleep-timer and autoplay commands.
StructsΒ§
- Background
Audio πPlan - How a background-audio handoff must start playback, given where its audio actually begins.
- Media
Session Manager Wrapper - Media session manager wrapper for Tauri state management
- Merged
Media Item - Lightweight media item for merged playback state Converts from both local MediaItem and remote NowPlayingItem
- Play
Album Track Request - Request to play a track from an album (backend fetches all tracks)
- Play
Item Request - Request to play a single video item
- Play
Queue Request - Request to play a queue of items
- Play
Tracks Request - Request to play tracks by ID (backend fetches metadata)
- Playback
Capabilities - What playback facilities this platformβs backend actually provides.
- Player
State Wrapper - Player state wrapper for Tauri.
- Player
Status - Response for player state queries
- Preload
Result - Response for preload operation
- Queue
Status - Response for queue queries
- Smart
Cache Wrapper - SmartCache wrapper for Tauri state management
- Video
Settings Wrapper - Video settings state wrapper for Tauri
EnumsΒ§
- Audio
Track Switch Response - Response for audio track switching operations
- Play
Queue Context - Queue context for remote transfer - what type of queue is this?
- Play
Tracks Context - Context information for track playback
- Stream
Quality Response - Response for a mid-playback streaming-quality change.
- Video
Backend - Backend type for video playback
- Video
Seek Response - Response for video seek operations
FunctionsΒ§
- background_
audio_ πplan - Decide the base and the seek for a handoff at
position_seconds. - background_
audio_ πsource - Pick the source for an audio-only handoff.
- check_
for_ πlocal_ download - Check if an item has a completed download
- create_
media_ πitem - Helper function to create MediaItem from video request
- get_
player_ πstatus - get_
queue_ πstatus - normalize_
volume π - Normalise a volume arriving over IPC to the 0.0..=1.0 range every backend works in.
- play_
selection_ πon_ remote - Start a freshly-built queue on the active remote session.
- player_
background_ action - Exit background-audio mode: stop the native audio player and return its final
position so the frontend can reload the WebView
<video>there (UR-040). - player_
configure_ jellyfin - Configure Jellyfin API client for automatic playback reporting
- player_
cycle_ repeat - player_
disable_ jellyfin - Disable Jellyfin automatic playback reporting
- player_
enter_ background_ audio - Enter background-audio mode: hand playback of the currently-watched video off to the native ExoPlayer audio path so the audio keeps playing while the app is backgrounded/locked, with no client-side video decode (UR-040).
- player_
exit_ background_ audio - TRACES: UR-040 | DR-052 | UT-061, IT-013
- player_
get_ cache_ config - Get current SmartCache configuration
- player_
get_ capabilities - Report this platformβs playback capabilities to the frontend.
- player_
get_ queue - player_
get_ status - player_
local_ media_ path - The on-disk path for a downloaded item, for playback surfaces that resolve their own source rather than going through the queue.
- player_
next - player_
pause - player_
play - player_
play_ album_ track - Play a track from an album - backend fetches all album tracks and builds queue
- player_
play_ item - Play a single media item (audio or video)
- player_
play_ queue - Play a queue of media items
- player_
play_ tracks - Play tracks by ID - backend fetches all metadata
- player_
preload_ upcoming - Preload upcoming tracks from the queue This queues background downloads for the next N tracks that arenβt already downloaded
- player_
previous - player_
seek - player_
seek_ video - Smart video seeking that decides between native and server-side seeking
- player_
set_ audio_ track - Set the active audio track on a native backend directly.
- player_
set_ cache_ config - Update SmartCache configuration
- player_
set_ stream_ quality - Change the bandwidth ceiling of the video that is playing right now.
- player_
set_ subtitle_ track - Set (or clear, with
None) the active subtitle track on a native backend. - player_
set_ volume - player_
stop - player_
switch_ audio_ track - Switch audio track. Note: Frontend should handle saving series preferences after this command succeeds
- player_
toggle - player_
toggle_ mute - player_
toggle_ shuffle - refresh_
queue_ πlocal_ sources - Re-point queued streaming items at completed local downloads.
- resolve_
local_ πmedia_ path - Resolve the on-disk file backing a completed download, if there is one.
- sanitize_
filename π - Sanitize filename by removing invalid characters