Component:ChannelVolumeMeter: Difference between revisions

From Resonite Wiki
finish info for now
fix
 
(2 intermediate revisions by 2 users not shown)
Line 9: Line 9:
{{Table ComponentFields
{{Table ComponentFields
|Smoothing|Float| How much to smooth the value changes of the outputs in <code>ChannelVolumes</code>
|Smoothing|Float| How much to smooth the value changes of the outputs in <code>ChannelVolumes</code>
|Power|Float| The maximum value the outputs in <code>ChannelVolumes</code> will go to.
|Power|Float|Raise <code>ChannelVolumes</code> to this exponent. 1 will leave <code>ChannelVolumes</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 source to read the audio volumes for each channel from.
|Source|IAudioSource| The source to read the audio volumes for each channel from.
Line 23: Line 23:


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


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

Latest revision as of 17:31, 17 December 2024

Component image 
Channel Volume Meter component as seen in the Scene Inspector


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Channel Volume meter is a component that is used to read the volume of an audio source with multiple channels. The amount of channels can vary from 1, 2, and even to beyond 4. Usually this component is used to split the Left and Right audio volumes of an .OGG clip.

Usage

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 How much to smooth the value changes of the outputs in ChannelVolumes
Power Float Raise ChannelVolumes to this exponent. 1 will leave ChannelVolumes unchanged.
Method VolumeMeterMethod Whether the outputted value should be the current volume, or the change in volume over time (delta)
Source IAudioSource The source to read the audio volumes for each channel from.
CurrentChannels raw output of Int How many channels Source has.
ChannelVolumes list of RawOutput`1<Float> The output volumes of each channel Source has.
DoNotRemoveExcessFields Bool Don't remove excess fields whenever a new audio clip is inserted and the fields are outside the amount of channels the audio clip has.

Behavior

Examples

This can be used for audio visualizers, or to read the individual volume of the left and right volume of an OGG for L and R speaker visualization.

See Also