18 lines
8.8 KiB
HTML
18 lines
8.8 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="A trait that allows adding a custom audio source to the object. This is implemented for `App` to allow registering custom `Decodable` types."><title>AddAudioSource in bevy_audio - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bevy_audio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://bevyengine.org/assets/icon.png"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../bevy_audio/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../bevy_audio/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../bevy_audio/index.html">bevy_<wbr>audio</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">AddAudio<wbr>Source</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.add_audio_source" title="add_audio_source">add_audio_source</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-AddAudioSource-for-App" title="App">App</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bevy_<wbr>audio</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bevy_audio</a></span><h1>Trait <span class="trait">AddAudioSource</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/bevy_audio/audio_source.rs.html#108-119">Source</a> </span></div><pre class="rust item-decl"><code>pub trait AddAudioSource {
|
|
// Required method
|
|
fn <a href="#tymethod.add_audio_source" class="fn">add_audio_source</a><T>(&mut self) -> &mut Self
|
|
<span class="where">where T: <a class="trait" href="trait.Decodable.html" title="trait bevy_audio::Decodable">Decodable</a> + <a class="trait" href="../bevy_asset/trait.Asset.html" title="trait bevy_asset::Asset">Asset</a>,
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>: <a class="trait" href="../dasp_sample/conv/trait.FromSample.html" title="trait dasp_sample::conv::FromSample">FromSample</a><T::<a class="associatedtype" href="trait.Decodable.html#associatedtype.DecoderItem" title="type bevy_audio::Decodable::DecoderItem">DecoderItem</a>></span>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait that allows adding a custom audio source to the object.
|
|
This is implemented for <a href="../bevy_app/app/struct.App.html" title="struct bevy_app::app::App"><code>App</code></a> to allow registering custom <a href="trait.Decodable.html" title="trait bevy_audio::Decodable"><code>Decodable</code></a> types.</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.add_audio_source" class="method"><a class="src rightside" href="../src/bevy_audio/audio_source.rs.html#115-118">Source</a><h4 class="code-header">fn <a href="#tymethod.add_audio_source" class="fn">add_audio_source</a><T>(&mut self) -> &mut Self<div class="where">where
|
|
T: <a class="trait" href="trait.Decodable.html" title="trait bevy_audio::Decodable">Decodable</a> + <a class="trait" href="../bevy_asset/trait.Asset.html" title="trait bevy_asset::Asset">Asset</a>,
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>: <a class="trait" href="../dasp_sample/conv/trait.FromSample.html" title="trait dasp_sample::conv::FromSample">FromSample</a><T::<a class="associatedtype" href="trait.Decodable.html#associatedtype.DecoderItem" title="type bevy_audio::Decodable::DecoderItem">DecoderItem</a>>,</div></h4></section></summary><div class="docblock"><p>Registers an audio source.
|
|
The type must implement <a href="trait.Decodable.html" title="trait bevy_audio::Decodable"><code>Decodable</code></a>,
|
|
so that it can be converted to a <a href="trait.Source.html" title="trait bevy_audio::Source"><code>rodio::Source</code></a> type,
|
|
and <a href="../bevy_asset/trait.Asset.html" title="trait bevy_asset::Asset"><code>Asset</code></a>, so that it can be registered as an asset.
|
|
To use this method on <a href="../bevy_app/app/struct.App.html" title="struct bevy_app::app::App"><code>App</code></a>,
|
|
the <a href="struct.AudioPlugin.html" title="struct bevy_audio::AudioPlugin">audio</a> and <a href="../bevy_asset/struct.AssetPlugin.html" title="struct bevy_asset::AssetPlugin">asset</a> plugins must be added first.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-AddAudioSource-for-App" class="impl"><a class="src rightside" href="../src/bevy_audio/lib.rs.html#113-125">Source</a><a href="#impl-AddAudioSource-for-App" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AddAudioSource.html" title="trait bevy_audio::AddAudioSource">AddAudioSource</a> for <a class="struct" href="../bevy_app/app/struct.App.html" title="struct bevy_app::app::App">App</a></h3></section></summary><div class="impl-items"><section id="method.add_audio_source" class="method trait-impl"><a class="src rightside" href="../src/bevy_audio/lib.rs.html#114-124">Source</a><a href="#method.add_audio_source" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add_audio_source" class="fn">add_audio_source</a><T>(&mut self) -> &mut Self<div class="where">where
|
|
T: <a class="trait" href="trait.Decodable.html" title="trait bevy_audio::Decodable">Decodable</a> + <a class="trait" href="../bevy_asset/trait.Asset.html" title="trait bevy_asset::Asset">Asset</a>,
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>: <a class="trait" href="../dasp_sample/conv/trait.FromSample.html" title="trait dasp_sample::conv::FromSample">FromSample</a><T::<a class="associatedtype" href="trait.Decodable.html#associatedtype.DecoderItem" title="type bevy_audio::Decodable::DecoderItem">DecoderItem</a>>,</div></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/bevy_audio/audio_source/trait.AddAudioSource.js" data-ignore-extern-crates="bevy_app" async></script></section></div></main></body></html> |