Files
godot-docs/classes/class_resourceimportermp3.rst
2023-07-15 03:23:27 +00:00

119 lines
4.5 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/modules/minimp3/doc_classes/ResourceImporterMP3.xml.
.. _class_ResourceImporterMP3:
ResourceImporterMP3
===================
**Inherits:** :ref:`ResourceImporter<class_ResourceImporter>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`bar_beats<class_ResourceImporterMP3_property_bar_beats>` | ``4`` |
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`beat_count<class_ResourceImporterMP3_property_beat_count>` | ``0`` |
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`bpm<class_ResourceImporterMP3_property_bpm>` | ``0`` |
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`loop<class_ResourceImporterMP3_property_loop>` | ``false`` |
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`loop_offset<class_ResourceImporterMP3_property_loop_offset>` | ``0`` |
+---------------------------+--------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_ResourceImporterMP3_property_bar_beats:
.. rst-class:: classref-property
:ref:`int<class_int>` **bar_beats** = ``4``
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_ResourceImporterMP3_property_beat_count:
.. rst-class:: classref-property
:ref:`int<class_int>` **beat_count** = ``0``
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_ResourceImporterMP3_property_bpm:
.. rst-class:: classref-property
:ref:`float<class_float>` **bpm** = ``0``
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_ResourceImporterMP3_property_loop:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **loop** = ``false``
If ``true``, the audio will play again from the specified :ref:`loop_offset<class_ResourceImporterMP3_property_loop_offset>` once it is done playing. Useful for ambient sounds and background music.
.. rst-class:: classref-item-separator
----
.. _class_ResourceImporterMP3_property_loop_offset:
.. rst-class:: classref-property
:ref:`float<class_float>` **loop_offset** = ``0``
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`