virtualx-engine/doc/classes/AudioEffectAmplify.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Amplifies the volume of an audio source.
	</brief_description>
	<description>
		Amplifies the volume of an audio source. Increase gain of the audio being routed through the bus.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_volume_db" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Returns the set maximum volume.
			</description>
		</method>
		<method name="set_volume_db">
			<return type="void">
			</return>
			<argument index="0" name="volume" type="float">
			</argument>
			<description>
				Sets the maximum volume.
			</description>
		</method>
	</methods>
	<members>
		<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
			The effect's volume limit.
		</member>
	</members>
	<constants>
	</constants>
</class>