Struct AnalyzerBuilder 

pub struct AnalyzerBuilder { /* private fields */ }

Builder for Analyzer.

Example

use ebur128_stream::{AnalyzerBuilder, Channel, Mode};
let analyzer = AnalyzerBuilder::new()
    .sample_rate(48_000)
    .channels(&[Channel::Left, Channel::Right])
    .modes(Mode::Integrated | Mode::Momentary)
    .build()
    .unwrap();

Implementations

impl AnalyzerBuilder

pub fn new() -> Self

Start a fresh builder with no configuration.

pub fn expected_duration(self, duration: Duration) -> Self

Hint at the expected programme length. The builder uses this to pre-reserve internal buffers so steady-state push_* calls trigger no allocations even with Mode::Integrated / Mode::Lra enabled.

Over-estimating wastes a few KB; under-estimating just causes the buffer to grow as normal. This is a hint, not a hard cap.

Example

let analyzer = AnalyzerBuilder::new()
    .sample_rate(48_000)
    .channels(&[Channel::Left, Channel::Right])
    .modes(Mode::Integrated | Mode::Lra)
    .expected_duration(Duration::from_secs(60 * 90))   // 90 minutes
    .build()?;

pub fn sample_rate(self, hz: u32) -> Self

Set the input sample rate, in hertz. Must be one of 22 050, 32 000, 44 100, 48 000, 88 200, 96 000, 192 000.

pub fn channels(self, layout: &[Channel]) -> Self

Set the channel layout. The order must match the order of channel slices passed to Analyzer::push_planar or the interleave order passed to Analyzer::push_interleaved.

pub fn modes(self, modes: Mode) -> Self

Set the analysis modes. At least one mode must be selected.

pub fn build(self) -> Result<Analyzer, Error>

Validate configuration and produce an Analyzer.

Trait Implementations

impl Clone for AnalyzerBuilder

fn clone(&self) -> AnalyzerBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnalyzerBuilder

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

Formats the value using the given formatter.

impl Default for AnalyzerBuilder

fn default() -> Self

Returns the “default value” for a type.