Merge branch 'master' of github.com:RustAudio/rodio

Cargo.toml

@@ -10,7 +10,7 @@ exclude = ["assets/**", "tests/**"]
 edition = "2021"
 
 [dependencies]
-cpal = "0.15"
+cpal = "0.15.3"
 claxon = { version = "0.4.2", optional = true }
 hound = { version = "3.3.1", optional = true }
 lewton = { version = "0.10", optional = true }

src/lib.rs

@@ -51,6 +51,7 @@
 //! use rodio::{Decoder, OutputStream, Sink};
 //! use rodio::source::{SineWave, Source};
 //!
+//! // _stream must live as long as the sink
 //! let (_stream, stream_handle) = OutputStream::try_default().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.
 //!
+//! **Please note that the [`Sink`] requires the [`OutputStream`], make sure that the outputstream is not dropped before the sink.**
+//!
 //! ## Filters
 //!
 //! The [`Source`] trait provides various filters, similar to the standard [`Iterator`] trait.