Struct rfmod::Dsp

pub struct Dsp { /* fields omitted */ }

Dsp object

Methods

impl Dsp

fn get_system_object(&self) -> Result<Sys, Result>

fn release(&mut self) -> Result

fn play(&self) -> Result<Channel, Result>

fn play_with_parameters(
    &self,
    channel_id: ChannelIndex
) -> Result<Channel, Result>

fn add_input(&self, target: Dsp) -> Result<DspConnection, Result>

fn disconnect_from(&self, target: Dsp) -> Result

fn disconnect_all(&self, inputs: bool, outputs: bool) -> Result

fn remove(&self) -> Result

fn get_num_inputs(&self) -> Result<i32, Result>

fn get_num_outputs(&self) -> Result<i32, Result>

fn get_input(&self, index: i32) -> Result<(Dsp, DspConnection), Result>

fn get_output(&self, index: i32) -> Result<(Dsp, DspConnection), Result>

fn set_active(&self, active: bool) -> Result

fn get_active(&self) -> Result<bool, Result>

fn set_bypass(&self, bypass: bool) -> Result

fn get_bypass(&self) -> Result<bool, Result>

fn set_speaker_active(&self, speaker: Speaker, active: bool) -> Result

fn get_speaker_active(&self, speaker: Speaker) -> Result<bool, Result>

fn reset(&self) -> Result

fn set_parameter(&self, index: i32, value: f32) -> Result

value argument depends directly on the index argument, index argument depends on your DSP type, it is a value from one of the following enums :

• DspType
• DspOscillator
• DspLowPass
• DspITLowPass
• DspHighPass
• DspTypeEcho
• DspDelay
• DspFlange
• DspTremolo
• DspDistortion
• DspNormalize
• DspTypeParameq
• DspPitchShift
• DspChorus
• DspITEcho
• DspCompressor
• DspSfxReverb
• DspLowPassSimple
• DspHighPassSimple

fn get_parameter(
    &self,
    index: i32,
    value_str_len: usize
) -> Result<(f32, String), Result>

value result depends directly on the index argument, index argument depends on your DSP type, it is a value from one of the following enums :

• DspType
• DspOscillator
• DspLowPass
• DspITLowPass
• DspHighPass
• DspTypeEcho
• DspDelay
• DspFlange
• DspTremolo
• DspDistortion
• DspNormalize
• DspTypeParameq
• DspPitchShift
• DspChorus
• DspITEcho
• DspCompressor
• DspSfxReverb
• DspLowPassSimple
• DspHighPassSimple

fn get_num_parameters(&self) -> Result<i32, Result>

fn get_parameter_info(
    &self,
    index: i32,
    name: &str,
    label: &str,
    description_len: usize
) -> Result<(String, f32, f32), Result>

fn get_info(&self, name: &str) -> Result<(u32, i32, i32, i32), Result>

fn set_defaults(
    &self,
    frequency: f32,
    volume: f32,
    pan: f32,
    priority: i32
) -> Result

fn get_type(&self) -> Result<DspType, Result>

fn get_defaults(&self) -> Result<(f32, f32, f32, i32), Result>

fn get_memory_info(
    &self,
    MemoryBits: MemoryBits,
    EventMemoryBits: EventMemoryBits
) -> Result<(u32, MemoryUsageDetails), Result>

fn set_user_data<T>(&mut self, user_data: &mut T) -> Result

fn get_user_data<'r, T>(&'r self) -> Result<&'r mut T, Result>

Trait Implementations

impl Drop for Dsp

fn drop(&mut self)

A method called when the value goes out of scope.