Files
godot-docs/classes/class_audiostreamoggvorbis.rst
2019-10-29 12:48:46 +01:00

82 lines
2.7 KiB
ReStructuredText

:github_url: hide
.. 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.
Properties
----------
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` | PoolByteArray( ) |
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
| :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_property_loop>` | false |
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
| :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_property_loop_offset>` | 0.0 |
+-------------------------------------------+---------------------------------------------------------------------+-------------------+
Description
-----------
OGG Vorbis audio stream driver.
Property Descriptions
---------------------
.. _class_AudioStreamOGGVorbis_property_data:
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
+-----------+-------------------+
| *Default* | PoolByteArray( ) |
+-----------+-------------------+
| *Setter* | set_data(value) |
+-----------+-------------------+
| *Getter* | get_data() |
+-----------+-------------------+
Contains the audio data in bytes.
----
.. _class_AudioStreamOGGVorbis_property_loop:
- :ref:`bool<class_bool>` **loop**
+-----------+-----------------+
| *Default* | false |
+-----------+-----------------+
| *Setter* | set_loop(value) |
+-----------+-----------------+
| *Getter* | has_loop() |
+-----------+-----------------+
----
.. _class_AudioStreamOGGVorbis_property_loop_offset:
- :ref:`float<class_float>` **loop_offset**
+-----------+------------------------+
| *Default* | 0.0 |
+-----------+------------------------+
| *Setter* | set_loop_offset(value) |
+-----------+------------------------+
| *Getter* | get_loop_offset() |
+-----------+------------------------+