class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS Object AudioServer
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.

 Signal bus_layout_changed<>():Signal

Emitted when an audio bus is added, deleted, or moved.

 Signal bus_renamed<>( int bus_index=, bus_index:int=, StringName old_name=, old_name:StringName=, StringName new_name=, new_name:StringName=, ):Signal

Emitted when the audio bus at bus_index is renamed from old_name to new_name.

 Enum SpeakerMode<>():Enum

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.

 Enum PlaybackType<>():Enum

PLAYBACK_TYPE_DEFAULT = 0

Experimental: This constant may be changed or removed in future versions.


PLAYBACK_TYPE_STREAM = 1

Experimental: This constant may be changed or removed in future versions.


PLAYBACK_TYPE_SAMPLE = 2

Experimental: This constant may be changed or removed in future versions.


PLAYBACK_TYPE_MAX = 3

Experimental: This constant may be changed or removed in future versions.

 int bus_count<>():int

Number of available audio buses.

 String input_device<>():String

Name of the current device for audio input (see 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 "Default" will record audio on the system-wide default audio input. If an invalid device name is set, the value will be reverted back to "Default".

Note: ProjectSettings.audio/driver/enable_input must be true for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.

 String output_device<>():String

Name of the current device for audio output (see 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 "Default" will play audio on the system-wide default audio output. If an invalid device name is set, the value will be reverted back to "Default".

 float playback_speed_scale<>():float

Scales the rate at which audio is played (i.e. setting it to 0.5 will make the audio be played at half its speed). See also Engine.time_scale to affect the general simulation speed, which is independent from playback_speed_scale.

 void add_bus<>( int at_position=-1, at_position:int=-1, ):void

Adds a bus at at_position.

 void add_bus_effect<>( int bus_idx=, bus_idx:int=, AudioEffect effect=, effect:AudioEffect=, int at_position=-1, at_position:int=-1, ):void

Adds an AudioEffect effect to the bus bus_idx at at_position.

 AudioBusLayout generate_bus_layout<>():AudioBusLayout

Generates an AudioBusLayout using the available buses and effects.

 int get_bus_channels<>( int bus_idx=, bus_idx:int=, ):int

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

 AudioEffect get_bus_effect<>( int bus_idx=, bus_idx:int=, int effect_idx=, effect_idx:int=, ):AudioEffect

Returns the AudioEffect at position effect_idx in bus bus_idx.

 int get_bus_effect_count<>( int bus_idx=, bus_idx:int=, ):int

Returns the number of effects on the bus at bus_idx.

 AudioEffectInstance get_bus_effect_instance<>( int bus_idx=, bus_idx:int=, int effect_idx=, effect_idx:int=, int channel=0, channel:int=0, ):AudioEffectInstance

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

 int get_bus_index<>( StringName bus_name=, bus_name:StringName=, ):int

Returns the index of the bus with the name bus_name. Returns -1 if no bus with the specified name exist.

 String get_bus_name<>( int bus_idx=, bus_idx:int=, ):String

Returns the name of the bus with the index bus_idx.

 float get_bus_peak_volume_left_db<>( int bus_idx=, bus_idx:int=, int channel=, channel:int=, ):float

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=, bus_idx:int=, int channel=, channel:int=, ):float

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

 StringName get_bus_send<>( int bus_idx=, bus_idx:int=, ):StringName

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

 float get_bus_volume_db<>( int bus_idx=, bus_idx:int=, ):float

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

 float get_bus_volume_linear<>( int bus_idx=, bus_idx:int=, ):float

Returns the volume of the bus at index bus_idx as a linear value.

Note: The returned value is equivalent to the result of @GlobalScope.db_to_linear() on the result of get_bus_volume_db().

 String get_driver_name<>():String

Returns the name of the current audio driver. The default usually depends on the operating system, but may be overridden via the --audio-driver command line argument. --headless also automatically sets the audio driver to Dummy. See also ProjectSettings.audio/driver/driver.

 PackedStringArray get_input_device_list<>():PackedStringArray

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

Note: ProjectSettings.audio/driver/enable_input must be true for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.

 float get_input_mix_rate<>():float

Returns the sample rate at the input of the AudioServer.

 float get_mix_rate<>():float

Returns the sample rate at the output of the AudioServer.

 PackedStringArray get_output_device_list<>():PackedStringArray

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

 float get_output_latency<>():float

Returns the audio driver's effective output latency. This is based on ProjectSettings.audio/driver/output_latency, but the exact returned value will differ depending on the operating system and audio driver.

Note: This can be expensive; it is not recommended to call get_output_latency() every frame.

 SpeakerMode get_speaker_mode<>():SpeakerMode

Returns the speaker configuration.

 float get_time_since_last_mix<>():float

Returns the relative time since the last mix occurred.

 float get_time_to_next_mix<>():float

Returns the relative time until the next mix occurs.

 bool is_bus_bypassing_effects<>( int bus_idx=, bus_idx:int=, ):bool

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

 bool is_bus_effect_enabled<>( int bus_idx=, bus_idx:int=, int effect_idx=, effect_idx:int=, ):bool

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

 bool is_bus_mute<>( int bus_idx=, bus_idx:int=, ):bool

If true, the bus at index bus_idx is muted.

 bool is_bus_solo<>( int bus_idx=, bus_idx:int=, ):bool

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

 bool is_stream_registered_as_sample<>( AudioStream stream=, stream:AudioStream=, ):bool

Experimental: This method may be changed or removed in future versions.

If true, the stream is registered as a sample. The engine will not have to register it before playing the sample.

If false, the stream will have to be registered before playing it. To prevent lag spikes, register the stream as sample with register_stream_as_sample().

 void lock<>():void

Locks the audio driver's main loop.

Note: Remember to unlock it afterwards.

 void move_bus<>( int index=, index:int=, int to_index=, to_index:int=, ):void

Moves the bus from index index to index to_index.

 void register_stream_as_sample<>( AudioStream stream=, stream:AudioStream=, ):void

Experimental: This method may be changed or removed in future versions.

Forces the registration of a stream as a sample.

Note: Lag spikes may occur when calling this method, especially on single-threaded builds. It is suggested to call this method while loading assets, where the lag spike could be masked, instead of registering the sample right before it needs to be played.

 void remove_bus<>( int index=, index:int=, ):void

Removes the bus at index index.

 void remove_bus_effect<>( int bus_idx=, bus_idx:int=, int effect_idx=, effect_idx:int=, ):void

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

 void set_bus_bypass_effects<>( int bus_idx=, bus_idx:int=, bool enable=, enable:bool=, ):void

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

 void set_bus_effect_enabled<>( int bus_idx=, bus_idx:int=, int effect_idx=, effect_idx:int=, bool enabled=, enabled:bool=, ):void

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

 void set_bus_layout<>( AudioBusLayout bus_layout=, bus_layout:AudioBusLayout=, ):void

Overwrites the currently used AudioBusLayout.

 void set_bus_mute<>( int bus_idx=, bus_idx:int=, bool enable=, enable:bool=, ):void

If true, the bus at index bus_idx is muted.

 void set_bus_name<>( int bus_idx=, bus_idx:int=, String name=, name:String=, ):void

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

 void set_bus_send<>( int bus_idx=, bus_idx:int=, StringName send=, send:StringName=, ):void

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

 void set_bus_solo<>( int bus_idx=, bus_idx:int=, bool enable=, enable:bool=, ):void

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

 void set_bus_volume_db<>( int bus_idx=, bus_idx:int=, float volume_db=, volume_db:float=, ):void

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

 void set_bus_volume_linear<>( int bus_idx=, bus_idx:int=, float volume_linear=, volume_linear:float=, ):void

Sets the volume as a linear value of the bus at index bus_idx to volume_linear.

Note: Using this method is equivalent to calling set_bus_volume_db() with the result of @GlobalScope.linear_to_db() on a value.

 void set_enable_tagging_used_audio_streams<>( bool enable=, enable:bool=, ):void

If set to true, all instances of AudioStreamPlayback will call AudioStreamPlayback._tag_used_streams() every mix step.

Note: This is enabled by default in the editor, as it is used by editor plugins for the audio stream previews.

 void swap_bus_effects<>( int bus_idx=, bus_idx:int=, int effect_idx=, effect_idx:int=, int by_effect_idx=, by_effect_idx:int=, ):void

Swaps the position of two effects in bus bus_idx.

 void unlock<>():void

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


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...