Files
godot-docs/classes/class_audiostreamoggvorbis.rst
2017-12-10 00:45:14 +01:00

69 lines
3.4 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioStreamOGGVorbis.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_AudioStreamOGGVorbis:
AudioStreamOGGVorbis
====================
**Inherits:** :ref:`AudioStream<class_audiostream>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
OGG Vorbis audio stream driver.
Member Functions
----------------
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamOGGVorbis_get_data>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_loop_offset<class_AudioStreamOGGVorbis_get_loop_offset>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamOGGVorbis_has_loop>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_AudioStreamOGGVorbis_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_AudioStreamOGGVorbis_set_loop>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop_offset<class_AudioStreamOGGVorbis_set_loop_offset>` **(** :ref:`float<class_float>` seconds **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
Description
-----------
OGG Vorbis audio stream driver.
Member Function Description
---------------------------
.. _class_AudioStreamOGGVorbis_get_data:
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
.. _class_AudioStreamOGGVorbis_get_loop_offset:
- :ref:`float<class_float>` **get_loop_offset** **(** **)** const
.. _class_AudioStreamOGGVorbis_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
.. _class_AudioStreamOGGVorbis_set_data:
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
.. _class_AudioStreamOGGVorbis_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enable **)**
.. _class_AudioStreamOGGVorbis_set_loop_offset:
- void **set_loop_offset** **(** :ref:`float<class_float>` seconds **)**