mirror of
				https://github.com/godotengine/godot.git
				synced 2025-10-31 13:41:03 +00:00 
			
		
		
		
	 81064cc239
			
		
	
	
		81064cc239
		
			
		
	
	
	
	
		
			
			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).
		
			
				
	
	
		
			44 lines
		
	
	
	
		
			2.6 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
			
		
		
	
	
			44 lines
		
	
	
	
		
			2.6 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
| <?xml version="1.0" encoding="UTF-8" ?>
 | |
| <class name="AudioEffectSpectrumAnalyzer" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
 | |
| 	<brief_description>
 | |
| 		Audio effect that can be used for real-time audio visualizations.
 | |
| 	</brief_description>
 | |
| 	<description>
 | |
| 		This audio effect does not affect sound output, but can be used for real-time audio visualizations.
 | |
| 		See also [AudioStreamGenerator] for procedurally generating sounds.
 | |
| 	</description>
 | |
| 	<tutorials>
 | |
| 		<link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link>
 | |
| 		<link title="Godot 3.2 will get new audio features">https://godotengine.org/article/godot-32-will-get-new-audio-features</link>
 | |
| 	</tutorials>
 | |
| 	<members>
 | |
| 		<member name="buffer_length" type="float" setter="set_buffer_length" getter="get_buffer_length" default="2.0">
 | |
| 			The length of the buffer to keep (in seconds). Higher values keep data around for longer, but require more memory.
 | |
| 		</member>
 | |
| 		<member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectSpectrumAnalyzer.FFTSize" default="2">
 | |
| 			The size of the [url=https://en.wikipedia.org/wiki/Fast_Fourier_transform]Fast Fourier transform[/url] buffer. Higher values smooth out the spectrum analysis over time, but have greater latency. The effects of this higher latency are especially noticeable with sudden amplitude changes.
 | |
| 		</member>
 | |
| 		<member name="tap_back_pos" type="float" setter="set_tap_back_pos" getter="get_tap_back_pos" default="0.01">
 | |
| 		</member>
 | |
| 	</members>
 | |
| 	<constants>
 | |
| 		<constant name="FFT_SIZE_256" value="0" enum="FFTSize">
 | |
| 			Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time.
 | |
| 		</constant>
 | |
| 		<constant name="FFT_SIZE_512" value="1" enum="FFTSize">
 | |
| 			Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time.
 | |
| 		</constant>
 | |
| 		<constant name="FFT_SIZE_1024" value="2" enum="FFTSize">
 | |
| 			Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time.
 | |
| 		</constant>
 | |
| 		<constant name="FFT_SIZE_2048" value="3" enum="FFTSize">
 | |
| 			Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time.
 | |
| 		</constant>
 | |
| 		<constant name="FFT_SIZE_4096" value="4" enum="FFTSize">
 | |
| 			Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time.
 | |
| 		</constant>
 | |
| 		<constant name="FFT_SIZE_MAX" value="5" enum="FFTSize">
 | |
| 			Represents the size of the [enum FFTSize] enum.
 | |
| 		</constant>
 | |
| 	</constants>
 | |
| </class>
 |