stdlib/audio_mixerView source ↗
audio_mixer
27 items · generated by scribe fromstdlib/audio_mixer.fd· synced 2026-11-15
Contents
- GROUP_MASTER: (const)
- SoundEntry (struct)
- AudioMixer (struct)
- audio_mixer_init (function)
- audio_mixer_load (function)
- audio_mixer_load_group (function)
- audio_mixer_play (function)
- audio_mixer_play_volume (function)
- audio_mixer_play_3d (function)
- audio_mixer_play_2d (function)
- audio_mixer_distance_attenuation (function)
- audio_mixer_set_master_volume (function)
- audio_mixer_set_group_volume (function)
- audio_mixer_master_volume (function)
- audio_mixer_group_volume (function)
- audio_mixer_set_listener (function)
- audio_mixer_set_3d_params (function)
- audio_mixer_stop_group (function)
- audio_mixer_stop_all (function)
- audio_mixer_pause_all (function)
- audio_mixer_resume_all (function)
- audio_mixer_unload (function)
- audio_mixer_unload_all (function)
- audio_mixer_sound_count (function)
- audio_mixer_is_loaded (function)
- audio_mixer_shutdown (function)
GROUP_MASTER:
pub const GROUP_MASTER: i64 = 0; pub const GROUP_SFX: i64 = 1; pub const GROUP_MUSIC: i64 = 2; pub const GROUP_VOICE: i64 = 3; pub const GROUP_AMBIENT: i64 = 4; pub const GROUP_COUNT: i64 = 5;Defined at line 27
SoundEntry
pub struct SoundEntry {Fields:
| Name | Type |
|---|---|
name | str |
handle | i64 |
group | i64 |
default_volume | f64 |
loaded | bool |
Defined at line 30
AudioMixer
pub struct AudioMixer {Fields:
| Name | Type |
|---|---|
sounds | Vec<SoundEntry> |
group_volumes | Vec<f64> |
master_volume | f64 |
listener_x | f64 |
listener_y | f64 |
listener_z | f64 |
max_distance | f64 |
ref_distance | f64 |
rolloff | f64 |
initialized | bool |
Defined at line 39
audio_mixer_init
Initialize the audio mixer.
pub fn audio_mixer_init() -> void {Returns: void
Defined at line 60
audio_mixer_load
Load a sound file into the cache. Returns the sound index or -1 on failure.
pub fn audio_mixer_load(name: str) -> i64 {Parameters:
name:str
Returns: i64
Defined at line 72
audio_mixer_load_group
Load a sound into a specific group.
pub fn audio_mixer_load_group(name: str, group: i64) -> i64 {Parameters:
name:strgroup:i64
Returns: i64
Defined at line 100
audio_mixer_play
Play a sound by index.
pub fn audio_mixer_play(sound_idx: i64) -> i64 {Parameters:
sound_idx:i64
Returns: i64
Defined at line 111
audio_mixer_play_volume
Play a sound with a specific volume override.
pub fn audio_mixer_play_volume(sound_idx: i64, volume: f64) -> i64 {Parameters:
sound_idx:i64volume:f64
Returns: i64
Defined at line 127
audio_mixer_play_3d
Play a sound with 3D positional attenuation.
pub fn audio_mixer_play_3d(sound_idx: i64, sx: f64, sy: f64, sz: f64) -> i64 {Parameters:
sound_idx:i64sx:f64sy:f64sz:f64
Returns: i64
Defined at line 143
audio_mixer_play_2d
Play a sound with 2D positional audio (x, y only).
pub fn audio_mixer_play_2d(sound_idx: i64, sx: f64, sy: f64) -> i64 {Parameters:
sound_idx:i64sx:f64sy:f64
Returns: i64
Defined at line 167
audio_mixer_distance_attenuation
Compute distance attenuation factor (0..1).
pub fn audio_mixer_distance_attenuation(distance: f64) -> f64 {Parameters:
distance:f64
Returns: f64
Defined at line 172
audio_mixer_set_master_volume
Set the master volume (0..1).
pub fn audio_mixer_set_master_volume(vol: f64) -> void {Parameters:
vol:f64
Returns: void
Defined at line 201
audio_mixer_set_group_volume
Set the volume for a specific group (0..1).
pub fn audio_mixer_set_group_volume(group: i64, vol: f64) -> void {Parameters:
group:i64vol:f64
Returns: void
Defined at line 212
audio_mixer_master_volume
Get the master volume.
pub fn audio_mixer_master_volume() -> f64 {Returns: f64
Defined at line 226
audio_mixer_group_volume
Get the volume for a specific group.
pub fn audio_mixer_group_volume(group: i64) -> f64 {Parameters:
group:i64
Returns: f64
Defined at line 231
audio_mixer_set_listener
Set the listener position for 3D audio.
pub fn audio_mixer_set_listener(x: f64, y: f64, z: f64) -> void {Parameters:
x:f64y:f64z:f64
Returns: void
Defined at line 239
audio_mixer_set_3d_params
Set the 3D audio parameters.
pub fn audio_mixer_set_3d_params(ref_dist: f64, max_dist: f64, rolloff: f64) -> void {Parameters:
ref_dist:f64max_dist:f64rolloff:f64
Returns: void
Defined at line 246
audio_mixer_stop_group
Stop all sounds in a group.
pub fn audio_mixer_stop_group(group: i64) -> void {Parameters:
group:i64
Returns: void
Defined at line 253
audio_mixer_stop_all
Stop all sounds.
pub fn audio_mixer_stop_all() -> void {Returns: void
Defined at line 260
audio_mixer_pause_all
Pause all sounds.
pub fn audio_mixer_pause_all() -> void {Returns: void
Defined at line 265
audio_mixer_resume_all
Resume all sounds.
pub fn audio_mixer_resume_all() -> void {Returns: void
Defined at line 270
audio_mixer_unload
Unload a sound from the cache.
pub fn audio_mixer_unload(sound_idx: i64) -> void {Parameters:
sound_idx:i64
Returns: void
Defined at line 275
audio_mixer_unload_all
Unload all sounds.
pub fn audio_mixer_unload_all() -> void {Returns: void
Defined at line 288
audio_mixer_sound_count
Get the number of loaded sounds.
pub fn audio_mixer_sound_count() -> i64 {Returns: i64
Defined at line 298
audio_mixer_is_loaded
Check if a sound is loaded.
pub fn audio_mixer_is_loaded(sound_idx: i64) -> bool {Parameters:
sound_idx:i64
Returns: bool
Defined at line 303
audio_mixer_shutdown
Shutdown the audio mixer.
pub fn audio_mixer_shutdown() -> void {Returns: void
Defined at line 311
Generated by scribe, the Fides documentation generator