Skip to content

Commit e5b57be

Browse files
committed
better document play/pause on MixerDeviceSink
1 parent 6cef5a9 commit e5b57be

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

src/stream.rs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,19 @@ impl MixerDeviceSink {
5454
pub fn mixer(&self) -> &Mixer {
5555
&self.mixer
5656
}
57-
/// pause underlaying audio stream
57+
/// pause underlaying audio stream reducing cpu usage
5858
///
59-
/// this will prevent audio from playing until play() is called
59+
/// will silenty fail to play audio until play() is called
60+
///
61+
/// This is an experimental API it is likely to removed once a better solution is found without notice or a change log entry
62+
#[cfg(feature = "experimental")]
6063
pub fn pause(&self) {
6164
let _ = self._stream.pause();
6265
}
63-
/// resumes underlaying audio stream
66+
/// resume underlaying audio stream
67+
///
68+
/// This is an experimental API it is likely to removed once a better solution is found without notice or a change log entry
69+
#[cfg(feature = "experimental")]
6470
pub fn play(&self) {
6571
let _ = self._stream.play();
6672
}

0 commit comments

Comments
 (0)