class_audioeffectrecord.rst 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioEffectRecord.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioEffectRecord:
  6. AudioEffectRecord
  7. =================
  8. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +----------------------------------------------+--------------------------------------------------------+---+
  12. | :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_property_format>` | 1 |
  13. +----------------------------------------------+--------------------------------------------------------+---+
  14. Methods
  15. -------
  16. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`AudioStreamSample<class_AudioStreamSample>` | :ref:`get_recording<class_AudioEffectRecord_method_get_recording>` **(** **)** const |
  18. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`is_recording_active<class_AudioEffectRecord_method_is_recording_active>` **(** **)** const |
  20. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_recording_active<class_AudioEffectRecord_method_set_recording_active>` **(** :ref:`bool<class_bool>` record **)** |
  22. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_AudioEffectRecord_property_format:
  26. - :ref:`Format<enum_AudioStreamSample_Format>` **format**
  27. +-----------+-------------------+
  28. | *Default* | 1 |
  29. +-----------+-------------------+
  30. | *Setter* | set_format(value) |
  31. +-----------+-------------------+
  32. | *Getter* | get_format() |
  33. +-----------+-------------------+
  34. Method Descriptions
  35. -------------------
  36. .. _class_AudioEffectRecord_method_get_recording:
  37. - :ref:`AudioStreamSample<class_AudioStreamSample>` **get_recording** **(** **)** const
  38. ----
  39. .. _class_AudioEffectRecord_method_is_recording_active:
  40. - :ref:`bool<class_bool>` **is_recording_active** **(** **)** const
  41. ----
  42. .. _class_AudioEffectRecord_method_set_recording_active:
  43. - void **set_recording_active** **(** :ref:`bool<class_bool>` record **)**