Struct Channel

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

Implementations§

Source§

impl Channel

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn set_volume_ramp(&self, ramp: bool) -> Result<(), Error>

Source

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

Source

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

Source

pub fn set_pitch(&self, pitch: f32) -> Result<(), Error>

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn set_mode(&self, mode: impl Into<FMOD_MODE>) -> Result<(), Error>

Source

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

Source

pub fn set_callback( &self, callback: FMOD_CHANNELCONTROL_CALLBACK, ) -> Result<(), Error>

Source

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

Source

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

Source

pub fn set_mix_levels_output( &self, frontleft: f32, frontright: f32, center: f32, lfe: f32, surroundleft: f32, surroundright: f32, backleft: f32, backright: f32, ) -> Result<(), Error>

Source

pub fn set_mix_levels_input( &self, levels: *mut f32, numlevels: i32, ) -> Result<(), Error>

Source

pub fn set_mix_matrix( &self, matrix: Option<*mut f32>, outchannels: i32, inchannels: i32, inchannel_hop: Option<i32>, ) -> Result<(), Error>

Source

pub fn get_mix_matrix( &self, inchannel_hop: i32, ) -> Result<(f32, i32, i32), Error>

Source

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

Source

pub fn set_delay( &self, dspclock_start: Option<u64>, dspclock_end: Option<u64>, stopchannels: bool, ) -> Result<(), Error>

Source

pub fn get_delay(&self) -> Result<(u64, u64, bool), Error>

Source

pub fn add_fade_point(&self, dspclock: u64, volume: f32) -> Result<(), Error>

Source

pub fn set_fade_point_ramp( &self, dspclock: u64, volume: f32, ) -> Result<(), Error>

Source

pub fn remove_fade_points( &self, dspclock_start: u64, dspclock_end: u64, ) -> Result<(), Error>

Source

pub fn get_fade_points(&self) -> Result<(u32, u64, f32), Error>

Source

pub fn get_dsp(&self, index: i32) -> Result<Dsp, Error>

Source

pub fn add_dsp(&self, index: i32, dsp: Dsp) -> Result<(), Error>

Source

pub fn remove_dsp(&self, dsp: Dsp) -> Result<(), Error>

Source

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

Source

pub fn set_dsp_index(&self, dsp: Dsp, index: i32) -> Result<(), Error>

Source

pub fn get_dsp_index(&self, dsp: Dsp) -> Result<i32, Error>

Source

pub fn set_3d_attributes( &self, pos: Option<Vector>, vel: Option<Vector>, ) -> Result<(), Error>

Source

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

Source

pub fn set_3d_min_max_distance( &self, mindistance: f32, maxdistance: f32, ) -> Result<(), Error>

Source

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

Source

pub fn set_3d_cone_settings( &self, insideconeangle: f32, outsideconeangle: f32, outsidevolume: f32, ) -> Result<(), Error>

Source

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

Source

pub fn set_3d_cone_orientation(&self, orientation: Vector) -> Result<(), Error>

Source

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

Source

pub fn set_3d_custom_rolloff(&self, points: Vec<Vector>) -> Result<(), Error>

Source

pub fn get_3d_custom_rolloff(&self) -> Result<Vec<Vector>, Error>

Source

pub fn set_3d_occlusion( &self, directocclusion: f32, reverbocclusion: f32, ) -> Result<(), Error>

Source

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

Source

pub fn set_3d_spread(&self, angle: f32) -> Result<(), Error>

Source

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

Source

pub fn set_3d_level(&self, level: f32) -> Result<(), Error>

Source

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

Source

pub fn set_3d_doppler_level(&self, level: f32) -> Result<(), Error>

Source

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

Source

pub fn set_3d_distance_filter( &self, custom: bool, custom_level: f32, center_freq: Option<f32>, ) -> Result<(), Error>

Source

pub fn get_3d_distance_filter(&self) -> Result<(bool, f32, f32), 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 set_frequency(&self, frequency: f32) -> Result<(), Error>

Source

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

Source

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

Source

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

Source

pub fn set_position( &self, position: u32, postype: impl Into<FMOD_TIMEUNIT>, ) -> Result<(), Error>

Source

pub fn get_position( &self, postype: impl Into<FMOD_TIMEUNIT>, ) -> Result<u32, Error>

Source

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

Source

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

Source

pub fn set_loop_count(&self, loopcount: i32) -> Result<(), Error>

Source

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

Source

pub fn set_loop_points( &self, loopstart: u32, loopstarttype: impl Into<FMOD_TIMEUNIT>, loopend: u32, loopendtype: impl Into<FMOD_TIMEUNIT>, ) -> Result<(), Error>

Source

pub fn get_loop_points( &self, loopstarttype: impl Into<FMOD_TIMEUNIT>, loopendtype: impl Into<FMOD_TIMEUNIT>, ) -> Result<(u32, u32), Error>

Source

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

Source

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

Source

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

Trait Implementations§

Source§

impl Clone for Channel

Source§

fn clone(&self) -> Channel

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 Channel

Source§

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

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

impl Copy for Channel

Source§

impl Send for Channel

Source§

impl Sync for Channel

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.