Server interface for low-level audio access.
[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.
$DOCS_URL/tutorials/audio/audio_buses.md https://godotengine.org/asset-library/asset/525 https://godotengine.org/asset-library/asset/527 https://godotengine.org/asset-library/asset/528
Adds a bus at [code]at_position[/code].
Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code].
Returns the names of all audio input devices detected on the system. [b]Note:[/b] [member ProjectSettings.audio/enable_audio_input] must be [code]true[/code] for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.
Generates an [AudioBusLayout] using the available buses and effects.
Returns the amount of channels of the bus at index [code]bus_idx[/code].
Returns the [AudioEffect] at position [code]effect_idx[/code] in bus [code]bus_idx[/code].
Returns the number of effects on the bus at [code]bus_idx[/code].
Returns the [AudioEffectInstance] assigned to the given bus and effect indices (and optionally channel).
Returns the name of the bus with the index [code]bus_idx[/code].
Returns the peak volume of the left speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code].
Returns the peak volume of the right speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code].
Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to.
Returns the volume of the bus at index [code]bus_idx[/code] in dB.
Returns the names of all audio devices detected on the system.
Returns the sample rate at the output of the [AudioServer].
Returns the audio driver's output latency. This can be expensive, it is not recommended to call this every frame.
Returns the speaker configuration.
Returns the relative time since the last mix occurred.
Returns the relative time until the next mix occurs.
If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects.
If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled.
If [code]true[/code], the bus at index [code]bus_idx[/code] is muted.
If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode.
If [code]false[/code], the audio server is disabled / muted.
Locks the audio driver's main loop. [b]Note:[/b] Remember to unlock it afterwards.
Moves the bus from index [code]index[/code] to index [code]to_index[/code].
Removes the bus at index [code]index[/code].
Removes the effect at index [code]effect_idx[/code] from the bus at index [code]bus_idx[/code].
If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects.
If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled.
Overwrites the currently used [AudioBusLayout].
If [code]true[/code], the bus at index [code]bus_idx[/code] is muted.
Sets the name of the bus at index [code]bus_idx[/code] to [code]name[/code].
If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode.
Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code].
Allows disabling / muting the audio server. As well as muting, this will minimize audio CPU usage.
Swaps the position of two effects in bus [code]bus_idx[/code].
Unlocks the audio driver's main loop. (After locking it, you should always unlock it.)
- Number of available audio buses.
- Name of the current device for audio input (see [method capture_get_device_list]). On systems with multiple audio inputs (such as analog, USB and HDMI audio), this can be used to select the audio input device. The value [code]"Default"[/code] will record audio on the system-wide default audio input. If an invalid device name is set, the value will be reverted back to [code]"Default"[/code]. [b]Note:[/b] [member ProjectSettings.audio/enable_audio_input] must be [code]true[/code] for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.
- Name of the current device for audio output (see [method get_device_list]). On systems with multiple audio outputs (such as analog, USB and HDMI audio), this can be used to select the audio output device. The value [code]"Default"[/code] will play audio on the system-wide default audio output. If an invalid device name is set, the value will be reverted back to [code]"Default"[/code].
- Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast).
Emitted when the [AudioBusLayout] changes.
Two or fewer speakers were detected.
A 3.1 channel surround setup was detected.
A 5.1 channel surround setup was detected.
A 7.1 channel surround setup was detected.