20 lines
5.3 KiB
HTML
20 lines
5.3 KiB
HTML
<!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="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)."><title>player_background_action in jellytau_lib::commands::player - 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 fn"><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="#">player_background_action</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.11.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In jellytau_<wbr>lib::<wbr>commands::<wbr>player</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>::<wbr><a href="index.html">player</a></div><h1>Function <span class="fn">player_<wbr>background_<wbr>action</span> <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/player/mod.rs.html#916-939">Source</a> </span></div><pre class="rust item-decl"><code>pub async fn player_background_action(
|
||
player: State<'_, <a class="struct" href="struct.PlayerStateWrapper.html" title="struct jellytau_lib::commands::player::PlayerStateWrapper">PlayerStateWrapper</a>>,
|
||
background_audio_armed: <a class="primitive" href="https://doc.rust-lang.org/1.97.1/std/primitive.bool.html">bool</a>,
|
||
in_picture_in_picture: <a class="primitive" href="https://doc.rust-lang.org/1.97.1/std/primitive.bool.html">bool</a>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.97.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../player/background_policy/enum.BackgroundAction.html" title="enum jellytau_lib::player::background_policy::BackgroundAction">BackgroundAction</a>, <a class="struct" href="https://doc.rust-lang.org/1.97.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Exit background-audio mode: stop the native audio player and return its final
|
||
position so the frontend can reload the WebView <code><video></code> there (UR-040).</p>
|
||
<p>Returns the position in seconds. The sleep timer is intentionally left
|
||
untouched — if it fired while backgrounded, playback is already stopped and
|
||
this simply reports the last position.</p>
|
||
<p>What playback should do now that the app is no longer visible.</p>
|
||
<p>The caller supplies only what it alone knows – whether the per-player
|
||
toggle is armed, and whether Android put the window into picture-in-picture.
|
||
Everything else (what is playing, and therefore whether there is a picture to
|
||
lose) is read here, because it is domain state.</p>
|
||
<p>The rule itself is in <code>player::background_policy</code>; this command is the wire.
|
||
Returning <code>KeepPlaying</code> for an empty queue is deliberate: with nothing
|
||
playing there is nothing to pause, and an error would make the frontend
|
||
handle a case that is not a failure.</p>
|
||
<p>TRACES: UR-040, UR-041 | DR-225 | UT-212</p>
|
||
</div></details></section></div></main></body></html> |