Struct rfmod::Channel

pub struct Channel { /* fields omitted */ }

Channel Object

Methods

impl Channel

fn new() -> Channel

fn release(&mut self)

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

fn stop(&self) -> Result

fn get_spectrum(
    &self,
    spectrum_size: usize,
    channel_offset: Option<i32>,
    window_type: Option<DspFftWindow>
) -> Result<Vec<f32>, Result>

channel_offset: 0/1 -> left channel/right channel

fn get_wave_data(
    &self,
    wave_size: usize,
    channel_offset: i32
) -> Result<Vec<f32>, Result>

fn is_init(&self) -> bool

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

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

fn get_audibility(&self) -> Result<f32, Result>

fn get_current_sound(&self) -> Result<Sound, Result>

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

fn set_volume(&self, volume: f32) -> Result

fn get_volume(&self) -> Result<f32, Result>

fn set_frequency(&self, frequency: f32) -> Result

fn get_frequency(&self) -> Result<f32, Result>

fn set_pan(&self, pan: f32) -> Result

fn get_pan(&self) -> Result<f32, Result>

fn set_mute(&self, mute: bool) -> Result

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

fn set_paused(&self, paused: bool) -> Result

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

fn set_delay(
    &self,
    delay_type: DelayType,
    delay_hi: usize,
    delay_lo: usize
) -> Result

fn get_delay(
    &self,
    delay_type: DelayType
) -> Result<(DelayType, usize, usize), Result>

fn set_speaker_mix(&self, smo: &SpeakerMixOptions) -> Result

fn get_speaker_mix(&self) -> Result<SpeakerMixOptions, Result>

fn set_speaker_level(&self, speaker: Speaker, levels: &mut Vec<f32>) -> Result

fn get_speaker_level(
    &self,
    speaker: Speaker,
    num_levels: usize
) -> Result<Vec<f32>, Result>

fn set_input_channel_mix(&self, levels: &mut Vec<f32>) -> Result

fn get_input_channel_mix(&self, num_levels: usize) -> Result<Vec<f32>, Result>

fn set_priority(&self, priority: i32) -> Result

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

fn set_position(&self, position: usize, TimeUnit: TimeUnit) -> Result

fn get_position(&self, TimeUnit: TimeUnit) -> Result<usize, Result>

fn set_reverb_properties(&self, prop: &ReverbChannelProperties) -> Result

fn get_reverb_properties(&self) -> Result<ReverbChannelProperties, Result>

fn set_low_pass_gain(&self, gain: f32) -> Result

fn get_low_pass_gain(&self) -> Result<f32, Result>

fn set_channel_group(&mut self, channel_group: &ChannelGroup) -> Result

fn get_channel_group(&self) -> Result<ChannelGroup, Result>

fn set_3D_attributes(&self, position: &Vector, velocity: &Vector) -> Result

fn get_3D_attributes(&self) -> Result<(Vector, Vector), Result>

fn set_3D_min_max_distance(
    &self,
    min_distance: f32,
    max_distance: f32
) -> Result

fn get_3D_min_max_distance(&self) -> Result<(f32, f32), Result>

fn set_3D_cone_settings(
    &self,
    inside_cone_angle: f32,
    outside_cone_angle: f32,
    outside_volume: f32
) -> Result

fn get_3D_cone_settings(&self) -> Result<(f32, f32, f32), Result>

fn set_3D_cone_orientation(&self, orientation: &Vector) -> Result

fn get_3D_cone_orientation(&self) -> Result<Vector, Result>

fn set_3D_custom_rolloff(&self, points: &Vec<Vector>) -> Result

fn get_3D_custom_rolloff(&self) -> Result<Vec<Vector>, Result>

fn set_3D_occlusion(
    &self,
    direct_occlusion: f32,
    reverb_occlusion: f32
) -> Result

fn get_3D_occlusion(&self) -> Result<(f32, f32), Result>

fn set_3D_spread(&self, angle: f32) -> Result

fn get_3D_spread(&self) -> Result<f32, Result>

fn set_3D_pan_level(&self, level: f32) -> Result

fn get_3D_pan_level(&self) -> Result<f32, Result>

fn set_3D_doppler_level(&self, level: f32) -> Result

fn get_3D_doppler_level(&self) -> Result<f32, Result>

fn set_3D_distance_filter(
    &self,
    custom: bool,
    custom_level: f32,
    center_freq: f32
) -> Result

fn get_3D_distance_filter(&self) -> Result<(bool, f32, f32), Result>

fn get_DSP_head(&self) -> Result<Dsp, Result>

fn add_DSP(&self, dsp: &Dsp) -> Result<DspConnection, Result>

fn set_mode(&self, Mode: Mode) -> Result

fn get_mode(&self) -> Result<Mode, Result>

fn set_loop_count(&self, loop_count: i32) -> Result

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

fn set_loop_points(
    &self,
    loop_start: u32,
    TimeUnit: TimeUnit,
    loop_end: u32,
    TimeUnit: TimeUnit
) -> Result

fn get_loop_points(
    &self,
    TimeUnit: TimeUnit,
    TimeUnit: TimeUnit
) -> Result<(u32, u32), Result>

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

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

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

Trait Implementations

impl Drop for Channel

fn drop(&mut self)

A method called when the value goes out of scope.