mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
81 lines
2.8 KiB
ReStructuredText
81 lines
2.8 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>`
|
|
|
|
OGG Vorbis audio stream driver.
|
|
|
|
Description
|
|
-----------
|
|
|
|
OGG Vorbis audio stream driver.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------------------+---------------------------------------------------------------------+-------------------------+
|
|
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` | ``PackedByteArray( )`` |
|
|
+-----------------------------------------------+---------------------------------------------------------------------+-------------------------+
|
|
| :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`` |
|
|
+-----------------------------------------------+---------------------------------------------------------------------+-------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AudioStreamOGGVorbis_property_data:
|
|
|
|
- :ref:`PackedByteArray<class_PackedByteArray>` **data**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``PackedByteArray( )`` |
|
|
+-----------+-------------------------+
|
|
| *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() |
|
|
+-----------+-----------------+
|
|
|
|
If ``true``, the stream will automatically loop when it reaches the end.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamOGGVorbis_property_loop_offset:
|
|
|
|
- :ref:`float<class_float>` **loop_offset**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_loop_offset(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_loop_offset() |
|
|
+-----------+------------------------+
|
|
|
|
Time in seconds at which the stream starts after being looped.
|
|
|