rob
/
cpal
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify the current state of stream behaviour in docs and comments

This commit is contained in:
mitchmindtree 2019-12-31 16:02:08 +01:00
parent 39ade49347
commit 2afebb2806
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/host/wasapi/stream.rs
View File

@ -27,6 +27,8 @@ use UnknownTypeOutputBuffer;
pub struct Stream { pub struct Stream {
/// The high-priority audio processing thread calling callbacks. /// The high-priority audio processing thread calling callbacks.
/// Option used for moving out in destructor. /// Option used for moving out in destructor.
///
/// TODO: Actually set the thread priority.
thread: Option<JoinHandle<()>>, thread: Option<JoinHandle<()>>,
// Commands processed by the `run()` method that is currently running. // Commands processed by the `run()` method that is currently running.

5
src/lib.rs
View File

@ -80,8 +80,9 @@
//! > given callback is called by a dedicated, high-priority thread responsible for delivering //! > given callback is called by a dedicated, high-priority thread responsible for delivering
//! > audio data to the system's audio device in a timely manner. On older platforms that only //! > audio data to the system's audio device in a timely manner. On older platforms that only
//! > provide a blocking API (e.g. ALSA), CPAL will create a thread in order to consistently //! > provide a blocking API (e.g. ALSA), CPAL will create a thread in order to consistently
//! > provide non-blocking behaviour. *If this is an issue for your platform or design, please //! > provide non-blocking behaviour (currently this is a thread per stream, but this may change to
//! > share your issue and use-case with the CPAL team on the github issue tracker for //! > use a single thread for all streams). *If this is an issue for your platform or design,
//! > please share your issue and use-case with the CPAL team on the github issue tracker for
//! > consideration.* //! > consideration.*
//! //!
//! In this example, we simply fill the given output buffer with zeroes. //! In this example, we simply fill the given output buffer with zeroes.