godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added docs to AudioStreamPlayer for get_mix_time

This commit is contained in:
Juan Linietsky 2019-04-27 14:11:39 -03:00
parent c2027c8233
commit 11fb4ffbf8
3 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/classes/AudioServer.xml
View File

@ -184,6 +184,12 @@
Returns the sample rate at the output of the audioserver. Returns the sample rate at the output of the audioserver.
</description> </description>
</method> </method>
<method name="get_output_latency" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_speaker_mode" qualifiers="const"> <method name="get_speaker_mode" qualifiers="const">
<return type="int" enum="AudioServer.SpeakerMode"> <return type="int" enum="AudioServer.SpeakerMode">
</return> </return>
@ -191,6 +197,18 @@
Returns the speaker configuration. Returns the speaker configuration.
</description> </description>
</method> </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"> <method name="is_bus_bypassing_effects" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>

9
doc/classes/AudioStreamPlayer.xml
View File

@ -10,6 +10,15 @@
<link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
</tutorials> </tutorials>
<methods> <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"> <method name="get_playback_position">
<return type="float"> <return type="float">
</return> </return>

6
doc/classes/TranslationServer.xml
View File

@ -27,6 +27,12 @@
Clears the server from all translations. Clears the server from all translations.
</description> </description>
</method> </method>
<method name="get_loaded_locales" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_locale" qualifiers="const"> <method name="get_locale" qualifiers="const">
<return type="String"> <return type="String">
</return> </return>