Skip to main content

AudioInput

Struct AudioInput 

Source
pub struct AudioInput { /* private fields */ }
Expand description

Feeds audio already owned by the embedding application into a Session.

Implementations§

Source§

impl AudioInput

Source

pub const fn source(&self) -> &SourceInstanceHandle

Source

pub const fn output(&self) -> &SourceOutputHandle

Source

pub fn try_acquire( &self, ) -> Result<AudioInputBuffer, AudioInputBufferAcquireError>

Acquires one preallocated buffer owned by this input.

Source

pub fn try_write(&mut self, samples: &[f32]) -> Result<(), AudioInputWriteError>

Writes one complete interleaved frame without blocking.

Source

pub fn begin_output_generation( &self, ) -> Result<OutputGeneration, OutputGenerationError>

Source

pub fn try_write_for_output( &mut self, generation: &OutputGeneration, samples: &[f32], ) -> Result<(), AudioOutputWriteError>

Source

pub fn try_send_for_output( &mut self, generation: &OutputGeneration, buffer: AudioInputBuffer, ) -> Result<(), AudioOutputWriteError>

Submits one previously acquired buffer as replaceable output.

Source

pub fn try_send( &mut self, buffer: AudioInputBuffer, ) -> Result<(), AudioInputWriteError>

Submits one previously acquired buffer without blocking.

Source

pub fn close(&mut self)

Closes this application-owned input after its accepted frames drain.

Source

pub fn observations(&self) -> AudioInputObservations

Source

pub fn discarded_output_frames_total(&self) -> u64

Source

pub fn cancelled_output_writes_total(&self) -> u64

Source

pub fn into_pcm_source(self) -> PcmSource

Converts the convenience façade into explicit source, output, and producer ownership.

Trait Implementations§

Source§

impl Debug for AudioInput

Source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.