virtualx-engine/doc/classes/AudioEffectEQ10.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectEQ10" inherits="AudioEffectEQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz.
		Each frequency can be modulated between -60/+24 dB.
	</brief_description>
	<description>
		Frequency bands:
		Band 1: 31 Hz
		Band 2: 62 Hz
		Band 3: 125 Hz
		Band 4: 250 Hz
		Band 5: 500 Hz
		Band 6: 1000 Hz
		Band 7: 2000 Hz
		Band 8: 4000 Hz
		Band 9: 8000 Hz
		Band 10: 16000 Hz
		See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ21].
	</description>
	<tutorials>
		<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
	</tutorials>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02: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 10:08:05 +02:00			`<class name="AudioEffectEQ10" inherits="AudioEffectEQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
[DOCS] Adds AudioEffects doc 2017-09-16 18:47:19 +02:00			`Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz.`
			`Each frequency can be modulated between -60/+24 dB.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 01:04:47 +02:00			`Frequency bands:`
			`Band 1: 31 Hz`
			`Band 2: 62 Hz`
			`Band 3: 125 Hz`
			`Band 4: 250 Hz`
			`Band 5: 500 Hz`
			`Band 6: 1000 Hz`
			`Band 7: 2000 Hz`
			`Band 8: 4000 Hz`
			`Band 9: 8000 Hz`
			`Band 10: 16000 Hz`
[DOCS] Adds AudioEffects doc 2017-09-16 18:47:19 +02:00			`See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ21].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
Cleanup audio effect class reference pages 2022-06-20 01:11:11 +02:00			`<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</tutorials>`
			`</class>`