Component:StaticAudioClip: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
m ProbablePrime moved page StaticAudioClip (Component) to Component:StaticAudioClip: Creating component Namespace
add sync delegate desc
 
(7 intermediate revisions by 2 users not shown)
Line 7: Line 7:
|Name=Static Audio Clip
|Name=Static Audio Clip
}}
}}
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.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|URL|Uri|
|URL|Uri| The audio clip data location to load.
|LoadMode|AudioLoadMode|
|LoadMode|AudioLoadMode| How and when to load the audio
|SampleRateMode|SampleRateMode|
|SampleRateMode|SampleRateMode| How to sample the audio's audio data.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|Normalize:[[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| Makes the volume during the audio clip consistent.
|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| Makes the volume louder or quieter.
|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]]&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]]&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]]&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]]&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]], [[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| cuts off audio data from the start of the audio 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| cuts off audio data from the end of the audio 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| Makes the audio fade in over x seconds.
|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| Makes the audio fade out over x seconds.
|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| Makes the audio loopable, using a cross fade of x seconds.
|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]]&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]]&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| Uses [[Type:ZitaParameters|ZitaParameters]] to create a reverberation sound effect on this audio clip.
|Normalize:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Makes the volume during the audio clip consistent.
|ExtractSides:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Split the audio into two or more clips for different audio tracks.
|Denoise:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Removes noise from the audio clip
|TrimSilence:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| removes the silence from the start and end of the audio clip
|TrimStartSilence:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| removes the silence from the start of the clip.
|TrimEndSilence:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| removes the silence from the end of the clip.
|TrimStart:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| cuts off audio data from the start of the audio clip.
|TrimEnd:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| cuts off audio data from the end of the audio clip.
|FadeIn:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| Makes the audio fade in over x seconds.
|FadeOut:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| Makes the audio fade out over x seconds.
|MakeLoopable:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| Makes the audio loopable, using a cross fade of x seconds.
|ConvertToWAV:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| converts the audio clip type to Windows audio vodec.
|ConvertToVorbis:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| converts the audio clip type to Vorbis.
|ConvertToFLAC:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Component:FloatTextEditorParser|FloatTextEditorParser]]&gt;|true| Converts the audio clip type to FLAC.
}}
}}


Line 23: Line 58:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Component:PlaybackSynchronizer]] for synchronizing playables
</translate>
</translate>
[[Category:ComponentStubs]]
 
[[Category:Components{{#translation:}}|Static Audio Clip]]
[[Category:Components{{#translation:}}|Static Audio Clip]]
[[Category:Components:Assets{{#translation:}}|Static Audio Clip]]
[[Category:Components:Assets{{#translation:}}|Static Audio Clip]]

Latest revision as of 16:26, 12 April 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
Normalize:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Makes the volume during the audio clip consistent.
AdjustVolume:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Makes the volume louder or quieter.
ExtractSides:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Split the audio into two or more clips for different audio tracks.
Denoise:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Removes noise from the audio clip
TrimSilence:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X removes the silence from the start and end of the audio clip
TrimStartSilence:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X removes the silence from the start of the clip.
TrimEndSilence:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X removes the silence from the end of the clip.
TrimStart:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X cuts off audio data from the start of the audio clip.
TrimEnd:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X cuts off audio data from the end of the audio clip.
FadeIn:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Makes the audio fade in over x seconds.
FadeOut:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Makes the audio fade out over x seconds.
MakeFadeLoop:Func`2<Float, Task`1<Bool>> Func`2<Float, Task`1<Bool>> X Makes the audio loopable, using a cross fade of x seconds.
ConvertToWAV:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X converts the audio clip type to Windows audio vodec.
ConvertToVorbis:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X converts the audio clip type to Vorbis.
ConvertToFLAC:Func`1<Task`1<Bool>> Func`1<Task`1<Bool>> X Converts the audio clip type to FLAC.
ApplyZitaReverb:Func`2<ZitaParameters, Task`1<Bool>> Func`2<ZitaParameters, Task`1<Bool>> X Uses ZitaParameters to create a reverberation sound effect on this audio clip.
Normalize:ButtonEventHandler ButtonEventHandler ✓ Makes the volume during the audio clip consistent.
ExtractSides:ButtonEventHandler ButtonEventHandler ✓ Split the audio into two or more clips for different audio tracks.
Denoise:ButtonEventHandler ButtonEventHandler ✓ Removes noise from the audio clip
TrimSilence:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ removes the silence from the start and end of the audio clip
TrimStartSilence:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ removes the silence from the start of the clip.
TrimEndSilence:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ removes the silence from the end of the clip.
TrimStart:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ cuts off audio data from the start of the audio clip.
TrimEnd:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ cuts off audio data from the end of the audio clip.
FadeIn:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ Makes the audio fade in over x seconds.
FadeOut:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ Makes the audio fade out over x seconds.
MakeLoopable:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ Makes the audio loopable, using a cross fade of x seconds.
ConvertToWAV:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ converts the audio clip type to Windows audio vodec.
ConvertToVorbis:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ converts the audio clip type to Vorbis.
ConvertToFLAC:ButtonEventHandler`1<FloatTextEditorParser> ButtonEventHandler`1<FloatTextEditorParser> ✓ Converts the audio clip type to FLAC.

Usage

Examples

See Also

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