mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
85 lines
3.2 KiB
ReStructuredText
85 lines
3.2 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml.
|
|
|
|
.. _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:`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`` |
|
|
+-------------------------------------------+---------------------------------------------------------------------+-----------------------+
|
|
|
|
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() |
|
|
+-----------+-----------------+
|
|
|
|
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.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|