summaryrefslogtreecommitdiff
path: root/modules/vorbis/doc_classes
diff options
context:
space:
mode:
authorEllen Poe <ellenhp@google.com>2021-09-09 18:54:18 -0700
committerEllen Poe <ellenhp@google.com>2021-09-09 19:39:04 -0700
commitf5d9c7b487166562a833fc86363d78468d711070 (patch)
tree3893f6fa0efdf3d657726074a8a1486a6f890742 /modules/vorbis/doc_classes
parent0d5e13cd805a1aa69c5f395483051d3501bcfcd3 (diff)
Replace stb_vorbis with libogg+libvorbis
Diffstat (limited to 'modules/vorbis/doc_classes')
-rw-r--r--modules/vorbis/doc_classes/AudioStreamOGGVorbis.xml24
-rw-r--r--modules/vorbis/doc_classes/AudioStreamPlaybackOGGVorbis.xml13
2 files changed, 37 insertions, 0 deletions
diff --git a/modules/vorbis/doc_classes/AudioStreamOGGVorbis.xml b/modules/vorbis/doc_classes/AudioStreamOGGVorbis.xml
new file mode 100644
index 0000000000..a680a2f999
--- /dev/null
+++ b/modules/vorbis/doc_classes/AudioStreamOGGVorbis.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="AudioStreamOGGVorbis" inherits="AudioStream" version="4.0">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ </methods>
+ <members>
+ <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>
+ <member name="packet_sequence" type="OGGPacketSequence" setter="set_packet_sequence" getter="get_packet_sequence">
+ Contains the raw OGG data for this stream.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>
diff --git a/modules/vorbis/doc_classes/AudioStreamPlaybackOGGVorbis.xml b/modules/vorbis/doc_classes/AudioStreamPlaybackOGGVorbis.xml
new file mode 100644
index 0000000000..3120f2a9e6
--- /dev/null
+++ b/modules/vorbis/doc_classes/AudioStreamPlaybackOGGVorbis.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="AudioStreamPlaybackOGGVorbis" inherits="AudioStreamPlaybackResampled" version="4.0">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ </methods>
+ <constants>
+ </constants>
+</class>