Component:AudioMetadata: Difference between revisions

Latest revision as of 22:41, 7 November 2024

Component image

**Audio Metadata** component as seen in the Scene Inspector

The AudioMetadata component provides information about an audio clip. It is automatically added to audio clips recorded with the Microphone Tool and stores data about when, where, and by whom the audio was recorded.

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.
`LocationName`	String	Name of the session the audio was recorded in
`LocationURL`	Uri	the URI of the world the audio was recorded in
`LocationHost`	direct UserRef	Host of the session the audio was recorded in
`LocationAccessLevel`	Nullable`1<SessionAccessLevel>	Access level of the session the audio was recorded in
`LocationHiddenFromListing`	Nullable`1<Bool>	Whether the session was marked as hidden when the audio was recorded.
`TimeTaken`	DateTime	Exact timestamp that the audio was recorded at
`TakenBy`	direct UserRef	The user who recorded the audio
`TakenGlobalPosition`	Float3	the position in global space the microphone tip was at the time of recording.
`TakenGlobalRotation`	FloatQ	the rotation in global space the microphone tip was at the time of recording.
`TakenGlobalScale`	Float3	the scale in global space the microphone tip was at the time of recording.
`AppVersion`	String	Resonite version number of the recording user
`UserInfos`	list of UserInfo	Users present at the time of recording
`__legacyPresentUsers`	list of UserRef	legacy list of users present at the time of recording.

Sync Delegates

Triggers
Name	Arguments	Description
`SetFromCurrentWorld()`	Action	fills in all the fields using the current session data and the local user (the user running this method)

Usage

This component is essentially a bunch of fields with semantic meaning to them. Usage of this component outside of the microphone tool is straightforward--one simply needs to write to the relevant fields the relevant data. It is common convention to place the component on the same slot that the audio clip resides.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AudioMetadataComponent.png
 |Name=Audio Metadata
 }}
-Audio Metadata is a component that is automatically added to audio clips recorded with the [[Component:MicrophoneTool|Microphone Tool]]. It stores data about when, where, and by whom the audio was recorded.
+The '''AudioMetadata''' component provides information about an audio clip. It is automatically added to audio clips recorded with the [[Component:MicrophoneTool|Microphone Tool]] and stores data about when, where, and by whom the audio was recorded.
 <!--T:2-->
@@ Line 29: / Line 28: @@
 == Sync Delegates ==
 {{Table ComponentTriggers
-|SetFromCurrentWorld()|[[Type:Action|Action]]|
+|SetFromCurrentWorld()|[[Type:Action|Action]]|{{Template:AssetMetadataSetFromWorld}}
 }}
 <!--T:3-->
 == Usage ==
+This component is essentially a bunch of fields with semantic meaning to them. Usage of this component outside of the microphone tool is straightforward--one simply needs to write to the relevant fields the relevant data. It is common convention to place the component on the same slot that the audio clip resides.
 <!--T:4-->
 == Examples ==
-Attached to audio clips generated by recording via the [[Component:MicrophoneTool|Microphone Tool]].
+<!-- TODO: have a picture of an audio clip here with the metadata  -->
 <!--T:5-->
-== Related Components ==
+== See Also ==
-[[Component:MicrophoneTool|Microphone Tool]]
+* [[Component:MicrophoneTool]]
 </translate>
 [[Category:Components{{#translation:}}|Audio Metadata]]
-[[Category:ComponentStubs]]
 [[Category:Components:Data{{#translation:}}|Audio Metadata]]