Struct libfmod::Channel

source · [−]

pub struct Channel { /* private fields */ }

Implementations

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: 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, numlevels: i32) -> Result<f32, Error>

source

pub fn set_mix_matrix(
 &self,
 outchannels: i32,
 inchannels: i32,
 inchannel_hop: i32
) -> Result<f32, 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: u64,
 dspclock_end: 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_3_d_attributes(&self, pos: Vector, vel: Vector) -> Result<(), Error>

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

pub fn set_3_d_custom_rolloff(&self, numpoints: i32) -> Result<Vector, Error>

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

pub fn get_3_d_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: FMOD_TIMEUNIT
) -> Result<(), Error>

source

pub fn get_position(&self, postype: 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: FMOD_TIMEUNIT,
 loopend: u32,
 loopendtype: FMOD_TIMEUNIT
) -> Result<(), Error>

source

pub fn get_loop_points(
 &self,
 loopstarttype: FMOD_TIMEUNIT,
 loopendtype: 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 copy 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

Auto Trait Implementations

impl RefUnwindSafe for Channel

impl !Send for Channel

impl !Sync for Channel

impl Unpin for Channel

impl UnwindSafe for Channel

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub 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,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct libfmod::Channel

Implementations

impl Channel

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn set_3_d_custom_rolloff(&self, numpoints: i32) -> Result<Vector, Error>

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn set_frequency(&self, frequency: f32) -> Result<(), Error>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,