class_audioeffectrecord.rst 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioEffectRecord.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioEffectRecord:
  5. AudioEffectRecord
  6. =================
  7. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Properties
  12. ----------
  13. +----------------------------------------------+--------------------------------------------------------+
  14. | :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioEffectRecord_property_format>` |
  15. +----------------------------------------------+--------------------------------------------------------+
  16. Methods
  17. -------
  18. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`AudioStreamSample<class_AudioStreamSample>` | :ref:`get_recording<class_AudioEffectRecord_method_get_recording>` **(** **)** const |
  20. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`bool<class_bool>` | :ref:`is_recording_active<class_AudioEffectRecord_method_is_recording_active>` **(** **)** const |
  22. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_recording_active<class_AudioEffectRecord_method_set_recording_active>` **(** :ref:`bool<class_bool>` record **)** |
  24. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  25. Property Descriptions
  26. ---------------------
  27. .. _class_AudioEffectRecord_property_format:
  28. - :ref:`Format<enum_AudioStreamSample_Format>` **format**
  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. .. _class_AudioEffectRecord_method_is_recording_active:
  39. - :ref:`bool<class_bool>` **is_recording_active** **(** **)** const
  40. .. _class_AudioEffectRecord_method_set_recording_active:
  41. - void **set_recording_active** **(** :ref:`bool<class_bool>` record **)**