Up to date
This page is up to date for Godot 4.2
.
If you still find outdated information, please open an issue.
AudioServer¶
Inherits: Object
Server interface for low-level audio access.
Description¶
AudioServer is a low-level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface.
Tutorials¶
Properties¶
|
||
|
||
|
||
|
Methods¶
void |
|
void |
add_bus_effect ( int bus_idx, AudioEffect effect, int at_position=-1 ) |
generate_bus_layout ( ) const |
|
get_bus_channels ( int bus_idx ) const |
|
get_bus_effect ( int bus_idx, int effect_idx ) |
|
get_bus_effect_count ( int bus_idx ) |
|
get_bus_effect_instance ( int bus_idx, int effect_idx, int channel=0 ) |
|
get_bus_index ( StringName bus_name ) const |
|
get_bus_name ( int bus_idx ) const |
|
get_bus_peak_volume_left_db ( int bus_idx, int channel ) const |
|
get_bus_peak_volume_right_db ( int bus_idx, int channel ) const |
|
get_bus_send ( int bus_idx ) const |
|
get_bus_volume_db ( int bus_idx ) const |
|
get_mix_rate ( ) const |
|
get_output_latency ( ) const |
|
get_speaker_mode ( ) const |
|
get_time_since_last_mix ( ) const |
|
get_time_to_next_mix ( ) const |
|
is_bus_bypassing_effects ( int bus_idx ) const |
|
is_bus_effect_enabled ( int bus_idx, int effect_idx ) const |
|
is_bus_mute ( int bus_idx ) const |
|
is_bus_solo ( int bus_idx ) const |
|
void |
lock ( ) |
void |
|
void |
remove_bus ( int index ) |
void |
remove_bus_effect ( int bus_idx, int effect_idx ) |
void |
set_bus_bypass_effects ( int bus_idx, bool enable ) |
void |
set_bus_effect_enabled ( int bus_idx, int effect_idx, bool enabled ) |
void |
set_bus_layout ( AudioBusLayout bus_layout ) |
void |
set_bus_mute ( int bus_idx, bool enable ) |
void |
set_bus_name ( int bus_idx, String name ) |
void |
set_bus_send ( int bus_idx, StringName send ) |
void |
set_bus_solo ( int bus_idx, bool enable ) |
void |
set_bus_volume_db ( int bus_idx, float volume_db ) |
void |
set_enable_tagging_used_audio_streams ( bool enable ) |
void |
swap_bus_effects ( int bus_idx, int effect_idx, int by_effect_idx ) |
void |
unlock ( ) |
Signals¶
bus_layout_changed ( )
Emitted when an audio bus is added, deleted, or moved.
bus_renamed ( int bus_index, StringName old_name, StringName new_name )
Emitted when the audio bus at bus_index
is renamed from old_name
to new_name
.
Enumerations¶
enum SpeakerMode:
SpeakerMode SPEAKER_MODE_STEREO = 0
Two or fewer speakers were detected.
SpeakerMode SPEAKER_SURROUND_31 = 1
A 3.1 channel surround setup was detected.
SpeakerMode SPEAKER_SURROUND_51 = 2
A 5.1 channel surround setup was detected.
SpeakerMode SPEAKER_SURROUND_71 = 3
A 7.1 channel surround setup was detected.
Property Descriptions¶
int bus_count = 1
Number of available audio buses.