Struct Sys

pub struct Sys { /* private fields */ }

FMOD System Object

Implementations

impl Sys

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

pub fn init(&self) -> Status

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

pub fn update(&self) -> Status

pub fn release(&mut self) -> Status

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

If music is empty, null is sent

pub fn create_sound_openmemory( &self, music: &[u8], options: Option<Mode>, exinfo: Option<&mut CreateSoundexInfo>, ) -> Result<Sound, Status>

Create sound from a file contained in a byte slice.

Automatically adds the OPENMEMORY mode flag and uses the length of the slice as the exinfo length parameter. Ignores the CREATESTREAM mode flag since this would keep a pointer to the passed in buffer.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn unload_plugin(&self, PluginHandle: PluginHandle) -> Status

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

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

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

pub fn set_output_by_plugin(&self, PluginHandle: PluginHandle) -> Status

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

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

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

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

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

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

Returns:

Ok(position, velocity, forward, up)

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

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

Returns:

Ok(x, y, is_active)

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

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

Returns:

Ok(doppler_scale, distance_factor, roll_off_scale)

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

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

Returns:

Ok(file_buffer_size, distance_factor, time)

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

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

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

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

Returns:

Ok(dsp, stream, geometry, update, total)

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

Returns:

Ok(current_alloced, max_allocated, total)

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

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

Returns:

Ok(drive_name, scsi_name, device_name)

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

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

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

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

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

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

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

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

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

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

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

pub fn lock_DSP(&self) -> Status

pub fn unlock_DSP(&self) -> Status

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

Returns:

Ok(hi, lo)

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

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

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

Returns:

Ok(caps, min_frequency, max_frequency)

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

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

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

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

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

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

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

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

Returns:

Ok(listener, source, direct, reverb)

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

Returns:

Ok(memory_used, details)

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

Trait Implementations

impl Drop for Sys

fn drop(&mut self)

Executes the destructor for this type.