godot/doc/classes/AudioEffectRecord.xml

44 lines
1.4 KiB
XML
Raw Normal View History

2018-08-21 06:35:30 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name="AudioEffectRecord" inherits="AudioEffect" version="4.0">
2018-08-21 06:35:30 +08:00
<brief_description>
2020-03-04 02:21:21 +08:00
Audio effect used for recording sound from a microphone.
2018-08-21 06:35:30 +08:00
</brief_description>
<description>
</description>
<tutorials>
2020-03-04 02:21:21 +08:00
<link>https://docs.godotengine.org/en/latest/tutorials/audio/recording_with_microphone.html</link>
2018-08-21 06:35:30 +08:00
</tutorials>
<methods>
<method name="get_recording" qualifiers="const">
<return type="AudioStreamSample">
</return>
<description>
2020-03-04 02:21:21 +08:00
Returns the recorded sample.
2018-08-21 06:35:30 +08:00
</description>
</method>
<method name="is_recording_active" qualifiers="const">
<return type="bool">
</return>
<description>
2020-03-04 02:21:21 +08:00
Returns whether the recording is active or not.
2018-08-21 06:35:30 +08:00
</description>
</method>
<method name="set_recording_active">
<return type="void">
</return>
<argument index="0" name="record" type="bool">
</argument>
<description>
2020-03-04 02:21:21 +08:00
If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
2018-08-21 06:35:30 +08:00
</description>
</method>
</methods>
<members>
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="1">
2020-03-04 02:21:21 +08:00
Specifies the format in which the sample will be recorded. See [enum AudioStreamSample.Format] for available formats.
2018-08-21 06:35:30 +08:00
</member>
</members>
<constants>
</constants>
</class>