Component:VolumeMeter: Difference between revisions

From Resonite Wiki
missing image slot
Tweak argument descriptions, add another See Also link, clarify language
 
Line 8: Line 8:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Smoothing|Float| how much to smooth lerp the <code>Volume</code> field output.
|Smoothing|Float|Smooth lerp the <code>Volume</code> field this much.
|Power|Float| the range of the <code>Volume</code> field from 0 to this.
|Power|Float|Raise <code>Volume</code> to this exponent. 1 will leave <code>Volume</code> unchanged.|Method|VolumeMeterMethod| Whether the outputted value should be the current volume, or the change in volume over time (delta)
|Method|VolumeMeterMethod| Whether the outputted value should be the current volume, or the change in volume over time (delta)
|Source|IAudioSource|The audio source to read the volume of (as long as it's streaming or playing).
|Source|IAudioSource| the audio source to read the volume of in real time as long as it's streaming or playing.
|Volume|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv4=true| The current volume of <code>Source</code> raised to the exponent <code>Power</code>, after smoothing factor of <code>Smoothing</code>.
|Volume|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv4=true| The current volume of <code>Source</code> after smoothing factor of <code>Smoothing</code>
}}
}}


== Usage ==
== Usage ==
Attach to a slot and provide [[Type:IAudioSource|any IAudioSource]] to <code>Source</code>. When audio data is being generated by <code>Source</code> the <code>Volume</code> field will start changing values.
Attach to a slot and provide any [[Type:IAudioSource|IAudioSource]] to <code>Source</code>. When audio data is being generated by <code>Source</code> the <code>Volume</code> field will start changing values.


== Examples ==
== Examples ==
This is used in avatars that flash when talking, or in audio visualizers
This component can be used to add visual reaction to avatars when talking, or in audio/music visualizers.


== See Also ==
== See Also ==
* [[Component:TalkVisualizer|TalkVisualizer]]
* [[Component:TalkVisualizer|TalkVisualizer]]
* [[Component:ChannelVolumeMeter|ChannelVolumeMeter]]


[[Category:Components{{#translation:}}|Volume Meter]]
[[Category:Components{{#translation:}}|Volume Meter]]
[[Category:Components:Media:Utility{{#translation:}}|Volume Meter]]
[[Category:Components:Media:Utility{{#translation:}}|Volume Meter]]

Latest revision as of 00:31, 5 December 2024

Component image 
File:VolumeMeterComponent.png
Volume Meter component as seen in the Scene Inspector

The VolumeMeter component can be used to get the volume of an inputted audio source.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
Smoothing Float Smooth lerp the Volume field this much.
Power Float Raise Volume to this exponent. 1 will leave Volume unchanged.
Method VolumeMeterMethod Whether the outputted value should be the current volume, or the change in volume over time (delta)
Source IAudioSource The audio source to read the volume of (as long as it's streaming or playing).
Volume raw output of Float The current volume of Source raised to the exponent Power, after smoothing factor of Smoothing.

Usage

Attach to a slot and provide any IAudioSource to Source. When audio data is being generated by Source the Volume field will start changing values.

Examples

This component can be used to add visual reaction to avatars when talking, or in audio/music visualizers.

See Also