@workadventure/iframe-api-typings - npm Package Compare versions

Comparing version 1.22.2 to 1.23.0

package.json

 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.22.2",
+  "version": "v1.23.0",
   "description": "Typescript typings for WorkAdventure iFrame API",
@@ -5,0 +5,0 @@ "main": "iframe_api.js",

play/src/front/Api/Iframe/area.d.ts

@@ -34,3 +34,3 @@ import type { Observable } from "rxjs";
     /**
-     * Delete Area by it's name.
+     * Delete Area by its name.
      * {@link https://docs.workadventu.re/map-building/api-room.md#delete-area | Website documentation}
@@ -37,0 +37,0 @@ *

play/src/front/Api/Iframe/IframeApiContribution.d.ts

 import type { IframeEvent, IframeQuery, IframeQueryMap } from "../Events/IframeEvent";
-export declare function sendToWorkadventure(content: IframeEvent): void;
+export declare function sendToWorkadventure(content: IframeEvent, transfer?: Transferable[]): void;
 export declare const answerPromises: Map<number, {
@@ -7,3 +7,3 @@ resolve: (value: IframeQueryMap[keyof IframeQueryMap]["answer"] | PromiseLike<IframeQueryMap[keyof IframeQueryMap]["answer"]>) => void;
 }>;
-export declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>): Promise<IframeQueryMap[T]["answer"]>;
+export declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>, transfer?: Transferable[]): Promise<IframeQueryMap[T]["answer"]>;
 /**
@@ -10,0 +10,0 @@ * !! be aware that the implemented attributes (addMethodsAtRoot and subObjectIdentifier) must be readonly

play/src/front/Api/Iframe/mapEditor.d.ts

 import type { Observable } from "rxjs";
 import { IframeApiContribution } from "./IframeApiContribution";
+import { MapEditorArea } from "./MapEditor/MapEditorArea";
 declare class WorkadventureMapEditorAreaCommands extends IframeApiContribution<WorkadventureMapEditorAreaCommands> {
@@ -31,2 +32,16 @@ callbacks: ({
     onLeave(areaName: string): Observable<void>;
+    private wamMapCache;
+    /**
+     * Returns a promise that resolves to the WAM map file.
+     * The WAM is cached in memory.
+     *
+     * @returns {Promise<WAMFileFormat>} Map in Tiled JSON format
+     */
+    private getWamMap;
+    /**
+     * Returns a list of areas defined in the map editor.
+     *
+     * @returns {Promise<MapEditorArea[]>} List of areas
+     */
+    list(): Promise<MapEditorArea[]>;
 }
@@ -33,0 +48,0 @@ export declare class WorkadventureMapEditorCommands extends IframeApiContribution<WorkadventureMapEditorCommands> {

play/src/front/Api/Iframe/Player/ProximityMeeting.d.ts

@@ -1,4 +0,5 @@
-import { Subject } from "rxjs";
+import { Observable, Subject } from "rxjs";
 import { IframeApiContribution } from "../IframeApiContribution";
 import { RemotePlayer } from "../Players/RemotePlayer";
+import { AudioStream } from "./AudioStream";
 export declare class WorkadventureProximityMeetingCommands extends IframeApiContribution<WorkadventureProximityMeetingCommands> {
@@ -11,2 +12,3 @@ private joinStream;
     private leaveStream;
+    private pcmDataStream;
     callbacks: ({
@@ -100,2 +102,7 @@ type: "joinProximityMeetingEvent";
         }) => void;
+    } | {
+        type: "appendPCMData";
+        callback: (event: {
+            data: Float32Array;
+        }) => void;
     })[];
@@ -134,2 +141,14 @@ /**
     /**
+     * Starts an audio stream played to all players in the current meeting.
+     * {@link https://docs.workadventu.re/developer/map-scripting/references/api-player/#audio-streams | Website documentation}
+     * @param {number} sampleRate - The sample rate of the audio stream expressed in Hertz.
+     */
+    startAudioStream(sampleRate: number): Promise<AudioStream>;
+    /**
+     * Listen to the audio stream played sent by all players.
+     * The voice of all players in the bubble is merged in a single stream that is regularly sent to the callback.
+     * @param {number} sampleRate - The sample rate of the audio stream expressed in Hertz.
+     */
+    listenToAudioStream(sampleRate: number): Observable<Float32Array>;
+    /**
      * Ask all players in the current meeting to follow the player.
@@ -136,0 +155,0 @@ * Note that unlike with the "follow" mode in the UI, the other players will automatically follow the player.

New alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Fixed alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

268053

2.19%

Number of package files

108

4.85%

Lines of code

8362

2.15%

No dependency changes