godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2e7fc81)

Browse Source
This commit is contained in:
Godot Organization
2024-02-24 03:20:02 +00:00
parent 4f21f44632
commit 8978497bb6
938 changed files with 42729 additions and 36889 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
classes/class_audioeffectrecord.rst
View File

@@ -56,13 +56,13 @@ Methods
.. table::
:widths: auto
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioStreamWAV<class_AudioStreamWAV>` | :ref:`get_recording<class_AudioEffectRecord_method_get_recording>` **(** **)** |const| |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_recording_active<class_AudioEffectRecord_method_is_recording_active>` **(** **)** |const| |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_recording_active<class_AudioEffectRecord_method_set_recording_active>` **(** :ref:`bool<class_bool>` record **)** |
+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioStreamWAV<class_AudioStreamWAV>` | :ref:`get_recording<class_AudioEffectRecord_method_get_recording>`\ (\ ) |const| |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_recording_active<class_AudioEffectRecord_method_is_recording_active>`\ (\ ) |const| |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_recording_active<class_AudioEffectRecord_method_set_recording_active>`\ (\ record\: :ref:`bool<class_bool>`\ ) |
+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -81,8 +81,8 @@ Property Descriptions
.. rst-class:: classref-property-setget
- void **set_format** **(** :ref:`Format<enum_AudioStreamWAV_Format>` value **)**
- :ref:`Format<enum_AudioStreamWAV_Format>` **get_format** **(** **)**
- |void| **set_format**\ (\ value\: :ref:`Format<enum_AudioStreamWAV_Format>`\ )
- :ref:`Format<enum_AudioStreamWAV_Format>` **get_format**\ (\ )
Specifies the format in which the sample will be recorded. See :ref:`Format<enum_AudioStreamWAV_Format>` for available formats.
@@ -99,7 +99,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`AudioStreamWAV<class_AudioStreamWAV>` **get_recording** **(** **)** |const|
:ref:`AudioStreamWAV<class_AudioStreamWAV>` **get_recording**\ (\ ) |const|
Returns the recorded sample.
@@ -111,7 +111,7 @@ Returns the recorded sample.
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_recording_active** **(** **)** |const|
:ref:`bool<class_bool>` **is_recording_active**\ (\ ) |const|
Returns whether the recording is active or not.
@@ -123,7 +123,7 @@ Returns whether the recording is active or not.
.. rst-class:: classref-method
void **set_recording_active** **(** :ref:`bool<class_bool>` record **)**
|void| **set_recording_active**\ (\ record\: :ref:`bool<class_bool>`\ )
If ``true``, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
@@ -134,3 +134,4 @@ If ``true``, the sound will be recorded. Note that restarting the recording will
.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`