Files
godot-docs/classes/class_audioeffectrecord.rst
2018-08-21 00:37:52 +02:00

54 lines
2.3 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
-----------------
Member Functions
----------------
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :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 **)** |
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_AudioEffectRecord_format:
- :ref:`Format<enum_audiostreamsample_format>` **format**
Member Function Description
---------------------------
.. _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 **)**