Skip to main content

System

Struct System 

Source
pub struct System { /* private fields */ }

Implementations§

Source§

impl System

Source

pub fn from(pointer: *mut FMOD_SYSTEM) -> Self

Source

pub fn as_mut_ptr(&self) -> *mut FMOD_SYSTEM

Source

pub fn create() -> Result<System, Error>

Source

pub fn release(&self) -> Result<(), Error>

Source

pub fn set_output(&self, output: OutputType) -> Result<(), Error>

Source

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

Source

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

Source

pub fn get_driver_info( &self, id: i32, namelen: i32, ) -> Result<(String, Guid, i32, SpeakerMode, i32), Error>

Source

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

Source

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

Source

pub fn set_software_channels( &self, numsoftwarechannels: i32, ) -> Result<(), Error>

Source

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

Source

pub fn set_software_format( &self, samplerate: Option<i32>, speakermode: Option<SpeakerMode>, numrawspeakers: Option<i32>, ) -> Result<(), Error>

Source

pub fn get_software_format(&self) -> Result<(i32, SpeakerMode, i32), Error>

Source

pub fn set_dsp_buffer_size( &self, bufferlength: u32, numbuffers: i32, ) -> Result<(), Error>

Source

pub fn get_dsp_buffer_size(&self) -> Result<(u32, i32), Error>

Source

pub fn set_file_system( &self, useropen: FMOD_FILE_OPEN_CALLBACK, userclose: FMOD_FILE_CLOSE_CALLBACK, userread: FMOD_FILE_READ_CALLBACK, userseek: FMOD_FILE_SEEK_CALLBACK, userasyncread: FMOD_FILE_ASYNCREAD_CALLBACK, userasynccancel: FMOD_FILE_ASYNCCANCEL_CALLBACK, blockalign: Option<i32>, ) -> Result<(), Error>

Source

pub fn attach_file_system( &self, useropen: FMOD_FILE_OPEN_CALLBACK, userclose: FMOD_FILE_CLOSE_CALLBACK, userread: FMOD_FILE_READ_CALLBACK, userseek: FMOD_FILE_SEEK_CALLBACK, ) -> Result<(), Error>

Source

pub fn set_advanced_settings( &self, settings: AdvancedSettings, ) -> Result<(), Error>

Source

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

Source

pub fn set_callback( &self, callback: FMOD_SYSTEM_CALLBACK, callbackmask: impl Into<FMOD_SYSTEM_CALLBACK_TYPE>, ) -> Result<(), Error>

Source

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

Source

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

Source

pub fn unload_plugin(&self, handle: u32) -> Result<(), Error>

Source

pub fn get_num_nested_plugins(&self, handle: u32) -> Result<i32, Error>

Source

pub fn get_nested_plugin(&self, handle: u32, index: i32) -> Result<u32, Error>

Source

pub fn get_num_plugins(&self, plugintype: PluginType) -> Result<i32, Error>

Source

pub fn get_plugin_handle( &self, plugintype: PluginType, index: i32, ) -> Result<u32, Error>

Source

pub fn get_plugin_info( &self, handle: u32, namelen: i32, ) -> Result<(PluginType, String, u32), Error>

Source

pub fn set_output_by_plugin(&self, handle: u32) -> Result<(), Error>

Source

pub fn get_output_by_plugin(&self) -> Result<u32, Error>

Source

pub fn create_dsp_by_plugin(&self, handle: u32) -> Result<Dsp, Error>

Source

pub fn get_dsp_info_by_plugin( &self, handle: u32, ) -> Result<DspDescription, Error>

Source

pub fn register_codec( &self, description: CodecDescription, priority: Option<u32>, ) -> Result<u32, Error>

Source

pub fn register_dsp(&self, description: DspDescription) -> Result<u32, Error>

Source

pub fn register_output( &self, description: OutputDescription, ) -> Result<u32, Error>

Source

pub fn init( &self, maxchannels: i32, flags: impl Into<FMOD_INITFLAGS>, extradriverdata: Option<*mut c_void>, ) -> Result<(), Error>

Source

pub fn close(&self) -> Result<(), Error>

Source

pub fn update(&self) -> Result<(), Error>

Source

pub fn set_speaker_position( &self, speaker: Speaker, x: f32, y: f32, active: bool, ) -> Result<(), Error>

Source

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

Source

pub fn set_stream_buffer_size( &self, filebuffersize: u32, filebuffersizetype: impl Into<FMOD_TIMEUNIT>, ) -> Result<(), Error>

Source

pub fn get_stream_buffer_size(&self) -> Result<(u32, FMOD_TIMEUNIT), Error>

Source

pub fn set_3d_settings( &self, dopplerscale: f32, distancefactor: f32, rolloffscale: f32, ) -> Result<(), Error>

Source

pub fn get_3d_settings(&self) -> Result<(f32, f32, f32), Error>

Source

pub fn set_3d_num_listeners(&self, numlisteners: i32) -> Result<(), Error>

Source

pub fn get_3d_num_listeners(&self) -> Result<i32, Error>

Source

pub fn set_3d_listener_attributes( &self, listener: i32, pos: Option<Vector>, vel: Option<Vector>, forward: Option<Vector>, up: Option<Vector>, ) -> Result<(), Error>

