2018-08-20 22:35:30 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 12:40:34 +00:00
<class name= "AudioEffectRecord" inherits= "AudioEffect" version= "3.3" >
2018-08-20 22:35:30 +00:00
<brief_description >
2020-03-03 18:21:21 +00:00
Audio effect used for recording sound from a microphone.
2018-08-20 22:35:30 +00:00
</brief_description>
<description >
2020-06-11 06:32:51 +00:00
Allows the user to record sound from a microphone. It sets and gets the format in which the audio file will be recorded (8-bit, 16-bit, or compressed). It checks whether or not the recording is active, and if it is, records the sound. It then returns the recorded sample.
2018-08-20 22:35:30 +00:00
</description>
<tutorials >
2020-10-19 13:55:33 +00:00
<link title= "Recording with microphone" > https://docs.godotengine.org/en/3.2/tutorials/audio/recording_with_microphone.html</link>
2020-10-01 08:34:47 +00:00
<link title= "Audio Mic Record Demo" > https://godotengine.org/asset-library/asset/527</link>
2018-08-20 22:35:30 +00:00
</tutorials>
<methods >
<method name= "get_recording" qualifiers= "const" >
<return type= "AudioStreamSample" >
</return>
<description >
2020-03-03 18:21:21 +00:00
Returns the recorded sample.
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name= "is_recording_active" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2020-03-03 18:21:21 +00:00
Returns whether the recording is active or not.
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name= "set_recording_active" >
<return type= "void" >
</return>
<argument index= "0" name= "record" type= "bool" >
</argument>
<description >
2020-03-03 18:21:21 +00:00
If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
2018-08-20 22:35:30 +00:00
</description>
</method>
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "format" type= "int" setter= "set_format" getter= "get_format" enum= "AudioStreamSample.Format" default= "1" >
2020-03-03 18:21:21 +00:00
Specifies the format in which the sample will be recorded. See [enum AudioStreamSample.Format] for available formats.
2018-08-20 22:35:30 +00:00
</member>
</members>
<constants >
</constants>
</class>