Skip to main content

DecoderConfig

Struct DecoderConfig 

Source
#[non_exhaustive]
pub struct DecoderConfig { pub backend: DecoderBackend, pub byte_len_handle: Option<Arc<AtomicU64>>, pub byte_pool: Option<BytePool>, pub hint: Option<String>, pub hooks: Option<SharedHooks>, pub pcm_pool: Option<PcmPool>, pub segment_layout: Option<Arc<dyn SegmentLayout>>, pub gapless: bool, pub epoch: u64, }
Expand description

Configuration for DecoderFactory.

pcm_pool / byte_pool are intentionally Option<_> — the production discipline is to propagate one pool down the entire host chain (player → AudioConfigDecoderConfig). The None arm is a last-resort fallback for unit tests that don’t care about pool budgets and for legacy call sites that haven’t been threaded yet; it routes to the process-global PcmPool::default() / BytePool::default(). Don’t construct fresh PcmPool::new / BytePool::new inside library components — that fragments the heap into many small per-component pools and defeats recycling.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§backend: DecoderBackend

Which decoder backend to use. See DecoderBackend.

§byte_len_handle: Option<Arc<AtomicU64>>

Handle for dynamic byte length updates (HLS).

§byte_pool: Option<BytePool>

Raw byte buffer pool, propagated from the host. None falls back to BytePool::default().

§hint: Option<String>

File extension hint for Symphonia probe (e.g., “mp3”, “aac”).

§hooks: Option<SharedHooks>

Reader-side observer hooks. Forwarded into [ComposedDecoder] directly.

§pcm_pool: Option<PcmPool>

PCM buffer pool, propagated from the host. None falls back to PcmPool::default().

§segment_layout: Option<Arc<dyn SegmentLayout>>

Optional segment-layout handle over the underlying source.

§gapless: bool

Enable gapless trim wiring through the per-backend codec.

§epoch: u64

Epoch counter for decoder recreation tracking.

Implementations§

Source§

impl DecoderConfig

Source

pub fn builder() -> DecoderConfigBuilder

Create an instance of DecoderConfig using the builder syntax

Trait Implementations§

Source§

impl Clone for DecoderConfig

Source§

fn clone(&self) -> DecoderConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for DecoderConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,