diff options
Diffstat (limited to 'doc/classes/AudioServer.xml')
| -rw-r--r-- | doc/classes/AudioServer.xml | 32 |
1 files changed, 29 insertions, 3 deletions
diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 6dc1600cf2..f063cfe5ce 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioServer" inherits="Object" category="Core" version="3.2"> <brief_description> - Server interface for low level audio access. + Server interface for low-level audio access. </brief_description> <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. + 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. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link> @@ -177,6 +177,13 @@ <description> </description> </method> + <method name="get_global_rate_scale"> + <return type="float"> + </return> + <description> + Returns the global rate scale at which audio is being played. + </description> + </method> <method name="get_mix_rate" qualifiers="const"> <return type="float"> </return> @@ -390,6 +397,15 @@ <description> </description> </method> + <method name="set_global_rate_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="float"> + </argument> + <description> + 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). + </description> + </method> <method name="swap_bus_effects"> <return type="void"> </return> @@ -407,10 +423,20 @@ <return type="void"> </return> <description> - Unlocks the audiodriver's main loop. After locking it always unlock it. + Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) </description> </method> </methods> + <members> + <member name="bus_count" type="int" setter="set_bus_count" getter="get_bus_count"> + Adds and removes buses to make the number of buses match [code]amount[/code]. + </member> + <member name="device" type="string" setter="set_device" getter="get_device"> + </member> + <member name="global_rate_scale" type="float" setter="set_global_rate_scale" getter="get_global_rate_scale"> + 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). + </member> + </members> <signals> <signal name="bus_layout_changed"> <description> |