Struct soloud::audio::Bus

pub struct Bus { /* fields omitted */ }

Implementations

impl Bus

pub fn active_voice_count(&self) -> u32

Get active voice count

pub fn play<T: AudioExt>(&self, sound: &T) -> Handle

Play audio

pub fn play_ex<AS: AudioExt>(
    &self,
    sound: &AS,
    volume: f32,
    pan: f32,
    paused: bool
) -> u32

Play audio with extra args

pub fn play_clocked<AS: AudioExt>(&self, sound_time: f64, sound: &AS) -> u32

Play clocked

pub fn play_clocked_ex<AS: AudioExt>(
    &self,
    sound_time: f64,
    sound: &AS,
    volume: f32,
    pan: f32
) -> u32

Play clocked with extra args

pub fn play_3d<AS: AudioExt>(
    &self,
    sound: &AS,
    pos_x: f32,
    pos_y: f32,
    pos_z: f32
) -> u32

Play 3D

pub fn play_3d_ex<AS: AudioExt>(
    &self,
    sound: &AS,
    pos_x: f32,
    pos_y: f32,
    pos_z: f32,
    vel_x: f32,
    vel_y: f32,
    vel_z: f32,
    volume: f32,
    paused: bool
) -> u32

Play 3D with extra args

pub fn play_3d_clocked<AS: AudioExt>(
    &self,
    sound_time: f64,
    sound: &AS,
    pos_x: f32,
    pos_y: f32,
    pos_z: f32
) -> u32

Play 3D clocked

pub fn play_3d_clocked_ex<AS: AudioExt>(
    &self,
    sound_time: f64,
    sound: &AS,
    pos_x: f32,
    pos_y: f32,
    pos_z: f32,
    vel_x: f32,
    vel_y: f32,
    vel_z: f32,
    volume: f32
) -> u32

Play 3D clocked with extra args

pub fn set_visualize_enable(&self, flag: bool)

Enable visualizations

pub fn calc_fft(&self) -> Vec<f32>

Calculate and get 256 floats of FFT data for visualization. Visualization has to be enabled before use

pub fn wave(&self) -> Vec<f32>

Get 256 floats of wave data for visualization. Visualization has to be enabled before use

pub fn approximate_volume(&self, channel: u32) -> f32

Get approximate volume

pub fn set_channels(&mut self, channels: u32) -> Result<(), SoloudError>

Set bus channels

pub fn resampler(&self) -> Resampler

Get bus resampler

pub fn set_resampler(&mut self, resampler: Resampler)

Set bus resampler

Trait Implementations

impl AudioExt for Bus

fn default() -> Self

Creates a default initialized object

fn set_volume(&mut self, volume: f32)

Sets the volume

fn set_looping(&mut self, flag: bool)

Set whether the audio is looping

fn set_auto_stop(&mut self, flag: bool)

Set auto stop

fn set_3d_min_max_distance(&mut self, min_distance: f32, max_distance: f32)

Set 3D min and max distances

fn set_3d_attenuation(&mut self, model: AttenuationModel, rolloff_factor: f32)

Set 3D attenuation

fn set_3d_doppler_factor(&mut self, doppler_factor: f32)

Set 3D doppler factor

fn set_3d_listener_relative(&mut self, flag: bool)

Set 3D listener relative

fn set_3d_distance_delay(&mut self, distance_delay: i32)

Set 3D distance delay

fn set_inaudible_behavior(&mut self, must_tick: bool, kill: bool)

Set inaudible behavior

fn set_loop_point(&mut self, loop_point: f64)

Set a loop point

fn loop_point(&self) -> f64

Get the loop point

fn set_filter<F: FilterExt>(&mut self, filter_id: u32, filter: Option<&F>)

Set a filter, the filter_id is assigned by the developer and becomes the id for that filter, and to cancel pass None as a filter to the already assigned id

fn stop(&mut self)

Stop

unsafe fn inner(&self) -> *mut *mut c_void

Get the inner pointer

impl Drop for Bus

fn drop(&mut self)

Executes the destructor for this type.