mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
131 lines
4.7 KiB
ReStructuredText
131 lines
4.7 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.0/modules/ogg/doc_classes/OggPacketSequence.xml.
|
|
|
|
.. _class_OggPacketSequence:
|
|
|
|
OggPacketSequence
|
|
=================
|
|
|
|
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A sequence of Ogg packets.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
A sequence of Ogg packets.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------------------+------------------------------------------------------------------------------+------------------------+
|
|
| :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`granule_positions<class_OggPacketSequence_property_granule_positions>` | ``PackedInt64Array()`` |
|
|
+-------------------------------------------------+------------------------------------------------------------------------------+------------------------+
|
|
| :ref:`Array[]<class_Array>` | :ref:`packet_data<class_OggPacketSequence_property_packet_data>` | ``[]`` |
|
|
+-------------------------------------------------+------------------------------------------------------------------------------+------------------------+
|
|
| :ref:`float<class_float>` | :ref:`sampling_rate<class_OggPacketSequence_property_sampling_rate>` | ``0.0`` |
|
|
+-------------------------------------------------+------------------------------------------------------------------------------+------------------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------+----------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_length<class_OggPacketSequence_method_get_length>` **(** **)** |const| |
|
|
+---------------------------+----------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_OggPacketSequence_property_granule_positions:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`PackedInt64Array<class_PackedInt64Array>` **granule_positions** = ``PackedInt64Array()``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_packet_granule_positions** **(** :ref:`PackedInt64Array<class_PackedInt64Array>` value **)**
|
|
- :ref:`PackedInt64Array<class_PackedInt64Array>` **get_packet_granule_positions** **(** **)**
|
|
|
|
Contains the granule positions for each page in this packet sequence.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_OggPacketSequence_property_packet_data:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Array[]<class_Array>` **packet_data** = ``[]``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_packet_data** **(** :ref:`Array[]<class_Array>` value **)**
|
|
- :ref:`Array[]<class_Array>` **get_packet_data** **(** **)**
|
|
|
|
Contains the raw packets that make up this OggPacketSequence.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_OggPacketSequence_property_sampling_rate:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **sampling_rate** = ``0.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_sampling_rate** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_sampling_rate** **(** **)**
|
|
|
|
Holds sample rate information about this sequence. Must be set by another class that actually understands the codec.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_OggPacketSequence_method_get_length:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`float<class_float>` **get_length** **(** **)** |const|
|
|
|
|
The length of this stream, in seconds.
|
|
|
|
.. |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.)`
|