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-->
Line 12:
Line 12:
{{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
|User|User|Host of the session the audio was recorded in
|LocationHost|{{RootFieldType|UserRef}}|TypeAdv2=true|Host of the session the audio was recorded in
|_machineId|String|Machine ID of the host
|LocationAccessLevel|'''[[Type:Nullable`1|Nullable`1]]<[[Type:SessionAccessLevel|SessionAccessLevel]]>'''|TypeAdv3=true|Access level of the session the audio was recorded in
|_userId|String|User ID of the host
|LocationHiddenFromListing|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true|Whether the session was marked as hidden when the audio was recorded.
|LocationAccessLevel|Nullable`1|TypeString3=Nullable<SessionAccessLevel>|Access level of the session
|LocationHiddenFromListing|Nullable`1|TypeString4=Bool?|Whether the session was marked as hidden
|TimeTaken|DateTime|Exact timestamp that the audio was recorded at
|TimeTaken|DateTime|Exact timestamp that the audio was recorded at
|User|User|The user who recorded the audio
|TakenBy|{{RootFieldType|UserRef}}|TypeAdv6=true|The user who recorded the audio
|_machineId|String|Machine ID of the recording user
|TakenGlobalPosition|Float3| the position in global space the microphone tip was at the time of recording.
|_userId|String|User ID of the recording user
|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
|AppVersion|String|Resonite version number of the recording user
|PresentUsers|SyncList`1|TypeString8=SyncList<UserRef>|List of users within the session
|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| legacy list of users present at the time of recording.
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 -->
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.
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.
