Studio

Struct Studio 

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

Implementations§

Source§

impl Studio

Source

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

Source

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

Source

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

Source

pub fn is_valid(&self) -> bool

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn get_event(&self, path_or_id: &str) -> Result<EventDescription, Error>

Source

pub fn get_bus(&self, path_or_id: &str) -> Result<Bus, Error>

Source

pub fn get_vca(&self, path_or_id: &str) -> Result<Vca, Error>

Source

pub fn get_bank(&self, path_or_id: &str) -> Result<Bank, Error>

Source

pub fn get_event_by_id(&self, id: Guid) -> Result<EventDescription, Error>

Source

pub fn get_bus_by_id(&self, id: Guid) -> Result<Bus, Error>

Source

pub fn get_vca_by_id(&self, id: Guid) -> Result<Vca, Error>

Source

pub fn get_bank_by_id(&self, id: Guid) -> Result<Bank, Error>

Source

pub fn get_sound_info(&self, key: &str) -> Result<SoundInfo, Error>

Source

pub fn get_parameter_description_by_name( &self, name: &str, ) -> Result<ParameterDescription, Error>

Source

pub fn get_parameter_description_by_id( &self, id: ParameterId, ) -> Result<ParameterDescription, Error>

Source

pub fn get_parameter_label_by_name( &self, name: &str, labelindex: i32, size: i32, ) -> Result<(String, i32), Error>

Source

pub fn get_parameter_label_by_id( &self, id: ParameterId, labelindex: i32, size: i32, ) -> Result<(String, i32), Error>

Source

pub fn get_parameter_by_id(&self, id: ParameterId) -> Result<(f32, f32), Error>

Source

pub fn set_parameter_by_id( &self, id: ParameterId, value: f32, ignoreseekspeed: bool, ) -> Result<(), Error>

Source

pub fn set_parameter_by_id_with_label( &self, id: ParameterId, label: &str, ignoreseekspeed: bool, ) -> Result<(), Error>

Source

pub fn set_parameters_by_i_ds( &self, ids: ParameterId, values: *mut f32, count: i32, ignoreseekspeed: bool, ) -> Result<(), Error>

Source

pub fn get_parameter_by_name(&self, name: &str) -> Result<(f32, f32), Error>

Source

pub fn set_parameter_by_name( &self, name: &str, value: f32, ignoreseekspeed: bool, ) -> Result<(), Error>

Source

pub fn set_parameter_by_name_with_label( &self, name: &str, label: &str, ignoreseekspeed: bool, ) -> Result<(), Error>

Source

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

Source

pub fn lookup_path(&self, id: Guid) -> Result<String, Error>

Source

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

Source

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

Source

pub fn get_listener_attributes( &self, index: i32, ) -> Result<(Attributes3d, Vector), Error>

Source

pub fn set_listener_attributes( &self, index: i32, attributes: Attributes3d, attenuationposition: Option<Vector>, ) -> Result<(), Error>

Source

pub fn get_listener_weight(&self, index: i32) -> Result<f32, Error>

Source

pub fn set_listener_weight(&self, index: i32, weight: f32) -> Result<(), Error>

Source

pub fn load_bank_file( &self, filename: &str, flags: impl Into<FMOD_STUDIO_LOAD_BANK_FLAGS>, ) -> Result<Bank, Error>

Source

pub fn load_bank_memory( &self, buffer: &[u8], flags: impl Into<FMOD_STUDIO_LOAD_BANK_FLAGS>, ) -> Result<Bank, Error>

Source

pub fn load_bank_custom( &self, info: BankInfo, flags: impl Into<FMOD_STUDIO_LOAD_BANK_FLAGS>, ) -> Result<Bank, Error>

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn start_command_capture( &self, filename: &str, flags: impl Into<FMOD_STUDIO_COMMANDCAPTURE_FLAGS>, ) -> Result<(), Error>

Source

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

Source

pub fn load_command_replay( &self, filename: &str, flags: impl Into<FMOD_STUDIO_COMMANDREPLAY_FLAGS>, ) -> Result<CommandReplay, Error>

Source

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

Source

pub fn get_bank_list(&self, capacity: i32) -> Result<Vec<Bank>, Error>

Source

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

Source

pub fn get_parameter_description_list( &self, capacity: i32, ) -> Result<Vec<ParameterDescription>, Error>

Source

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

Source

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

Source

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

Source

pub fn set_callback( &self, callback: FMOD_STUDIO_SYSTEM_CALLBACK, callbackmask: impl Into<FMOD_STUDIO_SYSTEM_CALLBACK_TYPE>, ) -> Result<(), 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>

Source

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

Trait Implementations§

Source§

impl Clone for Studio

Source§

fn clone(&self) -> Studio

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Studio

Source§

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

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

impl Copy for Studio

Source§

impl Send for Studio

Source§

impl Sync for Studio

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.