Component:ChannelVolumeMeter: Difference between revisions

Revision as of 23:50, 19 October 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. Some components stop their functionality when this field is disabled, but some don't.
`Smoothing`	Float	How much to smooth the value changes of the outputs in `ChannelVolumes`
`Power`	Float	The maximum value the outputs in `ChannelVolumes` will go to.
`Method`	VolumeMeterMethod
`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.

@@ Line 4: / Line 4: @@
 }}
 {{stub}}
+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 <code>.OGG</code> clip.
 == Usage ==
 {{Table ComponentFields
-|Smoothing|Float|
+|Smoothing|Float| How much to smooth the value changes of the outputs in <code>ChannelVolumes</code>
-|Power|Float|
+|Power|Float| The maximum value the outputs in <code>ChannelVolumes</code> will go to.
 |Method|VolumeMeterMethod|
-|Source|IAudioSource|
+|Source|IAudioSource| The source to read the audio volumes for each channel from.
-|CurrentChannels|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv4=true|
+|CurrentChannels|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv4=true| How many channels <code>Source</code> has.
-|ChannelVolumes|{{RootFieldType|SyncList`1|[[Type:RawOutput`1|RawOutput`1]]&lt;[[Type:Float|Float]]&gt;}}|TypeAdv5=true|
+|ChannelVolumes|{{RootFieldType|SyncList`1|[[Type:RawOutput`1|RawOutput`1]]&lt;[[Type:Float|Float]]&gt;}}|TypeAdv5=true| The output volumes of each channel <code>Source</code> has.
-|DoNotRemoveExcessFields|Bool|
+|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.
 }}
@@ Line 19: / Line 20: @@
 == 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 ==