Struct rfmod::Sys

pub struct Sys {
    // some fields omitted
}

FMOD System Object

Methods

impl Sys

fn new() -> Result<Sys, Result>

fn init(&self) -> Result

fn init_with_parameters(&self, max_channels: i32, InitFlag: InitFlag) -> Result

fn update(&self) -> Result

fn release(&mut self) -> Result

fn create_sound(&self, music: &str, options: Option<Mode>, exinfo: Option<&mut CreateSoundexInfo>) -> Result<Sound, Result>

If music is empty, null is sent

fn create_stream(&self, music: &str, options: Option<Mode>, exinfo: Option<&mut CreateSoundexInfo>) -> Result<Sound, Result>

fn create_channel_group(&self, group_name: &str) -> Result<ChannelGroup, Result>

fn create_sound_group(&self, group_name: &str) -> Result<SoundGroup, Result>

fn create_reverb(&self) -> Result<Reverb, Result>

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

fn create_DSP_with_description(&self, description: &mut DspDescription) -> Result<Dsp, Result>

fn create_DSP_by_type(&self, _type: DspType) -> Result<Dsp, Result>

fn set_output(&self, output_type: OutputType) -> Result

fn get_output(&self) -> Result<OutputType, Result>

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

fn get_driver_info(&self, id: i32, name_len: usize) -> Result<(Guid, String), Result>

fn get_driver_caps(&self, id: i32) -> Result<(FmodCaps, i32, SpeakerMode), Result>

fn set_driver(&self, driver: i32) -> Result

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

fn set_hardware_channels(&self, num_hardware_channels: i32) -> Result

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

fn set_software_channels(&self, num_software_channels: i32) -> Result

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

fn set_software_format(&self, sample_rate: i32, format: SoundFormat, num_output_channels: i32, max_input_channels: i32, resample_method: DspResampler) -> Result

fn get_software_format(&self) -> Result<SoftwareFormat, Result>

fn set_DSP_buffer_size(&self, buffer_length: u32, num_buffers: i32) -> Result

fn get_DSP_buffer_size(&self) -> Result<(u32, i32), Result>

fn set_advanced_settings(&self, settings: &mut AdvancedSettings) -> Result

fn get_advanced_settings(&self) -> Result<AdvancedSettings, Result>

fn set_speaker_mode(&self, speaker_mode: SpeakerMode) -> Result

fn get_speaker_mode(&self) -> Result<SpeakerMode, Result>

fn set_plugin_path(&self, path: &str) -> Result

fn load_plugin(&self, filename: &str, priority: u32) -> Result<PluginHandle, Result>

fn unload_plugin(&self, PluginHandle: PluginHandle) -> Result

fn get_num_plugins(&self, plugin_type: PluginType) -> Result<i32, Result>

fn get_plugin_handle(&self, plugin_type: PluginType, index: i32) -> Result<PluginHandle, Result>

fn get_plugin_info(&self, PluginHandle: PluginHandle, name_len: usize) -> Result<(String, PluginType, u32), Result>

fn set_output_by_plugin(&self, PluginHandle: PluginHandle) -> Result

fn get_output_by_plugin(&self) -> Result<PluginHandle, Result>

fn create_DSP_by_plugin(&self, PluginHandle: PluginHandle) -> Result<Dsp, Result>

fn set_3D_num_listeners(&self, num_listeners: i32) -> Result

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

fn set_3D_listener_attributes(&self, listener: i32, pos: &Vector, vel: &Vector, forward: &Vector, up: &Vector) -> Result

fn get_3D_listener_attributes(&self, listener: i32) -> Result<(Vector, Vector, Vector, Vector), Result>

fn set_3D_speaker_position(&self, speaker: Speaker, x: f32, y: f32, active: bool) -> Result

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

fn set_3D_settings(&self, doppler_scale: f32, distance_factor: f32, roll_off_scale: f32) -> Result

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

fn set_stream_buffer_size(&self, file_buffer_size: u32, TimeUnit: TimeUnit) -> Result

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

fn get_version(&self) -> Result<u32, Result>

fn get_output_handle(&self) -> Result<OutputHandle, Result>

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

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

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

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

fn get_CDROM_drive_name(&self, drive: i32, drive_name_len: usize, scsi_name_len: usize, device_name_len: usize) -> Result<(String, String, String), Result>

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

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

fn get_channel(&self, channel_id: i32) -> Result<Channel, Result>

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

fn get_master_sound_group(&self) -> Result<SoundGroup, Result>

fn set_reverb_properties(&self, properties: ReverbProperties) -> Result

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

fn set_reverb_ambient_properties(&self, properties: ReverbProperties) -> Result

fn get_reverb_ambient_properties(&self) -> Result<ReverbProperties, Result>

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

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

fn lock_DSP(&self) -> Result

fn unlock_DSP(&self) -> Result

fn get_DSP_clock(&self) -> Result<(u32, u32), Result>

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

fn get_record_driver_info(&self, id: i32, name_len: usize) -> Result<(Guid, String), Result>

fn get_record_driver_caps(&self, id: i32) -> Result<(FmodCaps, i32, i32), Result>

fn get_record_position(&self, id: i32) -> Result<u32, Result>

fn start_record(&self, id: i32, sound: &Sound, _loop: bool) -> Result

fn stop_record(&self, id: i32) -> Result

fn is_recording(&self, id: i32) -> Result<bool, Result>

fn create_geometry(&self, max_polygons: i32, max_vertices: i32) -> Result<Geometry, Result>

fn set_geometry_settings(&self, max_world_size: f32) -> Result

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

fn get_geometry_occlusion(&self) -> Result<(Vector, Vector, f32, f32), Result>

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

fn set_file_system(&self, user_open: FileOpenCallback, user_close: FileCloseCallback, user_read: FileReadCallback, user_seek: FileSeekCallback, block_align: i32) -> Result

Trait Implementations

impl Drop for Sys

fn drop(&mut self)

A method called when the value goes out of scope.