Component:AudioZitaReverb: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Added a link for ZitaParameters.
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Audio Zita Reverb
|Name=Audio Zita Reverb
}}
}}
The '''Audio Zita Reverb''' component
The '''Audio Zita Reverb''' component can be used to create echo effects (called [[Type:ZitaParameters|ZitaParameters]]) onto [[Type:AudioClip|audio clips]], or on listeners in an area using the [[Awwdio]] system. To see how to use it with audio listeners, see [[Component:AudioListener|AudioListener]].
{{stub}}
 
{{Note|If you need a way to control reverb using [[ProtoFlux]], use [[ProtoFlux:Construct Zita Parameters|Construct Zita Parameters]] instead.|suggestion}}


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|InDelay|Float|
|InDelay|Float| Delay in ms before reverberation begins.
|Crossover|Float|
|Crossover|Float| Crossover frequency separating low and middle frequencies (Hz).
|RT60Low|Float|
|RT60Low|Float| Time (in seconds) to decay 60db in low-frequency band.
|RT60Mid|Float|
|RT60Mid|Float| Time (in seconds) to decay 60db in mid-frequency band.
|HighFrequencyDamping|Float|
|HighFrequencyDamping|Float| Frequency (Hz) at which the high-frequency T60 is half the middle-band's T60.
|EQ1Frequency|Float|
|EQ1Frequency|Float| Center frequency of second-order Regalia Mitra peaking equalizer section 1.
|EQ1Level|Float|
|EQ1Level|Float| Peak level in dB of second-order Regalia-Mitra peaking equalizer section 1
|EQ2Frequency|Float|
|EQ2Frequency|Float| Center frequency of second-order Regalia Mitra peaking equalizer section 2.
|EQ2Level|Float|
|EQ2Level|Float| Peak level in dB of second-order Regalia-Mitra peaking equalizer section 2.
|Mix|Float|
|Mix|Float| 0 is all dry, 1 is all wet.
|Level|Float|
|Level|Float| Output scale factor (in dB).
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|SetPreset:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:Action|Action]]>|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:Action|Action]]>|true|
|SetPreset:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:Action|Action]]>|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:Action|Action]]>|true| Runs the provided action to apply a preset.
|PresetOff:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetOff:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to not have an effect at all
|PresetGeneric:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetGeneric:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetPaddedCell:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetPaddedCell:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetRoom:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetRoom:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetBathroom:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetBathroom:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetLivingroom:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetLivingroom:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetStoneroom:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetStoneroom:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetAuditorium:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetAuditorium:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetConcerthall:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetConcerthall:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetCave:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetCave:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetArena:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetArena:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetHangar:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetHangar:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetCarpetedHallway:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetCarpetedHallway:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetHallway:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetHallway:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetStoneCorridor:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetStoneCorridor:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetAlley:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetAlley:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetForest:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetForest:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetCity:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetCity:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetMountains:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetMountains:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetQuarry:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetQuarry:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetPlain:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetPlain:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetParkingLot:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetParkingLot:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetSewerPipe:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetSewerPipe:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetUnderwater:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetUnderwater:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetDrugged:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetDrugged:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetDizzy:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetDizzy:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
|PresetPsychotic:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|PresetPsychotic:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Sets the values to a preset that replicates this button's name
}}
}}


<!--T:3-->
== Usage ==
== Usage ==
{{stub}}


<!--T:4-->
== Examples ==
== Examples ==
Can be used to make global audio echo or sound like it's inside of a tin can.


== See Also ==


[[Category:Components:Audio{{#translation:}}|Audio Zita Reverb]]
[[Category:Components:Audio{{#translation:}}|Audio Zita Reverb]]
[[Category:Components{{#translation:}}|Audio Zita Reverb]]
[[Category:Components{{#translation:}}|Audio Zita Reverb]]
[[Category:ComponentStubs]]

Latest revision as of 02:50, 10 May 2025

Component image 
File:AudioZitaReverbComponent.png
Audio Zita Reverb component as seen in the Scene Inspector

The Audio Zita Reverb component can be used to create echo effects (called ZitaParameters) onto audio clips, or on listeners in an area using the Awwdio system. To see how to use it with audio listeners, see AudioListener.

If you need a way to control reverb using ProtoFlux, use Construct Zita Parameters instead.

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. Some components stop their functionality when this field is disabled, but some don't.
InDelay Float Delay in ms before reverberation begins.
Crossover Float Crossover frequency separating low and middle frequencies (Hz).
RT60Low Float Time (in seconds) to decay 60db in low-frequency band.
RT60Mid Float Time (in seconds) to decay 60db in mid-frequency band.
HighFrequencyDamping Float Frequency (Hz) at which the high-frequency T60 is half the middle-band's T60.
EQ1Frequency Float Center frequency of second-order Regalia Mitra peaking equalizer section 1.
EQ1Level Float Peak level in dB of second-order Regalia-Mitra peaking equalizer section 1
EQ2Frequency Float Center frequency of second-order Regalia Mitra peaking equalizer section 2.
EQ2Level Float Peak level in dB of second-order Regalia-Mitra peaking equalizer section 2.
Mix Float 0 is all dry, 1 is all wet.
Level Float Output scale factor (in dB).

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
SetPreset:ButtonEventHandler`1<Action> ButtonEventHandler`1<Action> Runs the provided action to apply a preset.
PresetOff:Action Action X Sets the values to not have an effect at all
PresetGeneric:Action Action X Sets the values to a preset that replicates this button's name
PresetPaddedCell:Action Action X Sets the values to a preset that replicates this button's name
PresetRoom:Action Action X Sets the values to a preset that replicates this button's name
PresetBathroom:Action Action X Sets the values to a preset that replicates this button's name
PresetLivingroom:Action Action X Sets the values to a preset that replicates this button's name
PresetStoneroom:Action Action X Sets the values to a preset that replicates this button's name
PresetAuditorium:Action Action X Sets the values to a preset that replicates this button's name
PresetConcerthall:Action Action X Sets the values to a preset that replicates this button's name
PresetCave:Action Action X Sets the values to a preset that replicates this button's name
PresetArena:Action Action X Sets the values to a preset that replicates this button's name
PresetHangar:Action Action X Sets the values to a preset that replicates this button's name
PresetCarpetedHallway:Action Action X Sets the values to a preset that replicates this button's name
PresetHallway:Action Action X Sets the values to a preset that replicates this button's name
PresetStoneCorridor:Action Action X Sets the values to a preset that replicates this button's name
PresetAlley:Action Action X Sets the values to a preset that replicates this button's name
PresetForest:Action Action X Sets the values to a preset that replicates this button's name
PresetCity:Action Action X Sets the values to a preset that replicates this button's name
PresetMountains:Action Action X Sets the values to a preset that replicates this button's name
PresetQuarry:Action Action X Sets the values to a preset that replicates this button's name
PresetPlain:Action Action X Sets the values to a preset that replicates this button's name
PresetParkingLot:Action Action X Sets the values to a preset that replicates this button's name
PresetSewerPipe:Action Action X Sets the values to a preset that replicates this button's name
PresetUnderwater:Action Action X Sets the values to a preset that replicates this button's name
PresetDrugged:Action Action X Sets the values to a preset that replicates this button's name
PresetDizzy:Action Action X Sets the values to a preset that replicates this button's name
PresetPsychotic:Action Action X Sets the values to a preset that replicates this button's name

Usage

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

Examples

Can be used to make global audio echo or sound like it's inside of a tin can.