AudioServer Class |
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.
Inheritance HierarchyNamespace: Godot
Assembly: GodotSharp (in GodotSharp.dll) Version: 1.0.0
Syntaxpublic static class AudioServer
The AudioServer type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | BusCount | Number of available audio buses. |
| Device | Name of the current device for audio output (see GetDeviceList). |
| GlobalRateScale | Scales the rate at which audio is played (i.e. setting it to 0.5 will make the audio be played twice as fast). |
| Singleton |
Methods| Name | Description | |
|---|---|---|
 | AddBus | Adds a bus at at_position. |
| AddBusEffect | Adds an AudioEffect effect to the bus bus_idx at at_position. |
| CaptureGetDevice | Name of the current device for audio input (see CaptureGetDeviceList). |
| CaptureGetDeviceList | Returns the names of all audio input devices detected on the system. |
| CaptureSetDevice | Sets which audio input device is used for audio capture. |
| GenerateBusLayout | Generates an AudioBusLayout using the available buses and effects. |
| GetBusChannels | Returns the amount of channels of the bus at index bus_idx. |
| GetBusCount | Obsolete. |
| GetBusEffect | Returns the AudioEffect at position effect_idx in bus bus_idx. |
| GetBusEffectCount | Returns the number of effects on the bus at bus_idx. |
| GetBusEffectInstance | Returns the AudioEffectInstance assigned to the given bus and effect indices (and optionally channel). |
| GetBusIndex | Returns the index of the bus with the name bus_name. |
| GetBusName | Returns the name of the bus with the index bus_idx. |
| GetBusPeakVolumeLeftDb | Returns the peak volume of the left speaker at bus index bus_idx and channel index channel. |
| GetBusPeakVolumeRightDb | Returns the peak volume of the right speaker at bus index bus_idx and channel index channel. |
| GetBusSend | Returns the name of the bus that the bus at index bus_idx sends to. |
| GetBusVolumeDb | Returns the volume of the bus at index bus_idx in dB. |
| GetDevice | Obsolete. |
| GetDeviceList | Returns the names of all audio devices detected on the system. |
| GetGlobalRateScale | Obsolete. |
| GetMixRate | Returns the sample rate at the output of the AudioServer. |
| GetOutputLatency | Returns the audio driver's output latency. |
| GetSpeakerMode | Returns the speaker configuration. |
| GetTimeSinceLastMix | Returns the relative time since the last mix occurred. |
| GetTimeToNextMix | Returns the relative time until the next mix occurs. |
| IsBusBypassingEffects | If true, the bus at index bus_idx is bypassing effects. |
| IsBusEffectEnabled | If true, the effect at index effect_idx on the bus at index bus_idx is enabled. |
| IsBusMute | If true, the bus at index bus_idx is muted. |
| IsBusSolo | If true, the bus at index bus_idx is in solo mode. |
| Lock | Locks the audio driver's main loop. Note: Remember to unlock it afterwards. |
| MoveBus | Moves the bus from index index to index to_index. |
| RemoveBus | Removes the bus at index index. |
| RemoveBusEffect | Removes the effect at index effect_idx from the bus at index bus_idx. |
| SetBusBypassEffects | If true, the bus at index bus_idx is bypassing effects. |
| SetBusCount | Obsolete. |
| SetBusEffectEnabled | If true, the effect at index effect_idx on the bus at index bus_idx is enabled. |
| SetBusLayout | Overwrites the currently used AudioBusLayout. |
| SetBusMute | If true, the bus at index bus_idx is muted. |
| SetBusName | Sets the name of the bus at index bus_idx to name. |
| SetBusSend | Connects the output of the bus at bus_idx to the bus named send. |
| SetBusSolo | If true, the bus at index bus_idx is in solo mode. |
| SetBusVolumeDb | Sets the volume of the bus at index bus_idx to volume_db. |
| SetDevice | Obsolete. |
| SetGlobalRateScale | Obsolete. |
| SwapBusEffects | Swaps the position of two effects in bus bus_idx. |
| Unlock | Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) |
See Also