PathByFilePicker

Summary:
When glxf is {"keyString":"src","type":"string","value":"./audio/violin.ogg"}, how does it parse?

It calls mapGLXFDataToProps which simply does props["src"] = fieldData.value → props["src"] = "./audio/violin.ogg". The "type":"string" is ignored.

How to make it support {"keyString":"src","type":"PathByFilePicker","value":"./audio/violin.ogg"} as a string?

It already works. Looking at the actual GLXF file at
Composition.glxf
, this is exactly what's already being produced and parsed:

"src": {
  "keyString": "src",
  "type": "PathByFilePicker",
  "value": "./audio/violin.ogg"
}

The runtime parser extracts "./audio/violin.ogg" as a string value from fieldData.value — the "type": "PathByFilePicker" is treated identically to "type": "String" because the runtime code never checks the GLXF type field (except for Enum, where it checks the component schema type, not the GLXF type).

Reviewed By: felixtrz

Differential Revision: D93434772

fbshipit-source-id: bb76704c43d8891ed4690a405e92c0593f4b67bd

Author: Peter Wang

packages/core/package.json

@@ -40,7 +40,7 @@
     "@pmndrs/uikit": "^1.0.60",
     "@pmndrs/uikitml": "^0.1.12",
     "@preact/signals-core": "^1.11.0",
-    "elics": "^3.3.0",
+    "elics": "^3.4.1",
     "three": "*",
     "three-mesh-bvh": "^0.9.1"
   },

packages/core/src/audio/audio.ts

@@ -57,8 +57,8 @@ export const DistanceModel = {
 export const AudioSource = createComponent(
   'AudioSource',
   {
-    // Core properties
-    src: { type: Types.String, default: '' }, // URL or cache key for an audio buffer
+    // Core properties  PathByFilePickerAttribute
+    src: { type: Types.FilePath, default: '' }, // URL or cache key for an audio buffer
     volume: { type: Types.Float32, default: 1.0 }, // Linear gain [0..1]
     loop: { type: Types.Boolean, default: false }, // When true, newly created instances loop
     autoplay: { type: Types.Boolean, default: false }, // Trigger a single play on first update after load

packages/starter-assets/starter-template/metaspatial-ar/components/IWSDKAudioSource.xml

@@ -16,7 +16,12 @@
     <EnumValue value="furthest"/>
   </Enum>
   <Component name="AudioSource" description="AudioSource playback component for positional and non-positional sounds">
-    <StringAttribute name="src" defaultValue=""/>
+    <PathByFilePickerAttribute
+      name="src"
+      defaultValue=""
+      fileTypes=".mp3,.wav,.ogg,.m4a,.aac"
+      description="Select an audio file to be used in your project. Files will be automatically copied to your project. The value is the relative path of the file within the final IWSDK/Spatial SDK package."
+    />
     <FloatAttribute name="volume" defaultValue="1f"/>
     <BooleanAttribute name="loop" defaultValue="false"/>
     <BooleanAttribute name="autoplay" defaultValue="false"/>
@@ -33,4 +38,4 @@
     <FloatAttribute name="crossfadeDuration" defaultValue="0.1f"/>
     <EnumAttribute name="instanceStealPolicy" defaultValue="InstanceStealPolicy.oldest"/>
   </Component>
-</ComponentSchema>
+</ComponentSchema>

packages/starter-assets/starter-template/metaspatial-vr/components/IWSDKAudioSource.xml

@@ -16,7 +16,12 @@
     <EnumValue value="furthest"/>
   </Enum>
   <Component name="AudioSource" description="AudioSource playback component for positional and non-positional sounds">
-    <StringAttribute name="src" defaultValue=""/>
+    <PathByFilePickerAttribute
+      name="src"
+      defaultValue=""
+      fileTypes=".mp3,.wav,.ogg,.m4a,.aac"
+      description="Select an audio file to be used in your project. Files will be automatically copied to your project. The value is the relative path of the file within the final IWSDK/Spatial SDK package."
+    />
     <FloatAttribute name="volume" defaultValue="1f"/>
     <BooleanAttribute name="loop" defaultValue="false"/>
     <BooleanAttribute name="autoplay" defaultValue="false"/>
@@ -33,4 +38,4 @@
     <FloatAttribute name="crossfadeDuration" defaultValue="0.1f"/>
     <EnumAttribute name="instanceStealPolicy" defaultValue="InstanceStealPolicy.oldest"/>
   </Component>
-</ComponentSchema>
+</ComponentSchema>

packages/vite-plugin-metaspatial/src/discover-components/xml-generator.ts

@@ -269,6 +269,7 @@ function mapTypeToXMLAttribute(elicsType?: string): string {
     Int64: 'LongAttribute',
     Boolean: 'BooleanAttribute',
     String: 'StringAttribute',
+    FilePath: 'PathByFilePickerAttribute',
     Vec2: 'Vector2Attribute',
     Vec3: 'Vector3Attribute',
     Vec4: 'Vector4Attribute',