godot/doc/classes/AudioEffectRecord.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectRecord" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Audio effect used for recording the sound from an audio bus.
	</brief_description>
	<description>
		Allows the user to record the sound from an audio bus into an [AudioStreamWAV]. When used on the "Master" audio bus, this includes all audio output by Godot.
		Unlike [AudioEffectCapture], this effect encodes the recording with the given format (8-bit, 16-bit, or compressed) instead of giving access to the raw audio samples.
		Can be used (with an [AudioStreamMicrophone]) to record from a microphone.
		[b]Note:[/b] [member ProjectSettings.audio/driver/enable_input] must be [code]true[/code] for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.
	</description>
	<tutorials>
		<link title="Recording with microphone">$DOCS_URL/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="AudioStreamWAV" />
			<description>
				Returns the recorded sample.
			</description>
		</method>
		<method name="is_recording_active" qualifiers="const">
			<return type="bool" />
			<description>
				Returns whether the recording is active or not.
			</description>
		</method>
		<method name="set_recording_active">
			<return type="void" />
			<param index="0" name="record" type="bool" />
			<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="AudioStreamWAV.Format" default="1">
			Specifies the format in which the sample will be recorded. See [enum AudioStreamWAV.Format] for available formats.
		</member>
	</members>
</class>
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 08:08:05 +00:00			`<class name="AudioEffectRecord" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<brief_description>`
Fix the "AudioEffectRecord" descriptions. The `AudioEffectRecord` effect has no microphone capture-specific functionality--it can be used with any audio bus. This patch attempts to clarify this fact (so people like me who want to capture audio output know they're in the right place) while still providing a pointer use of the effect with `AudioStreamMicrophone` for microphone capture. 2021-09-06 13:45:22 +00:00			`Audio effect used for recording the sound from an audio bus.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</brief_description>`
			`<description>`
Clarify difference of Capture and Record effects 2023-11-28 12:59:12 +00:00			`Allows the user to record the sound from an audio bus into an [AudioStreamWAV]. When used on the "Master" audio bus, this includes all audio output by Godot.`
			`Unlike [AudioEffectCapture], this effect encodes the recording with the given format (8-bit, 16-bit, or compressed) instead of giving access to the raw audio samples.`
Fix the "AudioEffectRecord" descriptions. The `AudioEffectRecord` effect has no microphone capture-specific functionality--it can be used with any audio bus. This patch attempts to clarify this fact (so people like me who want to capture audio output know they're in the right place) while still providing a pointer use of the effect with `AudioStreamMicrophone` for microphone capture. 2021-09-06 13:45:22 +00:00			`Can be used (with an [AudioStreamMicrophone]) to record from a microphone.`
Clarify difference of Capture and Record effects 2023-11-28 12:59:12 +00:00			`[b]Note:[/b] [member ProjectSettings.audio/driver/enable_input] must be [code]true[/code] for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 09:43:07 +00:00			`<link title="Recording with microphone">$DOCS_URL/tutorials/audio/recording_with_microphone.html</link>`
Link to demos from within the class reference 2020-10-01 08:34:47 +00:00			`<link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link>`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</tutorials>`
			`<methods>`
			`<method name="get_recording" qualifiers="const">`
Rename AudioStreamSample to a more discoverable name 2022-07-23 14:34:36 +00:00			`<return type="AudioStreamWAV" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`Returns the recorded sample.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`</method>`
			`<method name="is_recording_active" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`Returns whether the recording is active or not.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`</method>`
			`<method name="set_recording_active">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="record" type="bool" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
Add LOTS of missing docs 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.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`</method>`
			`</methods>`
			`<members>`
Rename AudioStreamSample to a more discoverable name 2022-07-23 14:34:36 +00:00			`<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamWAV.Format" default="1">`
			`Specifies the format in which the sample will be recorded. See [enum AudioStreamWAV.Format] for available formats.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</member>`
			`</members>`
			`</class>`