Component:StaticAudioClip: Difference between revisions

From Resonite Wiki
← Older editNewer edit →
Visual
add see also and needed info
Automated: update SyncDelegates
Line 19: Line 19:
== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|Normalize()|[[Type:Func`1|Func`1]]| Makes the volume during the audio clip consistent.
|Normalize[[Type:Func`1|Func`1]]<[[Type:Task`1|Task`1]]<[[Type:Bool|Bool]]>>|[[Type:Func`1|Func`1]]<[[Type:Task`1|Task`1]]<[[Type:Bool|Bool]]>>|false| Makes the volume during the audio clip consistent.
|AdjustVolume()|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]]: ratio&gt;| multiplies the volume of this audio clip by <code>ratio</code>
|AdjustVolume[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false|
|ExtractSides()|[[Type:Func`1|Func`1]]| Split the audio into two or more clips for different audio tracks.
|ExtractSides[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Split the audio into two or more clips for different audio tracks.
|Denoise()|[[Type:Func`1|Func`1]]| Removes noise from the audio clip
|Denoise[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Removes noise from the audio clip
|TrimSilence()|[[Type:Func`1|Func`1]]| removes the silence from the start and end of the audio clip
|TrimSilence[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| removes the silence from the start and end of the audio clip
|TrimStartSilence()|[[Type:Func`1|Func`1]]| removes the silence from the start of the clip.
|TrimStartSilence[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| removes the silence from the start of the clip.
|TrimEndSilence()|[[Type:Func`1|Func`1]]| removes the silence from the end of the clip.
|TrimEndSilence[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| removes the silence from the end of the clip.
|TrimStart()|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]]: duration&gt;| removes <code>duration</code> seconds from the start of the clip.
|TrimStart[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false|
|TrimEnd()|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]]: duration&gt;| removes <code>duration</code> seconds from the end of the clip
|TrimEnd[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false|
|FadeIn()|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]]: duration&gt;| makes the audios volume increase from 0 to original over <code>duration</code> seconds at the start of the clip.
|FadeIn[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false|
|FadeOut()|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]]: duration&gt;| makes the audios volume decrease from original volume to 0 over <code>duration</seconds> seconds at the end of the clip.
|FadeOut[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false|
|MakeFadeLoop()|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]]: duration&gt;| blends the start and end of the clips by <code>duration</code> seconds to make the audio seem seamless.
|MakeFadeLoop[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:Float|Float]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false|
|ConvertToWAV()|[[Type:Func`1|Func`1]]| converts the audio clip type to Windows audio vodec.
|ConvertToWAV[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| converts the audio clip type to Windows audio vodec.
|ConvertToVorbis()|[[Type:Func`1|Func`1]]| converts the audio clip type to Vorbis.
|ConvertToVorbis[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| converts the audio clip type to Vorbis.
|ConvertToFLAC()|[[Type:Func`1|Func`1]]| Converts the audio clip type to FLAC.
|ConvertToFLAC[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`1|Func`1]]&lt;[[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false| Converts the audio clip type to FLAC.
|ApplyZitaReverb[[Type:Func`2|Func`2]]&lt;[[Type:ZitaParameters|ZitaParameters]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|[[Type:Func`2|Func`2]]&lt;[[Type:ZitaParameters|ZitaParameters]], [[Type:Task`1|Task`1]]&lt;[[Type:Bool|Bool]]&gt;&gt;|false|
|Normalize[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|ExtractSides[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|Denoise[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|TrimSilence[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|TrimStartSilence[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|TrimEndSilence[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|TrimStart[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|TrimEnd[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|FadeIn[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|FadeOut[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|MakeLoopable[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|ConvertToWAV[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|ConvertToVorbis[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
|ConvertToFLAC[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true|
}}
}}


Revision as of 06:04, 17 March 2025


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


Component image 
Static Audio Clip component as seen in the Scene Inspector

The StaticAudioClip component is what stores pre recorded audio data for components that play audio like Component:AudioClipPlayer. This component is auto generated when a sound file is imported into the game as part of an audio clip object.

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.
URL Uri The audio clip data location to load.
LoadMode AudioLoadMode How and when to load the audio
SampleRateMode SampleRateMode How to sample the audio's audio data.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
NormalizeFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Makes the volume during the audio clip consistent.
AdjustVolumeFunc`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X
ExtractSidesFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Split the audio into two or more clips for different audio tracks.
DenoiseFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Removes noise from the audio clip
TrimSilenceFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X removes the silence from the start and end of the audio clip
TrimStartSilenceFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X removes the silence from the start of the clip.
TrimEndSilenceFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X removes the silence from the end of the clip.
TrimStartFunc`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X
TrimEndFunc`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X
FadeInFunc`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X
FadeOutFunc`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X
MakeFadeLoopFunc`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X
ConvertToWAVFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X converts the audio clip type to Windows audio vodec.
ConvertToVorbisFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X converts the audio clip type to Vorbis.
ConvertToFLACFunc`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Converts the audio clip type to FLAC.
ApplyZitaReverbFunc`2<ZitaParameters, Task`1<Bool>> Func`2<ZitaParameters, Task`1<Bool>> X
NormalizeButtonEventHandler ButtonEventHandler ✓
ExtractSidesButtonEventHandler ButtonEventHandler ✓
DenoiseButtonEventHandler ButtonEventHandler ✓
TrimSilenceButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
TrimStartSilenceButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
TrimEndSilenceButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
TrimStartButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
TrimEndButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
FadeInButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
FadeOutButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
MakeLoopableButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
ConvertToWAVButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
ConvertToVorbisButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓
ConvertToFLACButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓

Usage

Examples

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:StaticAudioClip&oldid=97759"