Component:AudioMetadata: Difference between revisions

From Resonite Wiki
Re-add descriptions for location & taken fields
Add info
Line 7: Line 7:
|Name=Audio Metadata
|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.


<!--T:2-->
<!--T:2-->
Line 12: Line 13:
{{Table ComponentFields
{{Table ComponentFields
|LocationName|String|Name of the session the audio was recorded in
|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
|LocationHost|{{RootFieldType|UserRef}}|TypeAdv2=true|Host of the session the audio was recorded in
|LocationHost|{{RootFieldType|UserRef}}|TypeAdv2=true|Host of the session the audio was recorded in
|LocationAccessLevel|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:SessionAccessLevel|SessionAccessLevel]]&gt;'''|TypeAdv3=true|Access level of the session
|LocationAccessLevel|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:SessionAccessLevel|SessionAccessLevel]]&gt;'''|TypeAdv3=true|Access level of the session the audio was recorded in
|LocationHiddenFromListing|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv4=true|Whether the session was marked as hidden
|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.
|TimeTaken|DateTime|Exact timestamp that the audio was recorded at
|TimeTaken|DateTime|Exact timestamp that the audio was recorded at
|TakenBy|{{RootFieldType|UserRef}}|TypeAdv6=true|The user who recorded the audio
|TakenBy|{{RootFieldType|UserRef}}|TypeAdv6=true|The user who recorded the audio
|TakenGlobalPosition|Float3|
|TakenGlobalPosition|Float3| the position in global space the microphone tip was at the time of recording.
|TakenGlobalRotation|FloatQ|
|TakenGlobalRotation|FloatQ| the rotation in global space the microphone tip was at the time of recording.
|TakenGlobalScale|Float3|
|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
|AppVersion|String|Resonite version number of the recording user
|UserInfos|{{RootFieldType|SyncList`1|[[Type:UserInfo|UserInfo]]}}|TypeAdv11=true|
|UserInfos|{{RootFieldType|SyncList`1|[[Type:UserInfo|UserInfo]]}}|TypeAdv11=true| Users present at the time of recording
|__legacyPresentUsers|{{RootFieldType|SyncList`1|[[Type:UserRef|UserRef]]}}|TypeAdv12=true|
|__legacyPresentUsers|{{RootFieldType|SyncList`1|[[Type:UserRef|UserRef]]}}|TypeAdv12=true| legacy list of users present at the time of recording.
}}
}}


Line 31: Line 32:
<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Attached to audio clips generated by recording via the [[Component:MicrophoneTool|Microphone Tool]].


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
[[Component:MicrophoneTool|Microphone Tool]]
</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]]

Revision as of 16:32, 24 October 2024


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


Component image 
Audio Metadata component as seen in the Scene Inspector

Audio Metadata is a component that is automatically added to audio clips recorded with the Microphone Tool. It 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.

Usage

Examples

Attached to audio clips generated by recording via the Microphone Tool.

Related Components

Microphone Tool