@dcl/playground-assets 7.23.1-25388906090.commit-25d2de7 → 7.23.1

package/dist/playground/sdk/dcl-sdk.package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.23.1-25388906090.commit-25d2de7",
+  "version": "7.23.1",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
@@ -35,5 +35,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "25d2de74f8c3bda55938d3ea9ecf751e37d72b41"
+  "commit": "a5e926314e66f7a2f1ddaa92af20589ec871c1ca"
 }

package/dist/playground-assets.d.ts

@@ -115,8 +115,60 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
  */
 export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
 
-/** @public */
-export declare const AudioAnalysis: LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>;
+export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
+
+export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
+    /**
+     * Reads the component data of `entity` into the provided `out` view.
+     *
+     * @throws Error if the entity does not have an AudioAnalysis component.
+     * @param entity - The entity whose AudioAnalysis data will be read.
+     * @param out - An existing AudioAnalysisView to populate with the latest values.
+     */
+    readIntoView(entity: Entity, out: AudioAnalysisView): void;
+    /**
+     * Attempts to read the component data of `entity` into the provided `out` view.
+     *
+     * @returns `true` if the component exists and data was written into `out`,
+     *          `false` if the entity does not have an AudioAnalysis component.
+     * @param entity - The entity whose AudioAnalysis data will be read.
+     * @param out - An existing AudioAnalysisView to populate.
+     */
+    tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
+    /**
+     * Creates an AudioAnalysis component for the given `entity`.
+     *
+     * If a component already exists on the entity, this call fails (does not replace).
+     *
+     * @param entity - The entity to attach the component to.
+     * @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
+     * @param amplitudeGain - Optional amplitude gain multiplier.
+     * @param bandsGain - Optional gain multiplier applied to all frequency bands.
+     */
+    createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
+    amplitudeGain?: number, bandsGain?: number): void;
+    /**
+     * Creates the AudioAnalysis component if missing, or replaces the existing one.
+     *
+     * @param entity - The target entity.
+     * @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
+     * @param amplitudeGain - Optional amplitude gain multiplier.
+     * @param bandsGain - Optional gain multiplier applied to the frequency bands.
+     */
+    createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
+    amplitudeGain?: number, bandsGain?: number): void;
+}
+
+/**
+ * A read-only JavaScript-friendly view of AudioAnalysis ECS data.
+ *
+ * `amplitude` represents the aggregated signal strength.
+ * `bands` represents the processed frequency bands.
+ */
+export declare type AudioAnalysisView = {
+    amplitude: number;
+    bands: number[];
+};
 
 /** @public */
 export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;

package/etc/playground-assets.api.json

@@ -1168,12 +1168,36 @@
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!AudioAnalysis:var",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
               "text": "AudioAnalysis: "
             },
