diff options
| author | Ellen Poe <ellenhp@google.com> | 2021-09-09 18:54:18 -0700 |
|---|---|---|
| committer | Ellen Poe <ellenhp@google.com> | 2021-09-09 19:39:04 -0700 |
| commit | f5d9c7b487166562a833fc86363d78468d711070 (patch) | |
| tree | 3893f6fa0efdf3d657726074a8a1486a6f890742 /modules/ogg/doc_classes | |
| parent | 0d5e13cd805a1aa69c5f395483051d3501bcfcd3 (diff) | |
Replace stb_vorbis with libogg+libvorbis
Diffstat (limited to 'modules/ogg/doc_classes')
| -rw-r--r-- | modules/ogg/doc_classes/OGGPacketSequence.xml | 32 | ||||
| -rw-r--r-- | modules/ogg/doc_classes/OGGPacketSequencePlayback.xml | 13 |
2 files changed, 45 insertions, 0 deletions
diff --git a/modules/ogg/doc_classes/OGGPacketSequence.xml b/modules/ogg/doc_classes/OGGPacketSequence.xml new file mode 100644 index 0000000000..9d3789cb07 --- /dev/null +++ b/modules/ogg/doc_classes/OGGPacketSequence.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OGGPacketSequence" inherits="Resource" version="4.0"> + <brief_description> + A sequence of OGG packets. + </brief_description> + <description> + A sequence of OGG packets. + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_length" qualifiers="const"> + <return type="float" /> + <description> + The length of this stream, in seconds. + </description> + </method> + </methods> + <members> + <member name="granule_positions" type="Array" setter="set_packet_granule_positions" getter="get_packet_granule_positions" default="[]"> + Contains the granule positions for each page in this packet sequence. + </member> + <member name="packet_data" type="Array" setter="set_packet_data" getter="get_packet_data" default="[]"> + Contains the raw packets that make up this OGGPacketSequence. + </member> + <member name="sampling_rate" type="float" setter="set_sampling_rate" getter="get_sampling_rate" default="0.0"> + Holds sample rate information about this sequence. Must be set by another class that actually understands the codec. + </member> + </members> + <constants> + </constants> +</class> diff --git a/modules/ogg/doc_classes/OGGPacketSequencePlayback.xml b/modules/ogg/doc_classes/OGGPacketSequencePlayback.xml new file mode 100644 index 0000000000..49e32f0d6e --- /dev/null +++ b/modules/ogg/doc_classes/OGGPacketSequencePlayback.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OGGPacketSequencePlayback" inherits="RefCounted" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> |