| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 |
- .. 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 **)** |
- +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- - :ref:`PoolByteArray<class_poolbytearray>` **data** - Raw audio data.
- - :ref:`bool<class_bool>` **loop** - If [code]true[/code], audio will loop continuously. Default value: [code]false[/code].
- - :ref:`float<class_float>` **loop_offset** - If loop is [code]true[/code], loop starts from this position, in 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 **)**
|