+            {
+              "kind": "Reference",
+              "text": "AudioAnalysisComponentDefinitionExtended",
+              "canonicalReference": "@dcl/playground-assets!AudioAnalysisComponentDefinitionExtended:interface"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/index.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "AudioAnalysis",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@dcl/playground-assets!AudioAnalysisComponentDefinitionExtended:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface AudioAnalysisComponentDefinitionExtended extends "
+            },
             {
               "kind": "Reference",
               "text": "LastWriteWinElementSetComponentDefinition",
@@ -1191,15 +1215,365 @@
             {
               "kind": "Content",
               "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
-          "fileUrlPath": "../ecs/dist/components/generated/global.gen.d.ts",
-          "isReadonly": true,
+          "fileUrlPath": "../ecs/dist/components/extended/AudioAnalysis.d.ts",
           "releaseTag": "Public",
-          "name": "AudioAnalysis",
-          "variableTypeTokenRange": {
+          "name": "AudioAnalysisComponentDefinitionExtended",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@dcl/playground-assets!AudioAnalysisComponentDefinitionExtended#createAudioAnalysis:member(1)",
+              "docComment": "/**\n * Creates an AudioAnalysis component for the given `entity`.\n *\n * If a component already exists on the entity, this call fails (does not replace).\n *\n * @param entity - The entity to attach the component to.\n *\n * @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.\n *\n * @param amplitudeGain - Optional amplitude gain multiplier.\n *\n * @param bandsGain - Optional gain multiplier applied to all frequency bands.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "createAudioAnalysis(entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "@dcl/playground-assets!Entity:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", mode?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PBAudioAnalysisMode",
+                  "canonicalReference": "@dcl/playground-assets!PBAudioAnalysisMode:enum"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", // default is PBAudioAnalysisMode.MODE_LOGARITHMIC\n    amplitudeGain?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", bandsGain?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 10
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "mode",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "amplitudeGain",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "bandsGain",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "createAudioAnalysis"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@dcl/playground-assets!AudioAnalysisComponentDefinitionExtended#createOrReplaceAudioAnalysis:member(1)",
+              "docComment": "/**\n * Creates the AudioAnalysis component if missing, or replaces the existing one.\n *\n * @param entity - The target entity.\n *\n * @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.\n *\n * @param amplitudeGain - Optional amplitude gain multiplier.\n *\n * @param bandsGain - Optional gain multiplier applied to the frequency bands.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "createOrReplaceAudioAnalysis(entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "@dcl/playground-assets!Entity:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", mode?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PBAudioAnalysisMode",
+                  "canonicalReference": "@dcl/playground-assets!PBAudioAnalysisMode:enum"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", // default is PBAudioAnalysisMode.MODE_LOGARITHMIC\n    amplitudeGain?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", bandsGain?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 10
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "mode",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "amplitudeGain",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "bandsGain",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "createOrReplaceAudioAnalysis"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@dcl/playground-assets!AudioAnalysisComponentDefinitionExtended#readIntoView:member(1)",
+              "docComment": "/**\n * Reads the component data of `entity` into the provided `out` view.\n *\n * @param entity - The entity whose AudioAnalysis data will be read.\n *\n * @param out - An existing AudioAnalysisView to populate with the latest values.\n *\n * @throws\n *\n * Error if the entity does not have an AudioAnalysis component.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readIntoView(entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "@dcl/playground-assets!Entity:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", out: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AudioAnalysisView",
+                  "canonicalReference": "@dcl/playground-assets!AudioAnalysisView:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "out",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "readIntoView"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@dcl/playground-assets!AudioAnalysisComponentDefinitionExtended#tryReadIntoView:member(1)",
+              "docComment": "/**\n * Attempts to read the component data of `entity` into the provided `out` view.\n *\n * @param entity - The entity whose AudioAnalysis data will be read.\n *\n * @param out - An existing AudioAnalysisView to populate.\n *\n * @returns `true` if the component exists and data was written into `out`, `false` if the entity does not have an AudioAnalysis component.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "tryReadIntoView(entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "@dcl/playground-assets!Entity:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", out: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AudioAnalysisView",
+                  "canonicalReference": "@dcl/playground-assets!AudioAnalysisView:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "out",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "tryReadIntoView"
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 5
+            }
+          ]
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@dcl/playground-assets!AudioAnalysisView:type",
+          "docComment": "/**\n * A read-only JavaScript-friendly view of AudioAnalysis ECS data.\n *\n * `amplitude` represents the aggregated signal strength. `bands` represents the processed frequency bands.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type AudioAnalysisView = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    amplitude: number;\n    bands: number[];\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/components/extended/AudioAnalysis.d.ts",
+          "releaseTag": "Public",
+          "name": "AudioAnalysisView",
+          "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 5
+            "endIndex": 2
           }
         },
         {

package/etc/playground-assets.api.md

@@ -70,8 +70,30 @@ export const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
 // @public (undocumented)
 export type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
 
+// Warning: (ae-missing-release-tag) "AudioAnalysis" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
 // @public (undocumented)
-export const AudioAnalysis: LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>;
+export const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
+
+// Warning: (ae-missing-release-tag) "AudioAnalysisComponentDefinitionExtended" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
+    createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
+    amplitudeGain?: number, bandsGain?: number): void;
+    createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
+    amplitudeGain?: number, bandsGain?: number): void;
+    readIntoView(entity: Entity, out: AudioAnalysisView): void;
+    tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
+}
+
+// Warning: (ae-missing-release-tag) "AudioAnalysisView" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export type AudioAnalysisView = {
+    amplitude: number;
+    bands: number[];
+};
 
 // @public (undocumented)
 export const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/playground-assets",
   "description": "",
-  "version": "7.23.1-25388906090.commit-25d2de7",
+  "version": "7.23.1",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/js-runtime": "7.23.1-25388906090.commit-25d2de7",
-    "@dcl/sdk": "7.23.1-25388906090.commit-25d2de7"
+    "@dcl/js-runtime": "7.23.1",
+    "@dcl/sdk": "7.23.1"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.8"
@@ -32,5 +32,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "25d2de74f8c3bda55938d3ea9ecf751e37d72b41"
+  "commit": "a5e926314e66f7a2f1ddaa92af20589ec871c1ca"
 }