| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the OGGPacketSequence.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_OGGPacketSequence:
- OGGPacketSequence
- =================
- **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- A sequence of OGG packets.
- Description
- -----------
- A sequence of OGG packets.
- Properties
- ----------
- +---------------------------+------------------------------------------------------------------------------+---------+
- | :ref:`Array<class_Array>` | :ref:`granule_positions<class_OGGPacketSequence_property_granule_positions>` | ``[]`` |
- +---------------------------+------------------------------------------------------------------------------+---------+
- | :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`` |
- +---------------------------+------------------------------------------------------------------------------+---------+
- Methods
- -------
- +---------------------------+----------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_length<class_OGGPacketSequence_method_get_length>` **(** **)** |const| |
- +---------------------------+----------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_OGGPacketSequence_property_granule_positions:
- - :ref:`Array<class_Array>` **granule_positions**
- +-----------+-------------------------------------+
- | *Default* | ``[]`` |
- +-----------+-------------------------------------+
- | *Setter* | set_packet_granule_positions(value) |
- +-----------+-------------------------------------+
- | *Getter* | get_packet_granule_positions() |
- +-----------+-------------------------------------+
- Contains the granule positions for each page in this packet sequence.
- ----
- .. _class_OGGPacketSequence_property_packet_data:
- - :ref:`Array<class_Array>` **packet_data**
- +-----------+------------------------+
- | *Default* | ``[]`` |
- +-----------+------------------------+
- | *Setter* | set_packet_data(value) |
- +-----------+------------------------+
- | *Getter* | get_packet_data() |
- +-----------+------------------------+
- Contains the raw packets that make up this OGGPacketSequence.
- ----
- .. _class_OGGPacketSequence_property_sampling_rate:
- - :ref:`float<class_float>` **sampling_rate**
- +-----------+--------------------------+
- | *Default* | ``0.0`` |
- +-----------+--------------------------+
- | *Setter* | set_sampling_rate(value) |
- +-----------+--------------------------+
- | *Getter* | get_sampling_rate() |
- +-----------+--------------------------+
- Holds sample rate information about this sequence. Must be set by another class that actually understands the codec.
- Method Descriptions
- -------------------
- .. _class_OGGPacketSequence_method_get_length:
- - :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.)`
|