Source

pub fn get_3d_listener_attributes( &self, listener: i32, ) -> Result<(Vector, Vector, Vector, Vector), Error>

Source

pub fn set_3d_rolloff_callback( &self, callback: FMOD_3D_ROLLOFF_CALLBACK, ) -> Result<(), Error>

Source

pub fn mixer_suspend(&self) -> Result<(), Error>

Source

pub fn mixer_resume(&self) -> Result<(), Error>

Source

pub fn get_default_mix_matrix( &self, sourcespeakermode: SpeakerMode, targetspeakermode: SpeakerMode, matrixhop: Option<i32>, ) -> Result<f32, Error>

Source

pub fn get_speaker_mode_channels(&self, mode: SpeakerMode) -> Result<i32, Error>

Source

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

Source

pub fn get_output_handle(&self) -> Result<*mut c_void, Error>

Source

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

Source

pub fn get_cpu_usage(&self) -> Result<CpuUsage, Error>

Source

pub fn get_file_usage(&self) -> Result<(i64, i64, i64), Error>

Source

pub fn create_sound( &self, name_or_data: &str, mode: impl Into<FMOD_MODE>, exinfo: Option<CreateSoundexInfo>, ) -> Result<Sound, Error>

Source

pub fn create_sound_from( &self, data: &[u8], mode: impl Into<FMOD_MODE>, exinfo: CreateSoundexInfo, ) -> Result<Sound, Error>

Source

pub fn create_stream( &self, name_or_data: &str, mode: impl Into<FMOD_MODE>, exinfo: Option<CreateSoundexInfo>, ) -> Result<Sound, Error>

Source

pub fn create_stream_from( &self, data: &[u8], mode: impl Into<FMOD_MODE>, exinfo: CreateSoundexInfo, ) -> Result<Sound, Error>

Source

pub fn create_dsp(&self, description: DspDescription) -> Result<Dsp, Error>

Source

pub fn create_dsp_by_type(&self, type_: DspType) -> Result<Dsp, Error>

Source

pub fn create_channel_group( &self, name: Option<String>, ) -> Result<ChannelGroup, Error>

Source

pub fn create_sound_group(&self, name: &str) -> Result<SoundGroup, Error>

Source

pub fn create_reverb_3d(&self) -> Result<Reverb3d, Error>

Source

pub fn play_sound( &self, sound: Sound, channelgroup: Option<ChannelGroup>, paused: bool, ) -> Result<Channel, Error>

Source

pub fn play_dsp( &self, dsp: Dsp, channelgroup: Option<ChannelGroup>, paused: bool, ) -> Result<Channel, Error>

Source

pub fn get_channel(&self, channelid: i32) -> Result<Channel, Error>

Source

pub fn get_dsp_info_by_type( &self, type_: DspType, ) -> Result<DspDescription, Error>

Source

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

Source

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

Source

pub fn attach_channel_group_to_port( &self, port_type: PortType, port_index: impl Into<FMOD_PORT_INDEX>, channelgroup: ChannelGroup, pass_thru: bool, ) -> Result<(), Error>

Source

pub fn detach_channel_group_from_port( &self, channelgroup: ChannelGroup, ) -> Result<(), Error>

Source

pub fn set_reverb_properties( &self, instance: i32, prop: ReverbProperties, ) -> Result<(), Error>

Source

pub fn get_reverb_properties( &self, instance: i32, ) -> Result<ReverbProperties, Error>

Source

pub fn lock_dsp(&self) -> Result<(), Error>

Source

pub fn unlock_dsp(&self) -> Result<(), Error>

Source

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

Source

pub fn get_record_driver_info( &self, id: i32, namelen: i32, ) -> Result<(String, Guid, i32, SpeakerMode, i32, FMOD_DRIVER_STATE), Error>

Source

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

Source

pub fn record_start( &self, id: i32, sound: Sound, loop_: bool, ) -> Result<(), Error>

Source

pub fn record_stop(&self, id: i32) -> Result<(), Error>

Source

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

Source

pub fn create_geometry( &self, maxpolygons: i32, maxvertices: i32, ) -> Result<Geometry, Error>

Source

pub fn set_geometry_settings(&self, maxworldsize: f32) -> Result<(), Error>

Source

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

Source

pub fn load_geometry( &self, data: *const c_void, datasize: i32, ) -> Result<Geometry, Error>

Source

pub fn get_geometry_occlusion( &self, listener: Vector, source: Vector, ) -> Result<(f32, f32), Error>

Source

pub fn set_network_proxy(&self, proxy: &str) -> Result<(), Error>

Source

pub fn get_network_proxy(&self, proxylen: i32) -> Result<String, Error>

Source

pub fn set_network_timeout(&self, timeout: i32) -> Result<(), Error>

Source

pub fn get_network_timeout(&self) -> Result<i32, Error>

Source

pub fn set_user_data(&self, userdata: *mut c_void) -> Result<(), Error>

Source

pub fn get_user_data(&self) -> Result<*mut c_void, Error>

Trait Implementations§

Source§

impl Clone for System

Source§

fn clone(&self) -> System

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for System

Source§

impl Debug for System

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Send for System

Source§

impl Sync for System

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.