summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorJuan Linietsky <reduzio@gmail.com>2019-04-27 14:11:39 -0300
committerJuan Linietsky <reduzio@gmail.com>2019-04-27 14:11:39 -0300
commit11fb4ffbf80829df13b091b738d6c5092d589a33 (patch)
treebb92d79bde53d657cf5399c7515f5eb8d3975f39 /doc/classes
parentc2027c82334c680e078dae5deb29f4f8e2d64ca2 (diff)
Added docs to AudioStreamPlayer for get_mix_time
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/AudioServer.xml18
-rw-r--r--doc/classes/AudioStreamPlayer.xml9
-rw-r--r--doc/classes/TranslationServer.xml6
3 files changed, 33 insertions, 0 deletions
diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml
index 83fbd28152..6dc1600cf2 100644
--- a/doc/classes/AudioServer.xml
+++ b/doc/classes/AudioServer.xml
@@ -184,6 +184,12 @@
Returns the sample rate at the output of the audioserver.
</description>
</method>
+ <method name="get_output_latency" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="get_speaker_mode" qualifiers="const">
<return type="int" enum="AudioServer.SpeakerMode">
</return>
@@ -191,6 +197,18 @@
Returns the speaker configuration.
</description>
</method>
+ <method name="get_time_since_last_mix" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_time_to_next_mix" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="is_bus_bypassing_effects" qualifiers="const">
<return type="bool">
</return>
diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml
index c6ec45f15e..07d7c875db 100644
--- a/doc/classes/AudioStreamPlayer.xml
+++ b/doc/classes/AudioStreamPlayer.xml
@@ -10,6 +10,15 @@
<link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
</tutorials>
<methods>
+ <method name="get_mix_time" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ Returns the actual amount of time this stream player was mixing since play() was pressed.
+ To know the exact position this song is mixing right now, add the value to [method AudioServer.get_time_since_last_mix].
+ Also consider substracting [method AudioServer.get_output_latency] to that result.
+ </description>
+ </method>
<method name="get_playback_position">
<return type="float">
</return>
diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml
index a3acc2c659..05774635b8 100644
--- a/doc/classes/TranslationServer.xml
+++ b/doc/classes/TranslationServer.xml
@@ -27,6 +27,12 @@
Clears the server from all translations.
</description>
</method>
+ <method name="get_loaded_locales" qualifiers="const">
+ <return type="Array">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="get_locale" qualifiers="const">
<return type="String">
</return>