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

Merge pull request #92674 from timothyqiu/playlist-doc

Browse Source 
Improve `AudioStreamPlaylist` class reference
This commit is contained in:
Rémi Verschelde 2024-06-03 10:36:06 +02:00
commit 3f39d97042
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
modules/interactive_music/doc_classes/AudioStreamPlaylist.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlaylist" inherits="AudioStream" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <class name="AudioStreamPlaylist" inherits="AudioStream" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description> <brief_description>
[AudioStream] that includes sub-streams and plays them back like a playslit. [AudioStream] that includes sub-streams and plays them back like a playlist.
</brief_description> </brief_description>
<description> <description>
</description> </description>
@ -11,14 +11,14 @@
<method name="get_bpm" qualifiers="const"> <method name="get_bpm" qualifiers="const">
<return type="float" /> <return type="float" />
<description> <description>
Return the bpm of the playlist, which can vary depending on the clip being played. Returns the BPM of the playlist, which can vary depending on the clip being played.
</description> </description>
</method> </method>
<method name="get_list_stream" qualifiers="const"> <method name="get_list_stream" qualifiers="const">
<return type="AudioStream" /> <return type="AudioStream" />
<param index="0" name="stream_index" type="int" /> <param index="0" name="stream_index" type="int" />
<description> <description>
Get the stream at playback position index. Returns the stream at playback position index.
</description> </description>
</method> </method>
<method name="set_list_stream"> <method name="set_list_stream">
@ -26,7 +26,7 @@
<param index="0" name="stream_index" type="int" /> <param index="0" name="stream_index" type="int" />
<param index="1" name="audio_stream" type="AudioStream" /> <param index="1" name="audio_stream" type="AudioStream" />
<description> <description>
Set the stream at playback position index. Sets the stream at playback position index.
</description> </description>
</method> </method>
</methods> </methods>
@ -35,10 +35,10 @@
Fade time used when a stream ends, when going to the next one. Streams are expected to have an extra bit of audio after the end to help with fading. Fade time used when a stream ends, when going to the next one. Streams are expected to have an extra bit of audio after the end to help with fading.
</member> </member>
<member name="loop" type="bool" setter="set_loop" getter="has_loop" default="true"> <member name="loop" type="bool" setter="set_loop" getter="has_loop" default="true">
If true, the playlist will loop, otherwise the playlist when end when the last stream is played. If [code]true[/code], the playlist will loop, otherwise the playlist will end when the last stream is finished.
</member> </member>
<member name="shuffle" type="bool" setter="set_shuffle" getter="get_shuffle" default="false"> <member name="shuffle" type="bool" setter="set_shuffle" getter="get_shuffle" default="false">
Shuffle the playlist. Streams are played in random order. If [code]true[/code], the playlist will shuffle each time playback starts and each time it loops.
</member> </member>
<member name="stream_count" type="int" setter="set_stream_count" getter="get_stream_count" default="0"> <member name="stream_count" type="int" setter="set_stream_count" getter="get_stream_count" default="0">
Amount of streams in the playlist. Amount of streams in the playlist.