Mirrors/rodio
2
0
Fork 0
mirror of https://github.com/RustAudio/rodio synced 2024-12-13 05:32:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add comment about Sink and OutputStream

Browse source
This commit is contained in:
weixubin 2024-04-22 16:20:14 +08:00
parent a618afccf9
commit 934b1c0525
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/lib.rs
View file

@ -51,6 +51,7 @@
//! use rodio::{Decoder, OutputStream, Sink}; //! use rodio::{Decoder, OutputStream, Sink};
//! use rodio::source::{SineWave, Source}; //! use rodio::source::{SineWave, Source};
//! //!
//! // _stream must live as long as the sink
//! let (_stream, stream_handle) = OutputStream::try_default().unwrap(); //! let (_stream, stream_handle) = OutputStream::try_default().unwrap();
//! let sink = Sink::try_new(&stream_handle).unwrap(); //! let sink = Sink::try_new(&stream_handle).unwrap();
//! //!
@ -69,6 +70,8 @@
//! //!
//! The [`Sink`] type also provides utilities such as playing/pausing or controlling the volume. //! The [`Sink`] type also provides utilities such as playing/pausing or controlling the volume.
//! //!
//! **Please note that the [`Sink`] requires the [`OutputStream`], thus ensuring that it has to live as long as the sink.**
//!
//! ## Filters //! ## Filters
//! //!
//! The [`Source`] trait provides various filters, similar to the standard [`Iterator`] trait. //! The [`Source`] trait provides various filters, similar to the standard [`Iterator`] trait.