Struct rfmod::Sound

pub struct Sound { /* fields omitted */ }

Sound object

Methods

impl Sound

fn get_system_object(&self) -> Result<Sys, Result>

fn release(&mut self) -> Result

fn play(&self) -> Result<Channel, Result>

fn play_with_parameters(&self, paused: bool, channel: &mut Channel) -> Result

fn play_to_the_end(&self) -> Result

fn set_defaults(
    &self,
    frequency: f32,
    volume: f32,
    pan: f32,
    priority: i32
) -> Result

fn get_defaults(&self) -> Result<(f32, f32, f32, i32), Result>

fn set_variations(
    &self,
    frequency_var: f32,
    volume_var: f32,
    pan_var: f32
) -> Result

fn get_variations(&self) -> Result<(f32, f32, f32), Result>

fn set_3D_min_max_distance(&self, min: f32, max: f32) -> Result

fn get_3D_min_max_distance(&self) -> Result<(f32, f32), Result>

fn set_3D_cone_settings(
    &self,
    inside_cone_angle: f32,
    outside_cone_angle: f32,
    outside_volume: f32
) -> Result

fn get_3D_cone_settings(&self) -> Result<(f32, f32, f32), Result>

fn set_3D_custom_rolloff(&self, points: Vec<Vector>) -> Result

fn get_3D_custom_rolloff(&self, num_points: u32) -> Result<Vec<Vector>, Result>

fn set_sub_sound(&self, index: i32, sub_sound: Sound) -> Result

fn get_sub_sound(&self, index: i32) -> Result<Sound, Result>

fn get_name(&self, name_len: usize) -> Result<String, Result>

fn get_length(&self, TimeUnit: TimeUnit) -> Result<u32, Result>

fn get_format(&self) -> Result<(SoundType, SoundFormat, i32, i32), Result>

fn get_num_sub_sounds(&self) -> Result<i32, Result>

fn get_num_tags(&self) -> Result<(i32, i32), Result>

fn get_tag(&self, name: &str, index: i32) -> Result<FmodTag, Result>

fn get_open_state(&self) -> Result<(OpenState, u32, bool, bool), Result>

fn set_sound_group(&self, sound_group: SoundGroup) -> Result

fn get_sound_group(&self) -> Result<SoundGroup, Result>

fn get_num_sync_points(&self) -> Result<i32, Result>

fn get_sync_point(&self, index: i32) -> Result<FmodSyncPoint, Result>

fn get_sync_point_info(
    &self,
    sync_point: FmodSyncPoint,
    name_len: usize,
    TimeUnit: TimeUnit
) -> Result<(String, u32), Result>

fn add_sync_point(
    &self,
    offset: u32,
    TimeUnit: TimeUnit,
    name: String
) -> Result<FmodSyncPoint, Result>

fn delete_sync_point(&self, sync_point: FmodSyncPoint) -> Result

fn set_mode(&self, Mode: Mode) -> Result

fn get_mode(&self) -> Result<Mode, Result>

fn set_loop_count(&self, loop_count: i32) -> Result

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

fn set_loop_points(
    &self,
    loop_start: u32,
    TimeUnit: TimeUnit,
    loop_end: u32,
    TimeUnit: TimeUnit
) -> Result

fn get_loop_points(
    &self,
    TimeUnit: TimeUnit,
    TimeUnit: TimeUnit
) -> Result<(u32, u32), Result>

fn get_num_channels(&self) -> Result<i32, Result>

fn set_music_channel_volume(&self, channel: i32, volume: f32) -> Result

fn get_music_channel_volume(&self, channel: i32) -> Result<f32, Result>

fn set_music_speed(&self, speed: f32) -> Result

fn get_music_speed(&self) -> Result<f32, Result>

fn set_sub_sound_sentence(&self, sub_sounds: &mut Vec<i32>) -> Result

fn seek_data(&self, pcm: u32) -> Result

fn get_memory_info(
    &self,
    MemoryBits: MemoryBits,
    EventMemoryBits: EventMemoryBits
) -> Result<(u32, MemoryUsageDetails), Result>

fn lock(&self, offset: u32, length: u32) -> Result<(Vec<u8>, Vec<u8>), Result>

fn unlock(&self, v_ptr1: Vec<u8>, v_ptr2: Vec<u8>) -> Result

fn set_user_data<T>(&mut self, user_data: &mut T) -> Result

fn get_user_data<'r, T>(&'r self) -> Result<&'r mut T, Result>

fn save_to_wav(&self, file_name: &str) -> Result<bool, String>

Trait Implementations

impl Drop for Sound

fn drop(&mut self)

A method called when the value goes out of scope.