Component:AudioClipAssetMetadata: Difference between revisions

From Resonite Wiki
added info
Not a stub
 
(2 intermediate revisions by 2 users not shown)
Line 12: Line 12:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|AudioClip|IAssetProvider`1|TypeString0=IAssetProvider<AudioClip>|
|AudioClip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv0=true| The audio clip to read metadata from
|SampleRate|Int| The Hz the audio is sampled at.
|SampleRate|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv1=true| The Hz the audio is sampled at.
|Channels|ChannelConfiguration| The audio channel configuration the audio was recorded in.
|Channels|{{RootFieldType|RawOutput`1|[[Type:ChannelConfiguration|ChannelConfiguration]]}}|TypeAdv2=true| The audio channel configuration the audio was recorded in.
|ChannelCount|Int| How many channels are in the audio recording. usually 1 channel for mono or 2 channels for L and R Stereo.
|ChannelCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv3=true| How many channels are in the audio recording. usually 1 channel for mono or 2 channels for L and R Stereo.
|SampleCount|Int| how many total samples the audio clip has
|SampleCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv4=true| how many total samples the audio clip has
|Duration|Double| How long the audio clip is in seconds.
|Duration|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv5=true| How long the audio clip is in seconds.
|Extension|String| the extension of the file type the audio was recorded in.
|Extension|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv6=true| the extension of the file type the audio was recorded in.
|CodecInfo|String| The codec the audio is written in like WAV or FLAC and the quality of the audio.
|CodecInfo|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv7=true| The codec the audio is written in like WAV or FLAC and the quality of the audio.
|FullyDecoded|Bool| If the audio is loaded or not and decoded (Waveform visible)
|FullyDecoded|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv8=true| If the audio is loaded or not and decoded (Waveform visible)
}}
}}


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


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{Stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Audio Clip Asset Metadata]]
[[Category:Components{{#translation:}}|Audio Clip Asset Metadata]]
[[Category:Components:Assets:Utility{{#translation:}}|Audio Clip Asset Metadata]]
[[Category:Components:Assets:Utility{{#translation:}}|Audio Clip Asset Metadata]]

Latest revision as of 19:15, 7 November 2024

Component image 
Audio Clip Asset Metadata component as seen in the Scene Inspector

Audio Clip Asset Metadata is a component that will populate itself with different small bits of information about an audio clip, also known as metadata. The metadata will be the default values until an audio clip is provided, which will then populate the data.

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.
AudioClip AudioClip The audio clip to read metadata from
SampleRate raw output of Int The Hz the audio is sampled at.
Channels raw output of ChannelConfiguration The audio channel configuration the audio was recorded in.
ChannelCount raw output of Int How many channels are in the audio recording. usually 1 channel for mono or 2 channels for L and R Stereo.
SampleCount raw output of Int how many total samples the audio clip has
Duration raw output of Double How long the audio clip is in seconds.
Extension raw output of String the extension of the file type the audio was recorded in.
CodecInfo raw output of String The codec the audio is written in like WAV or FLAC and the quality of the audio.
FullyDecoded raw output of Bool If the audio is loaded or not and decoded (Waveform visible)

Usage

Examples

Related Components