AudioFile

Struct AudioFile 

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

Represents an audio file stream that can be either encrypted or unencrypted.

AudioFile provides a unified interface for handling audio streams, wrapping all downloads in a 32 KiB buffer. For encrypted content, additional 2 KiB block processing is applied through the Decrypt implementation.

Implementations§

Source§

impl AudioFile

Source

pub fn try_from_download<P>( track: &Track, download: StreamDownload<P>, ) -> Result<Self>
where P: StorageProvider + Sync + 'static, P::Reader: Sync,

Creates a new AudioFile from a track and its download stream.

This method wraps the download in a 32 KiB buffer and then:

  • For encrypted tracks: adds Decrypt handler for 2 KiB block processing
  • For unencrypted tracks: uses the buffered download directly
§Arguments
  • track - The track metadata containing encryption information
  • download - The underlying download stream
§Type Parameters
  • P - The storage provider type implementing StorageProvider
§Returns

A new AudioFile configured for the track

§Errors
  • Error::Unimplemented - Track uses unsupported encryption
  • Error::PermissionDenied - Decryption key not available
  • Error::InvalidData - Failed to create decryptor
  • Standard I/O errors from stream setup

Trait Implementations§

Source§

impl MediaSource for AudioFile

Implements the MediaSource trait required by Symphonia for media playback.

This implementation provides metadata about the stream’s capabilities and properties:

  • Seekability: determined by whether the track is a livestream
  • Byte length: provided if known from the track metadata
Source§

fn is_seekable(&self) -> bool

Returns whether seeking is supported in this audio stream.

§Returns
  • true for normal audio files
  • false for livestreams
Source§

fn byte_len(&self) -> Option<u64>

Returns the total size of the audio stream in bytes, if known.

§Returns
  • Some(u64) - The size in bytes if known
  • None - If the size is unknown (e.g., for livestreams)
Source§

impl Read for AudioFile

Implements reading from the audio stream.

This implementation delegates all read operations directly to the underlying stream, whether it’s a decrypted stream or raw download stream, providing transparent handling of encrypted and unencrypted content.

§Arguments

  • buf - Buffer to read data into

§Returns

Number of bytes read, or 0 at end of stream

§Errors

Propagates errors from the underlying stream:

  • InvalidInput - Buffer position invalid
  • InvalidData - Decryption failed
  • Standard I/O errors
Source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · Source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
Source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · Source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · Source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · Source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf. Read more
Source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
Source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Reads the exact number of bytes required to fill cursor. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Read. Read more
1.0.0 · Source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · Source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · Source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more
Source§

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>
where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)
Read and return a fixed array of bytes from this source. Read more
Source§

impl Seek for AudioFile

Implements seeking within the audio stream.

This implementation delegates all seek operations directly to the underlying stream. Note that seeking may not be available for livestreams, which can be checked via the is_seekable() method.

§Arguments

  • pos - Seek position (Start/Current/End)

§Returns

New position in the stream

§Errors

Propagates errors from the underlying stream:

  • InvalidInput - Invalid seek position
  • UnexpectedEof - Seek beyond end of file
  • Unsupported - Seeking from end with unknown size
Source§

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream. Read more
1.55.0 · Source§

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream. Read more
Source§

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)
Returns the length of this stream (in bytes). Read more
1.51.0 · Source§

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream. Read more
1.80.0 · Source§

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position. 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<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

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

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> ReadSeek for T
where T: Read + Seek + Send + Sync,

Source§

impl<T> StorageReader for T
where T: Read + Seek + Send,