summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-07-01 13:53:04 +0200
committerGitHub <noreply@github.com>2019-07-01 13:53:04 +0200
commit380bf04566f21d9da9c8894f9ea8c03001daae0f (patch)
tree6f2a4b9102f9b2a4e37f6ec3fbdec6562e2ad830 /doc
parent771aa9a779ab9d8effde70f8338a476e53c8e6d3 (diff)
parent1c2ba35074b226d93f3b6c71cc3b94e7fc6e2e4e (diff)
Merge pull request #29413 from YeldhamDev/global_rate_scale
Add 'global_rate_scale' to the AudioServer
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/AudioServer.xml26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml
index dec1de42bc..f063cfe5ce 100644
--- a/doc/classes/AudioServer.xml
+++ b/doc/classes/AudioServer.xml
@@ -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>
@@ -411,6 +427,16 @@
</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>