Struct Dsp

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

Dsp object

Implementations§

Source§

impl Dsp

Source

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

Source

pub fn release(&mut self) -> Status

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn remove(&self) -> Status

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn reset(&self) -> Status

Source

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

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 :

Source

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

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:

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn set_user_data<'r, T>(&'r mut self, user_data: &'r mut T) -> Status

Source

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

Trait Implementations§

Source§

impl Drop for Dsp

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl Freeze for Dsp

§

impl RefUnwindSafe for Dsp

§

impl !Send for Dsp

§

impl !Sync for Dsp

§

impl Unpin for Dsp

§

impl UnwindSafe for Dsp

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