Files
godot-docs/classes/class_audioeffectrecord.rst
Rémi Verschelde ab3f908221 classref: Add property overview and setter/getter like in editor docs
Output from godotengine/godot#22013.
Fixes #1729.
2018-09-13 11:06:52 +02:00

65 lines
2.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectRecord.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_AudioEffectRecord:
AudioEffectRecord
=================
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Properties
----------
+----------------------------------------------+-----------------------------------------------+
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_format>` |
+----------------------------------------------+-----------------------------------------------+
Methods
-------
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioStreamSample<class_AudioStreamSample>` | :ref:`get_recording<class_AudioEffectRecord_get_recording>` **(** **)** const |
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_recording_active<class_AudioEffectRecord_is_recording_active>` **(** **)** const |
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_recording_active<class_AudioEffectRecord_set_recording_active>` **(** :ref:`bool<class_bool>` record **)** |
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_AudioEffectRecord_format:
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
+----------+-------------------+
| *Setter* | set_format(value) |
+----------+-------------------+
| *Getter* | get_format() |
+----------+-------------------+
Method Descriptions
-------------------
.. _class_AudioEffectRecord_get_recording:
- :ref:`AudioStreamSample<class_AudioStreamSample>` **get_recording** **(** **)** const
.. _class_AudioEffectRecord_is_recording_active:
- :ref:`bool<class_bool>` **is_recording_active** **(** **)** const
.. _class_AudioEffectRecord_set_recording_active:
- void **set_recording_active** **(** :ref:`bool<class_bool>` record **)**