14 lines
6.7 KiB
HTML
14 lines
6.7 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="Platform hook for attaching/detaching the OS remote-volume control."><title>RemoteVolumeControl in jellytau_lib::playback_mode - 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 trait"><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="#">RemoteVolumeControl</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"><section id="rustdoc-toc"><h2 class="location"><a href="#">Remote<wbr>Volume<wbr>Control</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.disable" title="disable">disable</a></li><li><a href="#tymethod.enable" title="enable">enable</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In jellytau_<wbr>lib::<wbr>playback_<wbr>mode</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">playback_mode</a></div><h1>Trait <span class="trait">Remote<wbr>Volume<wbr>Control</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/playback_mode/mod.rs.html#57-62">Source</a> </span></div><pre class="rust item-decl"><code>pub trait RemoteVolumeControl: <a class="trait" href="https://doc.rust-lang.org/1.97.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.97.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.enable" class="fn">enable</a>(&self, initial_volume: <a class="primitive" href="https://doc.rust-lang.org/1.97.1/std/primitive.i32.html">i32</a>);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.disable" class="fn">disable</a>(&self);
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Platform hook for attaching/detaching the OS remote-volume control.</p>
|
|
<p>On Android, entering remote mode hands the <code>MediaSession</code> a
|
|
<code>VolumeProviderCompat</code> so hardware volume buttons and the system slider drive
|
|
the <em>remote</em> session; leaving remote mode must hand it back to the local
|
|
media stream. Behind a trait so the routing rule (see
|
|
<a href="struct.PlaybackModeManager.html#method.set_mode" title="method jellytau_lib::playback_mode::PlaybackModeManager::set_mode"><code>PlaybackModeManager::set_mode</code></a>) is unit-testable off-device — the real
|
|
implementation is JNI and only exists on Android.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.enable" class="method"><a class="src rightside" href="../../src/jellytau_lib/playback_mode/mod.rs.html#59">Source</a><h4 class="code-header">fn <a href="#tymethod.enable" class="fn">enable</a>(&self, initial_volume: <a class="primitive" href="https://doc.rust-lang.org/1.97.1/std/primitive.i32.html">i32</a>)</h4></section></summary><div class="docblock"><p>Attach remote-volume control (and, on Android, start the playback service).</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.disable" class="method"><a class="src rightside" href="../../src/jellytau_lib/playback_mode/mod.rs.html#61">Source</a><h4 class="code-header">fn <a href="#tymethod.disable" class="fn">disable</a>(&self)</h4></section></summary><div class="docblock"><p>Return volume control to the local device speaker.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-RemoteVolumeControl-for-PlatformRemoteVolumeControl" class="impl"><a class="src rightside" href="../../src/jellytau_lib/playback_mode/mod.rs.html#67-91">Source</a><a href="#impl-RemoteVolumeControl-for-PlatformRemoteVolumeControl" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RemoteVolumeControl.html" title="trait jellytau_lib::playback_mode::RemoteVolumeControl">RemoteVolumeControl</a> for <a class="struct" href="struct.PlatformRemoteVolumeControl.html" title="struct jellytau_lib::playback_mode::PlatformRemoteVolumeControl">PlatformRemoteVolumeControl</a></h3></section></div><script src="../../trait.impl/jellytau_lib/playback_mode/trait.RemoteVolumeControl.js" async></script></section></div></main></body></html> |