Component:AudioMetadata: Difference between revisions

From Resonite Wiki
VisualWikitext
imported>Mysticporo
Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=AudioMetadataComponent.png |Name=Audio Metadata }} <!--T:2--> == Fields == {{Table Componen..."
 
cleanup, standardize
 
(9 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AudioMetadataComponent.png
|Image=AudioMetadataComponent.png
|Name=Audio Metadata
|Name=Audio Metadata
}}
}}
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-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|LocationName|String|
|LocationName|String|Name of the session the audio was recorded in
|LocationURL|Uri|
|LocationURL|Uri| the URI of the world the audio was recorded in
|User|User|
|LocationHost|{{RootFieldType|UserRef}}|TypeAdv2=true|Host of the session the audio was recorded in
|_machineId|String|
|LocationAccessLevel|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:SessionAccessLevel|SessionAccessLevel]]&gt;'''|TypeAdv3=true|Access level of the session the audio was recorded in
|_userId|String|
|LocationHiddenFromListing|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv4=true|Whether the session was marked as hidden when the audio was recorded.
|LocationAccessLevel|Nullable`1|TypeString3=Nullable<SessionAccessLevel>|
|TimeTaken|DateTime|Exact timestamp that the audio was recorded at
|LocationHiddenFromListing|Nullable`1|TypeString4=Bool?|
|TakenBy|{{RootFieldType|UserRef}}|TypeAdv6=true|The user who recorded the audio
|TimeTaken|DateTime|
|TakenGlobalPosition|Float3| the position in global space the microphone tip was at the time of recording.
|User|User|
|TakenGlobalRotation|FloatQ| the rotation in global space the microphone tip was at the time of recording.
|_machineId|String|
|TakenGlobalScale|Float3| the scale in global space the microphone tip was at the time of recording.
|_userId|String|
|AppVersion|String|Resonite version number of the recording user
|NeosVersion|String|
|UserInfos|{{RootFieldType|SyncList`1|[[Type:UserInfo|UserInfo]]}}|TypeAdv11=true| Users present at the time of recording
|PresentUsers|SyncList`1|TypeString8=SyncList<UserRef>|
|__legacyPresentUsers|{{RootFieldType|SyncList`1|[[Type:UserRef|UserRef]]}}|TypeAdv12=true| legacy list of users present at the time of recording.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|SetFromCurrentWorld()|[[Type:Action|Action]]|{{Template:AssetMetadataSetFromWorld}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== 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-->
<!--T:4-->
== Examples ==
== Examples ==
<!-- TODO: have a picture of an audio clip here with the metadata  -->


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Component:MicrophoneTool]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Audio Metadata]]
[[Category:Components{{#translation:}}|Audio Metadata]]
[[Category:Components:Data{{#translation:}}|Audio Metadata]]
[[Category:Components:Data{{#translation:}}|Audio Metadata]]

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
Method Name Method type and 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.

Examples

See Also

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