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

Methods

voidadd_bus ( int at_position=-1 )
voidadd_bus_effect ( int bus_idx, AudioEffect effect, int at_position=-1 )
Stringcapture_get_device ( )
Arraycapture_get_device_list ( )
voidcapture_set_device ( String name )
AudioBusLayoutgenerate_bus_layout ( ) const
intget_bus_channels ( int bus_idx ) const
AudioEffectget_bus_effect ( int bus_idx, int effect_idx )
intget_bus_effect_count ( int bus_idx )
AudioEffectInstanceget_bus_effect_instance ( int bus_idx, int effect_idx, int channel=0 )
intget_bus_index ( String bus_name ) const
Stringget_bus_name ( int bus_idx ) const
floatget_bus_peak_volume_left_db ( int bus_idx, int channel ) const
floatget_bus_peak_volume_right_db ( int bus_idx, int channel ) const
Stringget_bus_send ( int bus_idx ) const
floatget_bus_volume_db ( int bus_idx ) const
Arrayget_device_list ( )
floatget_mix_rate ( ) const
floatget_output_latency ( ) const
SpeakerModeget_speaker_mode ( ) const
floatget_time_since_last_mix ( ) const
floatget_time_to_next_mix ( ) const
boolis_bus_bypassing_effects ( int bus_idx ) const
boolis_bus_effect_enabled ( int bus_idx, int effect_idx ) const
boolis_bus_mute ( int bus_idx ) const
boolis_bus_solo ( int bus_idx ) const
voidlock ( )
voidmove_bus ( int index, int to_index )
voidremove_bus ( int index )
voidremove_bus_effect ( int bus_idx, int effect_idx )
voidset_bus_bypass_effects ( int bus_idx, bool enable )
voidset_bus_effect_enabled ( int bus_idx, int effect_idx, bool enabled )
voidset_bus_layout ( AudioBusLayout bus_layout )
voidset_bus_mute ( int bus_idx, bool enable )
voidset_bus_name ( int bus_idx, String name )
voidset_bus_send ( int bus_idx, String send )
voidset_bus_solo ( int bus_idx, bool enable )
voidset_bus_volume_db ( int bus_idx, float volume_db )
voidswap_bus_effects ( int bus_idx, int effect_idx, int by_effect_idx )
voidunlock ( )

Signals

  • bus_layout_changed ( )

Emitted when the AudioBusLayout changes.

Enumerations

enum SpeakerMode:

  • SPEAKER_MODE_STEREO = 0 — Two or fewer speakers were detected.
  • SPEAKER_SURROUND_31 = 1 — A 3.1 channel surround setup was detected.
  • SPEAKER_SURROUND_51 = 2 — A 5.1 channel surround setup was detected.
  • SPEAKER_SURROUND_71 = 3 — A 7.1 channel surround setup was detected.

Property Descriptions

Default1
Setterset_bus_count(value)
Getterget_bus_count()

Number of available audio buses.


Default"Default"
Setterset_device(value)
Getterget_device()

Name of the current device for audio output (see get_device_list).


Default1.0
Setterset_global_rate_scale(value)
Getterget_global_rate_scale()

Scales the rate at which audio is played (i.e. setting it to 0.5 will make the audio be played twice as fast).

Method Descriptions

  • void add_bus ( int at_position=-1 )

Adds a bus at at_position.


Adds an AudioEffect effect to the bus bus_idx at at_position.


Name of the current device for audio input (see capture_get_device_list).


  • Array capture_get_device_list ( )

Returns the names of all audio input devices detected on the system.


  • void capture_set_device ( String name )

Sets which audio input device is used for audio capture.


Generates an AudioBusLayout using the available buses and effects.


  • int get_bus_channels ( int bus_idx ) const

Returns the amount of channels of the bus at index bus_idx.


Returns the AudioEffect at position effect_idx in bus bus_idx.


  • int get_bus_effect_count ( int bus_idx )

Returns the number of effects on the bus at bus_idx.


Returns the AudioEffectInstance assigned to the given bus and effect indices (and optionally channel).


Returns the index of the bus with the name bus_name.


Returns the name of the bus with the index bus_idx.


  • float get_bus_peak_volume_left_db ( int bus_idx, int channel ) const

Returns the peak volume of the left speaker at bus index bus_idx and channel index channel.


  • float get_bus_peak_volume_right_db ( int bus_idx, int channel ) const

Returns the peak volume of the right speaker at bus index bus_idx and channel index channel.


Returns the name of the bus that the bus at index bus_idx sends to.


  • float get_bus_volume_db ( int bus_idx ) const

Returns the volume of the bus at index bus_idx in dB.


  • Array get_device_list ( )

Returns the names of all audio devices detected on the system.


  • float get_mix_rate ( ) const

Returns the sample rate at the output of the AudioServer.


  • float get_output_latency ( ) const

Returns the audio driver’s output latency.


Returns the speaker configuration.


  • float get_time_since_last_mix ( ) const

Returns the relative time since the last mix occurred.


  • float get_time_to_next_mix ( ) const

Returns the relative time until the next mix occurs.


  • bool is_bus_bypassing_effects ( int bus_idx ) const

If true, the bus at index bus_idx is bypassing effects.


  • bool is_bus_effect_enabled ( int bus_idx, int effect_idx ) const

If true, the effect at index effect_idx on the bus at index bus_idx is enabled.


  • bool is_bus_mute ( int bus_idx ) const

If true, the bus at index bus_idx is muted.


  • bool is_bus_solo ( int bus_idx ) const

If true, the bus at index bus_idx is in solo mode.


  • void lock ( )

Locks the audio driver’s main loop.

Note: Remember to unlock it afterwards.


  • void move_bus ( int index, int to_index )

Moves the bus from index index to index to_index.


  • void remove_bus ( int index )

Removes the bus at index index.


  • void remove_bus_effect ( int bus_idx, int effect_idx )

Removes the effect at index effect_idx from the bus at index bus_idx.


  • void set_bus_bypass_effects ( int bus_idx, bool enable )

If true, the bus at index bus_idx is bypassing effects.


  • void set_bus_effect_enabled ( int bus_idx, int effect_idx, bool enabled )

If true, the effect at index effect_idx on the bus at index bus_idx is enabled.


Overwrites the currently used AudioBusLayout.


  • void set_bus_mute ( int bus_idx, bool enable )

If true, the bus at index bus_idx is muted.


  • void set_bus_name ( int bus_idx, String name )

Sets the name of the bus at index bus_idx to name.


  • void set_bus_send ( int bus_idx, String send )

Connects the output of the bus at bus_idx to the bus named send.


  • void set_bus_solo ( int bus_idx, bool enable )

If true, the bus at index bus_idx is in solo mode.


  • void set_bus_volume_db ( int bus_idx, float volume_db )

Sets the volume of the bus at index bus_idx to volume_db.


  • void swap_bus_effects ( int bus_idx, int effect_idx, int by_effect_idx )

Swaps the position of two effects in bus bus_idx.


  • void unlock ( )

Unlocks the audio driver’s main loop. (After locking it, you should always unlock it.)

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:29:51. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.