Struct audio_engine::AudioEngine
source · [−]pub struct AudioEngine { /* private fields */ }Expand description
The main struct of the crate.
This hold all existing SoundSources and cpal::platform::Stream.
Implementations
sourceimpl AudioEngine
impl AudioEngine
sourcepub fn new() -> Result<Self, &'static str>
pub fn new() -> Result<Self, &'static str>
Tries to create a new AudioEngine.
cpal will spawn a new thread where the sound samples will be sampled, mixed, and outputed
to the output stream.
sourcepub fn sample_rate(&self) -> u32
pub fn sample_rate(&self) -> u32
The sample rate that is currently being outputed to the device.
sourcepub fn channels(&self) -> u16
pub fn channels(&self) -> u16
The number of channels that is currently being outputed to the device.
sourcepub fn new_sound<T: SoundSource + Send + 'static>(
&self,
source: T
) -> Result<Sound, &'static str>
pub fn new_sound<T: SoundSource + Send + 'static>(
&self,
source: T
) -> Result<Sound, &'static str>
Create a new Sound.
Return a Err if the number of channels doesn’t match the output number of channels. If
the ouput number of channels is 1, or the number of channels of source is 1, source
will be automatic wrapped in a ChannelConverter.
If the sample_rate of source mismatch the output sample_rate, source will be
wrapped in a SampleRateConverter.
Auto Trait Implementations
impl !RefUnwindSafe for AudioEngine
impl !Send for AudioEngine
impl !Sync for AudioEngine
impl Unpin for AudioEngine
impl !UnwindSafe for AudioEngine
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more