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

8 lines
10 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="TRACES: UR-002, UR-007 | DR-013 | IR-010"><title>jellytau_lib::repository::online - 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 online</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 online</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="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#statics" title="Statics">Statics</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>repository</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">repository</a></div><h1>Module <span>online</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/repository/online.rs.html#1-3890">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>TRACES: UR-002, UR-007 | DR-013 | IR-010</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.CreatePlaylistResponse.html" title="struct jellytau_lib::repository::online::CreatePlaylistResponse">Create<wbr>Playlist<wbr>Response</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Jellyfin playlist creation response</dd><dt><a class="struct" href="struct.ItemsResponse.html" title="struct jellytau_lib::repository::online::ItemsResponse">Items<wbr>Response</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.JRayActor.html" title="struct jellytau_lib::repository::online::JRayActor">JRay<wbr>Actor</a></dt><dd>A single actor returned by the JRay plugins “context at time t” endpoint.</dd><dt><a class="struct" href="struct.JRayContext.html" title="struct jellytau_lib::repository::online::JRayContext">JRay<wbr>Context</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Envelope returned by the JRay <code>jray?t=</code> endpoint. Extra keys (future
<code>locations</code>, <code>trivia</code>, …) are ignored so the client tolerates schema growth.</dd><dt><a class="struct" href="struct.JellyfinItem.html" title="struct jellytau_lib::repository::online::JellyfinItem">Jellyfin<wbr>Item</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.JellyfinMediaSource.html" title="struct jellytau_lib::repository::online::JellyfinMediaSource">Jellyfin<wbr>Media<wbr>Source</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.JellyfinMediaStream.html" title="struct jellytau_lib::repository::online::JellyfinMediaStream">Jellyfin<wbr>Media<wbr>Stream</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.JellyfinPlaylistItem.html" title="struct jellytau_lib::repository::online::JellyfinPlaylistItem">Jellyfin<wbr>Playlist<wbr>Item</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A playlist item from Jellyfin — wraps a regular item with an entry-scoped ID</dd><dt><a class="struct" href="struct.JellyfinUserData.html" title="struct jellytau_lib::repository::online::JellyfinUserData">Jellyfin<wbr>User<wbr>Data</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Per-user state Jellyfin attaches to an item (favourite, played, resume).</dd><dt><a class="struct" href="struct.OnlineRepository.html" title="struct jellytau_lib::repository::online::OnlineRepository">Online<wbr>Repository</a></dt><dd>Online repository - fetches data from Jellyfin server via HTTP</dd><dt><a class="struct" href="struct.PlaylistItemsResponse.html" title="struct jellytau_lib::repository::online::PlaylistItemsResponse">Playlist<wbr>Items<wbr>Response</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Jellyfin playlist items response — items include PlaylistItemId</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ImageTags.html" title="enum jellytau_lib::repository::online::ImageTags">Image<wbr>Tags</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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.DEVICE_ID.html" title="constant jellytau_lib::repository::online::DEVICE_ID">DEVICE_<wbr>ID</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Every request this app makes identifies the same device, so the device id
alone cannot tell two transcodes of the same item apart — see
<a href="fn.begin_video_play_session.html" title="fn jellytau_lib::repository::online::begin_video_play_session"><code>begin_video_play_session</code></a>.</dd></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.STREAMING_QUALITY.html" title="static jellytau_lib::repository::online::STREAMING_QUALITY">STREAMING_<wbr>QUALITY</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The bandwidth ceiling every video stream this process opens is built against.</dd><dt><a class="static" href="static.VIDEO_PLAY_SESSION.html" title="static jellytau_lib::repository::online::VIDEO_PLAY_SESSION">VIDEO_<wbr>PLAY_<wbr>SESSION</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The <code>PlaySessionId</code> of the video transcode most recently opened, so the next
open can stop it.</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.adopt_video_play_session.html" title="fn jellytau_lib::repository::online::adopt_video_play_session">adopt_<wbr>video_<wbr>play_<wbr>session</a></dt><dd>Take ownership of a transcode this process did not build a URL for, returning
the session it replaces.</dd><dt><a class="fn" href="fn.begin_video_play_session.html" title="fn jellytau_lib::repository::online::begin_video_play_session">begin_<wbr>video_<wbr>play_<wbr>session</a></dt><dd>Claim a transcode identity for a stream about to be opened, returning the new
<code>PlaySessionId</code> and the one it replaces (if any).</dd><dt><a class="fn" href="fn.build_favorites_endpoint.html" title="fn jellytau_lib::repository::online::build_favorites_endpoint">build_<wbr>favorites_<wbr>endpoint</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Build the Jellyfin endpoint for a favourites listing.</dd><dt><a class="fn" href="fn.build_get_items_endpoint.html" title="fn jellytau_lib::repository::online::build_get_items_endpoint">build_<wbr>get_<wbr>items_<wbr>endpoint</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Build the Jellyfin endpoint for a folder listing.</dd><dt><a class="fn" href="fn.build_latest_items_endpoint.html" title="fn jellytau_lib::repository::online::build_latest_items_endpoint">build_<wbr>latest_<wbr>items_<wbr>endpoint</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Build the Jellyfin endpoint for a “recently added” listing.</dd><dt><a class="fn" href="fn.build_next_up_endpoint.html" title="fn jellytau_lib::repository::online::build_next_up_endpoint">build_<wbr>next_<wbr>up_<wbr>endpoint</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Build the Jellyfin endpoint for a Next Up listing.</dd><dt><a class="fn" href="fn.set_streaming_quality.html" title="fn jellytau_lib::repository::online::set_streaming_quality">set_<wbr>streaming_<wbr>quality</a></dt><dd>Apply a bandwidth ceiling to every subsequently-opened video stream.</dd><dt><a class="fn" href="fn.streaming_quality.html" title="fn jellytau_lib::repository::online::streaming_quality">streaming_<wbr>quality</a></dt><dd>The ceiling currently applied to new video streams.</dd></dl></section></div></main></body></html>