summaryrefslogtreecommitdiff
path: root/modules/minimp3/doc_classes/AudioStreamMP3.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-12-07 11:36:03 +0100
committerGitHub <noreply@github.com>2020-12-07 11:36:03 +0100
commitd32878bfa81c1f20335c319f7d70095f4e91b284 (patch)
treef019459313b8bec5c567b41fa02cbac3ef10df2b /modules/minimp3/doc_classes/AudioStreamMP3.xml
parent3c9c2cbb2359e6eddf3fab42a89dedfc3a641803 (diff)
parent704d6de84ce110ec5c7eb32c5968b35d6bdcde39 (diff)
Merge pull request #43007 from DeleteSystem32/mp3-support
Add MP3 import and playback support
Diffstat (limited to 'modules/minimp3/doc_classes/AudioStreamMP3.xml')
-rw-r--r--modules/minimp3/doc_classes/AudioStreamMP3.xml26
1 files changed, 26 insertions, 0 deletions
diff --git a/modules/minimp3/doc_classes/AudioStreamMP3.xml b/modules/minimp3/doc_classes/AudioStreamMP3.xml
new file mode 100644
index 0000000000..92e777ca0f
--- /dev/null
+++ b/modules/minimp3/doc_classes/AudioStreamMP3.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="AudioStreamMP3" inherits="AudioStream" version="4.0">
+ <brief_description>
+ MP3 audio stream driver.
+ </brief_description>
+ <description>
+ MP3 audio stream driver.
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ </methods>
+ <members>
+ <member name="data" type="PackedByteArray" setter="set_data" getter="get_data" default="PackedByteArray( )">
+ Contains the audio data in bytes.
+ </member>
+ <member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false">
+ If [code]true[/code], the stream will automatically loop when it reaches the end.
+ </member>
+ <member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset" default="0.0">
+ Time in seconds at which the stream starts after being looped.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>