pub struct FileStream {
    memory_mapping: AudioMemoryMapping,
    offset: Arc<AtomicUsize>,
    frame_size: usize,
    buffer_mem_length: usize,
    interval_ms: Duration,
    next_frame: Duration,
    start_time: Option<Instant>,
    buffer_drop: FileStreamBufferCommit,
}
Expand description

An Audio Stream that can be used to write playback buffer to a file. FileStream doesn’t directly open and write to file. It receives an mmap of a file instead.

Note that FileStream also needs the mmap-ed file has allocated some spaces to be written. If the playback buffer exceeds the allocated spaces, it will invoke panic!

Fields§

§memory_mapping: AudioMemoryMapping

A MemoryMapping that will hold the copy of the playback buffer.

§offset: Arc<AtomicUsize>

Number of bytes that has been written.

§frame_size: usize

Number of bytes in a single audio frame.

§buffer_mem_length: usize

Length of the current playback buffer in bytes.

§interval_ms: Duration

Duration of an audio in milliseconds for the current buffer_size.

§next_frame: Duration

Time marker of correct time to return next buffer.

§start_time: Option<Instant>

Timestamp that records when the stream starts.

§buffer_drop: FileStreamBufferCommit

Type that will be called before the buffer is dropped.

Implementations§

source§

impl FileStream

source

fn new( memory_mapping: AudioMemoryMapping, offset: Arc<AtomicUsize>, frame_size: usize, buffer_mem_length: usize, interval_ms: Duration ) -> Self

Trait Implementations§

source§

impl AsyncPlaybackBufferStream for FileStream

source§

fn next_playback_buffer<'a, 'life0, 'async_trait>( &'a mut self, ex: &'life0 dyn AudioStreamsExecutor ) -> Pin<Box<dyn Future<Output = Result<AsyncPlaybackBuffer<'a>, BoxError>> + 'async_trait>>
where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

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>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.