Documentation Index
Fetch the complete documentation index at: https://mintlify.com/godotengine/godot/llms.txt
Use this file to discover all available pages before exploring further.
AudioServer
Inherits: Object
Description
Server interface for low-level audio access. AudioServer is in charge of creating sample data (playable audio) as well as its playback via a voice interface.
Methods
add_bus
void add_bus(at_position: int = -1)
add_bus_effect
void add_bus_effect(bus_idx: int, effect: AudioEffect, at_position: int = -1)
get_bus_name
String get_bus_name(bus_idx: int)
get_bus_volume_db
float get_bus_volume_db(bus_idx: int)
set_bus_volume_db
void set_bus_volume_db(bus_idx: int, volume_db: float)
get_mix_rate
Returns the sample rate at the output of the AudioServer.
get_output_latency
float get_output_latency()
Example Usage
# Get the master bus volume
var master_idx = AudioServer.get_bus_index("Master")
var volume = AudioServer.get_bus_volume_db(master_idx)
print("Master volume: ", volume, " dB")
# Set music bus volume
var music_idx = AudioServer.get_bus_index("Music")
AudioServer.set_bus_volume_db(music_idx, -10.0)
# Add a reverb effect
var reverb = AudioEffectReverb.new()
AudioServer.add_bus_effect(master_idx, reverb)
// Get the master bus volume
int masterIdx = AudioServer.GetBusIndex("Master");
float volume = AudioServer.GetBusVolumeDb(masterIdx);
GD.Print("Master volume: ", volume, " dB");
// Set music bus volume
int musicIdx = AudioServer.GetBusIndex("Music");
AudioServer.SetBusVolumeDb(musicIdx, -10.0f);
