Struct BarProcessor 

pub struct BarProcessor { /* private fields */ }

The struct which computates the bar values of the samples of the fetcher.

Implementations

impl BarProcessor

pub fn new(processor: &SampleProcessor, config: BarProcessorConfig) -> Self

Creates a new instance.

See the examples of this crate to see it’s usage.

Examples found in repository

examples/simple.rs (line 7)

fn main() {
    let mut sample_processor = SampleProcessor::new(DummyFetcher::new(2));
    sample_processor.process_next_samples();

    let mut bar_processor = BarProcessor::new(&sample_processor, BarProcessorConfig::default());
    bar_processor.process_bars(&sample_processor);
}

examples/default_system_fetcher.rs (line 11)

fn main() {
    // Choose default settings
    let descriptor = SystemAudioFetcherDescriptor::default();

    let mut processor = SampleProcessor::new(SystemAudioFetcher::new(&descriptor).unwrap());
    let mut bar_processor = BarProcessor::new(&processor, BarProcessorConfig::default());

    // simply fetch
    processor.process_next_samples();
    bar_processor.process_bars(&processor);
}

examples/custom_system_fetcher.rs (line 28)

fn main() {
    // get a list of all available devices
    let available_output_devices = shady_audio::util::get_device_names(DeviceType::Output)
        .expect("Output devices exists for the given host");

    println!("{:#?}", available_output_devices);

    // choose one
    let device = shady_audio::util::get_device(
        available_output_devices.first().unwrap(),
        DeviceType::Output,
    )
    .unwrap()
    .unwrap();

    let descriptor = SystemAudioFetcherDescriptor {
        device,
        ..Default::default()
    };

    let mut sample_processor = SampleProcessor::new(SystemAudioFetcher::new(&descriptor).unwrap());
    let mut bar_processor = BarProcessor::new(&sample_processor, BarProcessorConfig::default());

    // start creating the bars
    sample_processor.process_next_samples();
    bar_processor.process_bars(&sample_processor);
}

pub fn process_bars(&mut self, processor: &SampleProcessor) -> &[Box<[f32]>]

Returns the bar values for each channel.

If you access the returned value like this: bar_processor.process_bars(&processor)[i][j] then this would mean: You are accessing the jth bar value of the ith audio channel.

Examples found in repository

examples/simple.rs (line 8)

fn main() {
    let mut sample_processor = SampleProcessor::new(DummyFetcher::new(2));
    sample_processor.process_next_samples();

    let mut bar_processor = BarProcessor::new(&sample_processor, BarProcessorConfig::default());
    bar_processor.process_bars(&sample_processor);
}

examples/default_system_fetcher.rs (line 15)

fn main() {
    // Choose default settings
    let descriptor = SystemAudioFetcherDescriptor::default();

    let mut processor = SampleProcessor::new(SystemAudioFetcher::new(&descriptor).unwrap());
    let mut bar_processor = BarProcessor::new(&processor, BarProcessorConfig::default());

    // simply fetch
    processor.process_next_samples();
    bar_processor.process_bars(&processor);
}

examples/custom_system_fetcher.rs (line 32)

fn main() {
    // get a list of all available devices
    let available_output_devices = shady_audio::util::get_device_names(DeviceType::Output)
        .expect("Output devices exists for the given host");

    println!("{:#?}", available_output_devices);

    // choose one
    let device = shady_audio::util::get_device(
        available_output_devices.first().unwrap(),
        DeviceType::Output,
    )
    .unwrap()
    .unwrap();

    let descriptor = SystemAudioFetcherDescriptor {
        device,
        ..Default::default()
    };

    let mut sample_processor = SampleProcessor::new(SystemAudioFetcher::new(&descriptor).unwrap());
    let mut bar_processor = BarProcessor::new(&sample_processor, BarProcessorConfig::default());

    // start creating the bars
    sample_processor.process_next_samples();
    bar_processor.process_bars(&sample_processor);
}

pub fn config(&self) -> &BarProcessorConfig

pub fn set_amount_bars(&mut self, amount_bars: NonZero<u16>)

Change the amount of bars which should be returned.

Example

use shady_audio::{SampleProcessor, BarProcessor, BarProcessorConfig, fetcher::DummyFetcher};

let mut sample_processor = SampleProcessor::new(DummyFetcher::new(1));
let mut bar_processor = BarProcessor::new(
    &sample_processor,
    BarProcessorConfig {
        amount_bars: std::num::NonZero::new(10).unwrap(),
        ..Default::default()
    }
);
sample_processor.process_next_samples();

let bars = bar_processor.process_bars(&sample_processor);
// the dummy just has one channel
assert_eq!(bars.len(), 1);
// but it should have ten bars
assert_eq!(bars[0].len(), 10);

// change the amount of bars
bar_processor.set_amount_bars(std::num::NonZero::new(20).unwrap());
let bars = bar_processor.process_bars(&sample_processor);
assert_eq!(bars.len(), 1);
assert_eq!(bars[0].len(), 20);