Files
jellytau/api/jellytau_lib/commands/repository/index.html
T

12 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Tauri commands for repository access Uses handle-based system: UUID -&#62; Arc"><title>jellytau_lib::commands::repository - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="jellytau_lib" data-themes="" data-resource-suffix="" data-rustdoc-version="1.97.1 (8bab26f4f 2026-07-14)" data-channel="1.97.1" data-search-js="search-fd9372ac.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-fcd733ba.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module repository</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../jellytau_lib/index.html">jellytau_<wbr>lib</a><span class="version">0.10.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module repository</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In jellytau_<wbr>lib::<wbr>commands</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">jellytau_lib</a>::<wbr><a href="../index.html">commands</a></div><h1>Module <span>repository</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/jellytau_lib/commands/repository.rs.html#1-1189">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Tauri commands for repository access
Uses handle-based system: UUID -&gt; Arc<HybridRepository></p>
<p>TRACES: UR-007, UR-008, UR-023, UR-034, UR-035, UR-036 | IR-022, IR-024, JA-004, JA-005, JA-006, JA-029, JA-030, JA-031</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.FavoritesChangedEvent.html" title="struct jellytau_lib::commands::repository::FavoritesChangedEvent">Favorites<wbr>Changed<wbr>Event</a></dt><dd>Payload for <a href="constant.FAVORITES_CHANGED_EVENT.html" title="constant jellytau_lib::commands::repository::FAVORITES_CHANGED_EVENT"><code>FAVORITES_CHANGED_EVENT</code></a> — the ids whose favourite state
actually flipped, so the frontend refreshes those rather than everything.</dd><dt><a class="struct" href="struct.RepositoryManager.html" title="struct jellytau_lib::commands::repository::RepositoryManager">Repository<wbr>Manager</a></dt><dd>Repository handle manager</dd><dt><a class="struct" href="struct.RepositoryManagerWrapper.html" title="struct jellytau_lib::commands::repository::RepositoryManagerWrapper">Repository<wbr>Manager<wbr>Wrapper</a></dt><dd>Wrapper for Tauri state</dd><dt><a class="struct" href="struct.SearchUpdateEvent.html" title="struct jellytau_lib::commands::repository::SearchUpdateEvent">Search<wbr>Update<wbr>Event</a></dt><dd>Payload for the deferred, merged search results pushed to the frontend.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.FAVORITES_CHANGED_EVENT.html" title="constant jellytau_lib::commands::repository::FAVORITES_CHANGED_EVENT">FAVORITES_<wbr>CHANGED_<wbr>EVENT</a></dt><dd>Tauri event announcing that favourite state changed behind the UIs back —
either because the server disagreed with the cache on a background refresh,
or because pending offline toggles were pushed on reconnect.</dd><dt><a class="constant" href="constant.SEARCH_EVENT_NAME.html" title="constant jellytau_lib::commands::repository::SEARCH_EVENT_NAME">SEARCH_<wbr>EVENT_<wbr>NAME</a></dt><dd>Tauri event name carrying the merged (cache + server) search results.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.changed_favorite_ids.html" title="fn jellytau_lib::commands::repository::changed_favorite_ids">changed_<wbr>favorite_<wbr>ids</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Ids whose favourite state differs between what we showed and what the server
has — favourited elsewhere since the cache was written, or un-favourited
elsewhere.</dd><dt><a class="fn" href="fn.repository_clear_watch_history.html" title="fn jellytau_lib::commands::repository::repository_clear_watch_history">repository_<wbr>clear_<wbr>watch_<wbr>history</a></dt><dd>Erase the viewers watch history for an item.</dd><dt><a class="fn" href="fn.repository_create.html" title="fn jellytau_lib::commands::repository::repository_create">repository_<wbr>create</a></dt><dd>Create a new repository instance
Returns a handle (UUID) for accessing the repository</dd><dt><a class="fn" href="fn.repository_destroy.html" title="fn jellytau_lib::commands::repository::repository_destroy">repository_<wbr>destroy</a></dt><dd>Destroy a repository instance</dd><dt><a class="fn" href="fn.repository_get_audio_only_stream_url_for_video.html" title="fn jellytau_lib::commands::repository::repository_get_audio_only_stream_url_for_video">repository_<wbr>get_<wbr>audio_<wbr>only_<wbr>stream_<wbr>url_<wbr>for_<wbr>video</a></dt><dd>Get an audio-only stream URL for a <em>video</em> item (background-audio handoff).</dd><dt><a class="fn" href="fn.repository_get_audio_stream_url.html" title="fn jellytau_lib::commands::repository::repository_get_audio_stream_url">repository_<wbr>get_<wbr>audio_<wbr>stream_<wbr>url</a></dt><dd>Get audio stream URL for a track</dd><dt><a class="fn" href="fn.repository_get_channels.html" title="fn jellytau_lib::commands::repository::repository_get_channels">repository_<wbr>get_<wbr>channels</a></dt><dd>Get the root list of plugin “Channels”</dd><dt><a class="fn" href="fn.repository_get_download_disk_usage.html" title="fn jellytau_lib::commands::repository::repository_get_download_disk_usage">repository_<wbr>get_<wbr>download_<wbr>disk_<wbr>usage</a></dt><dd>On-disk usage of downloaded content (device total, per-item/container bytes).</dd><dt><a class="fn" href="fn.repository_get_downloaded_items.html" title="fn jellytau_lib::commands::repository::repository_get_downloaded_items">repository_<wbr>get_<wbr>downloaded_<wbr>items</a></dt><dd>Downloaded-only browse: items under a container that are on the device.</dd><dt><a class="fn" href="fn.repository_get_downloaded_libraries.html" title="fn jellytau_lib::commands::repository::repository_get_downloaded_libraries">repository_<wbr>get_<wbr>downloaded_<wbr>libraries</a></dt><dd>Downloaded-only browse: libraries that contain downloaded content.</dd><dt><a class="fn" href="fn.repository_get_favorites.html" title="fn jellytau_lib::commands::repository::repository_get_favorites">repository_<wbr>get_<wbr>favorites</a></dt><dd>Everything the viewer has favourited, across libraries, narrowed by scope.</dd><dt><a class="fn" href="fn.repository_get_genres.html" title="fn jellytau_lib::commands::repository::repository_get_genres">repository_<wbr>get_<wbr>genres</a></dt><dd>Get genres for a library</dd><dt><a class="fn" href="fn.repository_get_image_url.html" title="fn jellytau_lib::commands::repository::repository_get_image_url">repository_<wbr>get_<wbr>image_<wbr>url</a></dt><dd>Get image URL for an item</dd><dt><a class="fn" href="fn.repository_get_item.html" title="fn jellytau_lib::commands::repository::repository_get_item">repository_<wbr>get_<wbr>item</a></dt><dd>Get a single item by ID</dd><dt><a class="fn" href="fn.repository_get_items.html" title="fn jellytau_lib::commands::repository::repository_get_items">repository_<wbr>get_<wbr>items</a></dt><dd>Get items in a container (library, folder, album, etc.)</dd><dt><a class="fn" href="fn.repository_get_items_by_person.html" title="fn jellytau_lib::commands::repository::repository_get_items_by_person">repository_<wbr>get_<wbr>items_<wbr>by_<wbr>person</a></dt><dd>Get items by person (actor, director, etc.)</dd><dt><a class="fn" href="fn.repository_get_latest_items.html" title="fn jellytau_lib::commands::repository::repository_get_latest_items">repository_<wbr>get_<wbr>latest_<wbr>items</a></dt><dd>Get latest items in a library</dd><dt><a class="fn" href="fn.repository_get_libraries.html" title="fn jellytau_lib::commands::repository::repository_get_libraries">repository_<wbr>get_<wbr>libraries</a></dt><dd>Get libraries</dd><dt><a class="fn" href="fn.repository_get_live_tv_channels.html" title="fn jellytau_lib::commands::repository::repository_get_live_tv_channels">repository_<wbr>get_<wbr>live_<wbr>tv_<wbr>channels</a></dt><dd>Get Live TV channels (broadcast / IPTV) for browsing</dd><dt><a class="fn" href="fn.repository_get_next_up_episodes.html" title="fn jellytau_lib::commands::repository::repository_get_next_up_episodes">repository_<wbr>get_<wbr>next_<wbr>up_<wbr>episodes</a></dt><dd>Get next up episodes.</dd><dt><a class="fn" href="fn.repository_get_person.html" title="fn jellytau_lib::commands::repository::repository_get_person">repository_<wbr>get_<wbr>person</a></dt><dd>Get person details</dd><dt><a class="fn" href="fn.repository_get_playback_info.html" title="fn jellytau_lib::commands::repository::repository_get_playback_info">repository_<wbr>get_<wbr>playback_<wbr>info</a></dt><dd>Get playback info for an item</dd><dt><a class="fn" href="fn.repository_get_recently_played_audio.html" title="fn jellytau_lib::commands::repository::repository_get_recently_played_audio">repository_<wbr>get_<wbr>recently_<wbr>played_<wbr>audio</a></dt><dd>Get recently played audio</dd><dt><a class="fn" href="fn.repository_get_rediscover_albums.html" title="fn jellytau_lib::commands::repository::repository_get_rediscover_albums">repository_<wbr>get_<wbr>rediscover_<wbr>albums</a></dt><dd>Get albums the user hasnt listened to recently (“rediscover”)</dd><dt><a class="fn" href="fn.repository_get_resume_items.html" title="fn jellytau_lib::commands::repository::repository_get_resume_items">repository_<wbr>get_<wbr>resume_<wbr>items</a></dt><dd>Get resume items (continue watching/listening).</dd><dt><a class="fn" href="fn.repository_get_resume_movies.html" title="fn jellytau_lib::commands::repository::repository_get_resume_movies">repository_<wbr>get_<wbr>resume_<wbr>movies</a></dt><dd>Get resume movies</dd><dt><a class="fn" href="fn.repository_get_series_current_episode.html" title="fn jellytau_lib::commands::repository::repository_get_series_current_episode">repository_<wbr>get_<wbr>series_<wbr>current_<wbr>episode</a></dt><dd>The episode a viewer should land on when they open a series.</dd><dt><a class="fn" href="fn.repository_get_series_episodes.html" title="fn jellytau_lib::commands::repository::repository_get_series_episodes">repository_<wbr>get_<wbr>series_<wbr>episodes</a></dt><dd>Every episode of a series, across all seasons, in series order.</dd><dt><a class="fn" href="fn.repository_get_similar_items.html" title="fn jellytau_lib::commands::repository::repository_get_similar_items">repository_<wbr>get_<wbr>similar_<wbr>items</a></dt><dd>Get similar/related items for a media item</dd><dt><a class="fn" href="fn.repository_get_subtitle_url.html" title="fn jellytau_lib::commands::repository::repository_get_subtitle_url">repository_<wbr>get_<wbr>subtitle_<wbr>url</a></dt><dd>Get subtitle URL for a media item</dd><dt><a class="fn" href="fn.repository_get_video_download_url.html" title="fn jellytau_lib::commands::repository::repository_get_video_download_url">repository_<wbr>get_<wbr>video_<wbr>download_<wbr>url</a></dt><dd>Get video download URL with quality preset</dd><dt><a class="fn" href="fn.repository_get_video_stream_url.html" title="fn jellytau_lib::commands::repository::repository_get_video_stream_url">repository_<wbr>get_<wbr>video_<wbr>stream_<wbr>url</a></dt><dd>Get a video stream URL.</dd><dt><a class="fn" href="fn.repository_jray_actors_at.html" title="fn jellytau_lib::commands::repository::repository_jray_actors_at">repository_<wbr>jray_<wbr>actors_<wbr>at</a></dt><dd>Query the optional JRay plugin for the actors on screen at time <code>t</code>
(seconds) in an item. Returns an empty list when JRay isnt installed or
has no data for the item, so the caller can render nothing without error.</dd><dt><a class="fn" href="fn.repository_mark_favorite.html" title="fn jellytau_lib::commands::repository::repository_mark_favorite">repository_<wbr>mark_<wbr>favorite</a></dt><dd>Mark an item as favorite</dd><dt><a class="fn" href="fn.repository_open_live_stream.html" title="fn jellytau_lib::commands::repository::repository_open_live_stream">repository_<wbr>open_<wbr>live_<wbr>stream</a></dt><dd>Open a live stream for a Live TV channel / live item</dd><dt><a class="fn" href="fn.repository_report_playback_progress.html" title="fn jellytau_lib::commands::repository::repository_report_playback_progress">repository_<wbr>report_<wbr>playback_<wbr>progress</a></dt><dd>Report playback progress</dd><dt><a class="fn" href="fn.repository_report_playback_start.html" title="fn jellytau_lib::commands::repository::repository_report_playback_start">repository_<wbr>report_<wbr>playback_<wbr>start</a></dt><dd>Report playback start</dd><dt><a class="fn" href="fn.repository_report_playback_stopped.html" title="fn jellytau_lib::commands::repository::repository_report_playback_stopped">repository_<wbr>report_<wbr>playback_<wbr>stopped</a></dt><dd>Report playback stopped</dd><dt><a class="fn" href="fn.repository_search.html" title="fn jellytau_lib::commands::repository::repository_search">repository_<wbr>search</a></dt><dd>Search for items.</dd><dt><a class="fn" href="fn.repository_unmark_favorite.html" title="fn jellytau_lib::commands::repository::repository_unmark_favorite">repository_<wbr>unmark_<wbr>favorite</a></dt><dd>Unmark an item as favorite</dd></dl></section></div></main></body></html>