class_audioeffectrecord.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Properties
  13. ----------
  14. +----------------------------------------------+--------------------------------------------------------+
  15. | :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_property_format>` |
  16. +----------------------------------------------+--------------------------------------------------------+
  17. Methods
  18. -------
  19. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`AudioStreamSample<class_AudioStreamSample>` | :ref:`get_recording<class_AudioEffectRecord_method_get_recording>` **(** **)** const |
  21. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`is_recording_active<class_AudioEffectRecord_method_is_recording_active>` **(** **)** const |
  23. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_recording_active<class_AudioEffectRecord_method_set_recording_active>` **(** :ref:`bool<class_bool>` record **)** |
  25. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  26. Property Descriptions
  27. ---------------------
  28. .. _class_AudioEffectRecord_property_format:
  29. - :ref:`Format<enum_AudioStreamSample_Format>` **format**
  30. +----------+-------------------+
  31. | *Setter* | set_format(value) |
  32. +----------+-------------------+
  33. | *Getter* | get_format() |
  34. +----------+-------------------+
  35. Method Descriptions
  36. -------------------
  37. .. _class_AudioEffectRecord_method_get_recording:
  38. - :ref:`AudioStreamSample<class_AudioStreamSample>` **get_recording** **(** **)** const
  39. .. _class_AudioEffectRecord_method_is_recording_active:
  40. - :ref:`bool<class_bool>` **is_recording_active** **(** **)** const
  41. .. _class_AudioEffectRecord_method_set_recording_active:
  42. - void **set_recording_active** **(** :ref:`bool<class_bool>` record **)**