| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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:`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.)`
|
