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.html 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 [param at_position].
Adds an [AudioEffect] effect to the bus [param bus_idx] at [param at_position].
Generates an [AudioBusLayout] using the available buses and effects.
Returns the number of channels of the bus at index [param bus_idx].
Returns the [AudioEffect] at position [param effect_idx] in bus [param bus_idx].
Returns the number of effects on the bus at [param 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 [param bus_name]. Returns [code]-1[/code] if no bus with the specified name exist.
Returns the name of the bus with the index [param bus_idx].
Returns the peak volume of the left speaker at bus index [param bus_idx] and channel index [param channel].
Returns the peak volume of the right speaker at bus index [param bus_idx] and channel index [param channel].
Returns the name of the bus that the bus at index [param bus_idx] sends to.
Returns the volume of the bus at index [param bus_idx] in dB.
Returns the names of all audio input devices detected on the system. [b]Note:[/b] [member ProjectSettings.audio/driver/enable_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.
Returns the sample rate at the output of the [AudioServer].
Returns the names of all audio output devices detected on the system.
Returns the audio driver's effective output latency. This is based on [member ProjectSettings.audio/driver/output_latency], but the exact returned value will differ depending on the operating system and audio driver. [b]Note:[/b] This can be expensive; it is not recommended to call [method get_output_latency] 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 [param bus_idx] is bypassing effects.
If [code]true[/code], the effect at index [param effect_idx] on the bus at index [param bus_idx] is enabled.
If [code]true[/code], the bus at index [param bus_idx] is muted.
If [code]true[/code], the bus at index [param bus_idx] is in solo mode.
Locks the audio driver's main loop. [b]Note:[/b] Remember to unlock it afterwards.
Moves the bus from index [param index] to index [param to_index].
Removes the bus at index [param index].
Removes the effect at index [param effect_idx] from the bus at index [param bus_idx].
If [code]true[/code], the bus at index [param bus_idx] is bypassing effects.
If [code]true[/code], the effect at index [param effect_idx] on the bus at index [param bus_idx] is enabled.
Overwrites the currently used [AudioBusLayout].
If [code]true[/code], the bus at index [param bus_idx] is muted.
Sets the name of the bus at index [param bus_idx] to [param name].
Connects the output of the bus at [param bus_idx] to the bus named [param send].
If [code]true[/code], the bus at index [param bus_idx] is in solo mode.
Sets the volume of the bus at index [param bus_idx] to [param volume_db].
Swaps the position of two effects in bus [param bus_idx].
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 get_input_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/driver/enable_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_output_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 at half its speed).
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.