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

Add some documentation

This commit is contained in:
Pierre Krieger 2014-12-17 09:13:58 +01:00
parent f096a3b3a9
commit 094dbef0e4
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/lib.rs
View File

@ -1,5 +1,6 @@
#![feature(macro_rules)] #![feature(macro_rules)]
#![feature(unsafe_destructor)] #![feature(unsafe_destructor)]
#![unstable]
#[cfg(all(not(windows), not(unix)))] #[cfg(all(not(windows), not(unix)))]
use this_platform_is_not_supported; use this_platform_is_not_supported;
@ -11,15 +12,17 @@ mod samples_formats;
#[cfg(unix)] #[cfg(unix)]
#[path="alsa/mod.rs"] #[path="alsa/mod.rs"]
pub mod cpal_impl; mod cpal_impl;
#[cfg(windows)] #[cfg(windows)]
#[path="wasapi/mod.rs"] #[path="wasapi/mod.rs"]
pub mod cpal_impl; mod cpal_impl;
/// A `Channel` represents a sound output. /// Controls a sound output.
/// ///
/// A channel must be periodically filled with new data, or the sound will /// Create one `Channel` for each sound that you want to play.
/// stop playing. ///
/// A channel must be periodically filled with new data by calling `append_data`, or the sound
/// will stop playing.
pub struct Channel(cpal_impl::Channel); pub struct Channel(cpal_impl::Channel);
/// Number of channels. /// Number of channels.
@ -50,6 +53,7 @@ struct RequiredConversion<T> {
} }
impl Channel { impl Channel {
/// Builds a new channel.
pub fn new() -> Channel { pub fn new() -> Channel {
let channel = cpal_impl::Channel::new(); let channel = cpal_impl::Channel::new();
Channel(channel) Channel(channel)

8
src/samples_formats.rs
View File

@ -8,10 +8,12 @@ pub enum SampleFormat {
I16, I16,
/// The value 0 corresponds to 32768. /// The value 0 corresponds to 32768.
U16, U16,
/// The boundaries are (-1.0, 1.0).
F32, F32,
} }
impl SampleFormat { impl SampleFormat {
/// Returns the size in bytes of a sample of this format.
pub fn get_sample_size(&self) -> uint { pub fn get_sample_size(&self) -> uint {
match self { match self {
&SampleFormat::I16 => mem::size_of::<i16>(), &SampleFormat::I16 => mem::size_of::<i16>(),
@ -26,11 +28,11 @@ impl SampleFormat {
pub trait Sample: Copy { pub trait Sample: Copy {
fn get_format(Option<Self>) -> SampleFormat; fn get_format(Option<Self>) -> SampleFormat;
/// Turns the data into a `Vec<i16>` where each element is a sample. /// Turns the data into samples of type `I16`.
fn to_vec_i16(&[Self]) -> Cow<Vec<i16>, [i16]>; fn to_vec_i16(&[Self]) -> Cow<Vec<i16>, [i16]>;
/// Turns the data into a `Vec<u16>` where each element is a sample. /// Turns the data into samples of type `U16`.
fn to_vec_u16(&[Self]) -> Cow<Vec<u16>, [u16]>; fn to_vec_u16(&[Self]) -> Cow<Vec<u16>, [u16]>;
/// Turns the data into a `Vec<f32>` where each element is a sample. /// Turns the data into samples of type `F32`.
fn to_vec_f32(&[Self]) -> Cow<Vec<f32>, [f32]>; fn to_vec_f32(&[Self]) -> Cow<Vec<f32>, [f32]>;
} }