godot/doc/classes/AudioEffectRecord.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectRecord" inherits="AudioEffect" version="3.4">
	<brief_description>
		Audio effect used for recording sound from a microphone.
	</brief_description>
	<description>
		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.
	</description>
	<tutorials>
		<link title="Recording with microphone">https://docs.godotengine.org/en/3.3/tutorials/audio/recording_with_microphone.html</link>
		<link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link>
	</tutorials>
	<methods>
		<method name="get_recording" qualifiers="const">
			<return type="AudioStreamSample">
			</return>
			<description>
				Returns the recorded sample.
			</description>
		</method>
		<method name="is_recording_active" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns whether the recording is active or not.
			</description>
		</method>
		<method name="set_recording_active">
			<return type="void">
			</return>
			<argument index="0" name="record" type="bool">
			</argument>
			<description>
				If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
			</description>
		</method>
	</methods>
	<members>
		<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="1">
			Specifies the format in which the sample will be recorded. See [enum AudioStreamSample.Format] for available formats.
		</member>
	</members>
	<constants>
	</constants>
</class>