mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
80 lines
3.4 KiB
ReStructuredText
80 lines
3.4 KiB
ReStructuredText
: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:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+-----------+
|
|
| :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`` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+-----------+
|
|
| :ref:`OGGPacketSequence<class_OGGPacketSequence>` | :ref:`packet_sequence<class_AudioStreamOGGVorbis_property_packet_sequence>` | |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+-----------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _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.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamOGGVorbis_property_packet_sequence:
|
|
|
|
- :ref:`OGGPacketSequence<class_OGGPacketSequence>` **packet_sequence**
|
|
|
|
+----------+----------------------------+
|
|
| *Setter* | set_packet_sequence(value) |
|
|
+----------+----------------------------+
|
|
| *Getter* | get_packet_sequence() |
|
|
+----------+----------------------------+
|
|
|
|
Contains the raw OGG data for this stream.
|
|
|
|
.. |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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|