connected-spaces-platform.web 6.23.0 → 6.24.0

package/connectedspacesplatform.d.ts

@@ -245,6 +245,16 @@ export declare namespace Multiplayer {
         Num = 4
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the supported locomotion models available for the avatar movements.
+     */
+    enum LocomotionModel {
+        Grounded = 0,
+        FreeCamera = 1,
+        Num = 2
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enum used to indicate the failure state of a multiplayer request.
@@ -267,6 +277,16 @@ export declare namespace Multiplayer {
         EntityNotOwnedAndUntransferable = 2
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the type of stereo the video player and texture material supports.
+     */
+    enum StereoVideoType {
+        None = 0,
+        SideBySide = 1,
+        TopBottom = 2
+    }
+}
 export declare namespace Systems {
     /**
      * @description Indicates special handling for any thirdparty platform
@@ -605,16 +625,6 @@ export declare namespace Multiplayer {
         Num = 11
     }
 }
-export declare namespace Multiplayer {
-    /**
-     * @description Enumerates the supported locomotion models available for the avatar movements.
-     */
-    enum LocomotionModel {
-        Grounded = 0,
-        FreeCamera = 1,
-        Num = 2
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the list of properties that can be replicated for an avatar component.
@@ -1128,17 +1138,6 @@ export declare namespace Multiplayer {
         Num = 3
     }
 }
-export declare namespace Multiplayer {
-    /**
-     * @description Enumerates the type of stereo the video player supports.
-     */
-    enum StereoVideoType {
-        None = 0,
-        SideBySide = 1,
-        TopBottom = 2,
-        Num = 3
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the list of properties that can be replicated for a video player component.
@@ -1166,7 +1165,8 @@ export declare namespace Multiplayer {
         IsEnabled = 19,
         IsVirtualVisible = 20,
         StereoVideoType = 21,
-        Num = 22
+        IsStereoFlipped = 22,
+        Num = 23
     }
 }
 export declare namespace Multiplayer {
@@ -4064,10 +4064,11 @@ export declare namespace Common {
          * @param avatarState - The initial Avatar State to set.
          * @param avatarId - The ID to be set on the AvatarSpaceComponent
          * @param avatarPlayMode - The Initial AvatarPlayMode to set.
+         * @param locomotionModel - The Initial LocomotionModel to set.
          * @param callback - Csp::multiplayer::entitycreatedcallback a callback that executes when the creation is complete,
          * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
          */
-        createAvatar(name: string, userId: string, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, avatarState: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
+        createAvatar(name: string, userId: string, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, avatarState: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode, locomotionModel: Multiplayer.LocomotionModel): Promise<Multiplayer.SpaceEntity>;
         /**
          * @description Create and add a SpaceEntity, with relevant default values.
          * @param name - The name of the newly created SpaceEntity.
@@ -5573,6 +5574,26 @@ export declare namespace Systems {
          * @param value - Bool
          */
         setTexture(value: boolean): void;
+        /**
+         * @description Gets the type of stereo the texture uses.
+         * @return The type of stereo used by this texture.
+         */
+        getStereoVideoType(): Multiplayer.StereoVideoType;
+        /**
+         * @description Sets the type of stereo the texture uses.
+         * @param value - The type of stereo used by this texture.
+         */
+        setStereoVideoType(value: Multiplayer.StereoVideoType): void;
+        /**
+         * @description Gets whether the stereo video left and right are flipped.
+         * @return True if the stereo frames are flipped, false for default.
+         */
+        getIsStereoFlipped(): boolean;
+        /**
+         * @description Sets whether the stereo video left and right are flipped.
+         * @param value - True if the stereo frames are flipped, false for default.
+         */
+        setIsStereoFlipped(value: boolean): void;
         delete(): void;
     }
 }
@@ -6547,10 +6568,11 @@ export declare namespace Multiplayer {
          * @param state - The initial Avatar State to set.
          * @param avatarId - The ID to be set on the AvatarSpaceComponent
          * @param avatarPlayMode - The Initial AvatarPlayMode to set.
+         * @param locomotionModel - The Initial LocomotionModel to set.
          * @param callback - Csp::multiplayer::entitycreatedcallback a callback that executes when the creation is complete,
          * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
          */
-        createAvatar(name: string, userId: string, transform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
+        createAvatar(name: string, userId: string, transform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode, locomotionModel: Multiplayer.LocomotionModel): Promise<Multiplayer.SpaceEntity>;
         /**
          * @description Create and add a SpaceEntity, with relevant default values.
          * @param name - The name of the newly created SpaceEntity.
@@ -6682,10 +6704,11 @@ export declare namespace Multiplayer {
          * @param state - The initial Avatar State to set.
          * @param avatarId - The ID to be set on the AvatarSpaceComponent
          * @param avatarPlayMode - The Initial AvatarPlayMode to set.
+         * @param locomotionModel - The Initial LocomotionModel to set.
          * @param callback - Csp::multiplayer::entitycreatedcallback a callback that executes when the creation is complete,
          * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
          */
-        createAvatar(name: string, userId: string, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
+        createAvatar(name: string, userId: string, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode, locomotionModel: Multiplayer.LocomotionModel): Promise<Multiplayer.SpaceEntity>;
         /**
          * @description Create and add a SpaceEntity, with relevant default values.
          * @param name - The name of the newly created SpaceEntity.
@@ -10127,6 +10150,16 @@ export declare namespace Multiplayer {
          * @param value - The type of stereo used by this video.
          */
         setStereoVideoType(value: Multiplayer.StereoVideoType): void;
+        /**
+         * @description Gets whether the stereo video left and right are flipped.
+         * @return True if the stereo frames are flipped, false for default.
+         */
+        getIsStereoFlipped(): boolean;
+        /**
+         * @description Sets whether the stereo video left and right are flipped.
+         * @param value - True if the stereo frames are flipped, false for default.
+         */
+        setIsStereoFlipped(value: boolean): void;
         /**
          * \addtogroup IVisibleComponent
         @{

package/connectedspacesplatform.js

@@ -307,6 +307,11 @@ function csp_multiplayer_AvatarPlayModeFactory(nativePointer) {
 }
 ProxyClassFactories["csp_multiplayer_AvatarPlayMode"] =
     csp_multiplayer_AvatarPlayModeFactory;
+function csp_multiplayer_LocomotionModelFactory(nativePointer) {
+    return nativePointer.pointer;
+}
+ProxyClassFactories["csp_multiplayer_LocomotionModel"] =
+    csp_multiplayer_LocomotionModelFactory;
 function csp_multiplayer_ErrorCodeFactory(nativePointer) {
     return nativePointer.pointer;
 }
@@ -317,6 +322,11 @@ function csp_multiplayer_ModifiableStatusFactory(nativePointer) {
 }
 ProxyClassFactories["csp_multiplayer_ModifiableStatus"] =
     csp_multiplayer_ModifiableStatusFactory;
+function csp_multiplayer_StereoVideoTypeFactory(nativePointer) {
+    return nativePointer.pointer;
+}
+ProxyClassFactories["csp_multiplayer_StereoVideoType"] =
+    csp_multiplayer_StereoVideoTypeFactory;
 function csp_systems_EThirdPartyPlatformFactory(nativePointer) {
     return nativePointer.pointer;
 }
@@ -414,11 +424,6 @@ function csp_multiplayer_AudioPropertyKeysFactory(nativePointer) {
 }
 ProxyClassFactories["csp_multiplayer_AudioPropertyKeys"] =
     csp_multiplayer_AudioPropertyKeysFactory;
-function csp_multiplayer_LocomotionModelFactory(nativePointer) {
-    return nativePointer.pointer;
-}
-ProxyClassFactories["csp_multiplayer_LocomotionModel"] =
-    csp_multiplayer_LocomotionModelFactory;
 function csp_multiplayer_AvatarComponentPropertyKeysFactory(nativePointer) {
     return nativePointer.pointer;
 }
@@ -593,11 +598,6 @@ function csp_multiplayer_VideoPlayerSourceTypeFactory(nativePointer) {
 }
 ProxyClassFactories["csp_multiplayer_VideoPlayerSourceType"] =
     csp_multiplayer_VideoPlayerSourceTypeFactory;
-function csp_multiplayer_StereoVideoTypeFactory(nativePointer) {
-    return nativePointer.pointer;
-}
-ProxyClassFactories["csp_multiplayer_StereoVideoType"] =
-    csp_multiplayer_StereoVideoTypeFactory;
 function csp_multiplayer_VideoPlayerPropertyKeysFactory(nativePointer) {
     return nativePointer.pointer;
 }
@@ -2232,6 +2232,17 @@ export var Multiplayer;
         AvatarPlayMode[AvatarPlayMode["Num"] = 4] = "Num";
     })(AvatarPlayMode = Multiplayer.AvatarPlayMode || (Multiplayer.AvatarPlayMode = {}));
 })(Multiplayer || (Multiplayer = {}));
+(function (Multiplayer) {
+    /**
+     * @description Enumerates the supported locomotion models available for the avatar movements.
+     */
+    let LocomotionModel;
+    (function (LocomotionModel) {
+        LocomotionModel[LocomotionModel["Grounded"] = 0] = "Grounded";
+        LocomotionModel[LocomotionModel["FreeCamera"] = 1] = "FreeCamera";
+        LocomotionModel[LocomotionModel["Num"] = 2] = "Num";
+    })(LocomotionModel = Multiplayer.LocomotionModel || (Multiplayer.LocomotionModel = {}));
+})(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
     /**
      * @description Enum used to indicate the failure state of a multiplayer request.
@@ -2256,6 +2267,17 @@ export var Multiplayer;
         ModifiableStatus[ModifiableStatus["EntityNotOwnedAndUntransferable"] = 2] = "EntityNotOwnedAndUntransferable";
     })(ModifiableStatus = Multiplayer.ModifiableStatus || (Multiplayer.ModifiableStatus = {}));
 })(Multiplayer || (Multiplayer = {}));
+(function (Multiplayer) {
+    /**
+     * @description Enumerates the type of stereo the video player and texture material supports.
+     */
+    let StereoVideoType;
+    (function (StereoVideoType) {
+        StereoVideoType[StereoVideoType["None"] = 0] = "None";
+        StereoVideoType[StereoVideoType["SideBySide"] = 1] = "SideBySide";
+        StereoVideoType[StereoVideoType["TopBottom"] = 2] = "TopBottom";
+    })(StereoVideoType = Multiplayer.StereoVideoType || (Multiplayer.StereoVideoType = {}));
+})(Multiplayer || (Multiplayer = {}));
 export var Systems;
 (function (Systems) {
     /**
@@ -2616,17 +2638,6 @@ export var Systems;
         AudioPropertyKeys[AudioPropertyKeys["Num"] = 11] = "Num";
     })(AudioPropertyKeys = Multiplayer.AudioPropertyKeys || (Multiplayer.AudioPropertyKeys = {}));
 })(Multiplayer || (Multiplayer = {}));
-(function (Multiplayer) {
-    /**
-     * @description Enumerates the supported locomotion models available for the avatar movements.
-     */
-    let LocomotionModel;
-    (function (LocomotionModel) {
-        LocomotionModel[LocomotionModel["Grounded"] = 0] = "Grounded";
-        LocomotionModel[LocomotionModel["FreeCamera"] = 1] = "FreeCamera";
-        LocomotionModel[LocomotionModel["Num"] = 2] = "Num";
-    })(LocomotionModel = Multiplayer.LocomotionModel || (Multiplayer.LocomotionModel = {}));
-})(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
     /**
      * @description Enumerates the list of properties that can be replicated for an avatar component.
@@ -3175,18 +3186,6 @@ export var Systems;
         VideoPlayerSourceType[VideoPlayerSourceType["Num"] = 3] = "Num";
     })(VideoPlayerSourceType = Multiplayer.VideoPlayerSourceType || (Multiplayer.VideoPlayerSourceType = {}));
 })(Multiplayer || (Multiplayer = {}));
-(function (Multiplayer) {
-    /**
-     * @description Enumerates the type of stereo the video player supports.
-     */
-    let StereoVideoType;
-    (function (StereoVideoType) {
-        StereoVideoType[StereoVideoType["None"] = 0] = "None";
-        StereoVideoType[StereoVideoType["SideBySide"] = 1] = "SideBySide";
-        StereoVideoType[StereoVideoType["TopBottom"] = 2] = "TopBottom";
-        StereoVideoType[StereoVideoType["Num"] = 3] = "Num";
-    })(StereoVideoType = Multiplayer.StereoVideoType || (Multiplayer.StereoVideoType = {}));
-})(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
     /**
      * @description Enumerates the list of properties that can be replicated for a video player component.
@@ -3215,7 +3214,8 @@ export var Systems;
         VideoPlayerPropertyKeys[VideoPlayerPropertyKeys["IsEnabled"] = 19] = "IsEnabled";
         VideoPlayerPropertyKeys[VideoPlayerPropertyKeys["IsVirtualVisible"] = 20] = "IsVirtualVisible";
         VideoPlayerPropertyKeys[VideoPlayerPropertyKeys["StereoVideoType"] = 21] = "StereoVideoType";
-        VideoPlayerPropertyKeys[VideoPlayerPropertyKeys["Num"] = 22] = "Num";
+        VideoPlayerPropertyKeys[VideoPlayerPropertyKeys["IsStereoFlipped"] = 22] = "IsStereoFlipped";
+        VideoPlayerPropertyKeys[VideoPlayerPropertyKeys["Num"] = 23] = "Num";
     })(VideoPlayerPropertyKeys = Multiplayer.VideoPlayerPropertyKeys || (Multiplayer.VideoPlayerPropertyKeys = {}));
 })(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
@@ -10586,10 +10586,11 @@ export class CSPFoundation {
          * @param avatarState - The initial Avatar State to set.
          * @param avatarId - The ID to be set on the AvatarSpaceComponent
          * @param avatarPlayMode - The Initial AvatarPlayMode to set.
+         * @param locomotionModel - The Initial LocomotionModel to set.
          * @param callback - Csp::multiplayer::entitycreatedcallback a callback that executes when the creation is complete,
          * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
          */
-        async createAvatar(name, userId, spaceTransform, isVisible, avatarState, avatarId, avatarPlayMode) {
+        async createAvatar(name, userId, spaceTransform, isVisible, avatarState, avatarId, avatarPlayMode, locomotionModel) {
             var _resolve;
             var _promise = new Promise((_r) => {
                 _resolve = _r;
@@ -10602,7 +10603,7 @@ export class CSPFoundation {
                 Module.removeFunction(_callbackPtr);
             };
             _callbackPtr = Module.addFunction(_callback, "vii");
-            Module.ccall("csp_common_IRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarState_StringRC_AvatarPlayMode_EntityCreatedCallback", "void", [
+            Module.ccall("csp_common_IRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarState_StringRC_AvatarPlayMode_LocomotionModel_EntityCreatedCallback", "void", [
                 "number",
                 "string",
                 "string",
@@ -10613,6 +10614,7 @@ export class CSPFoundation {
                 "number",
                 "number",
                 "number",
+                "number",
             ], [
                 this.pointer,
                 name,
@@ -10622,6 +10624,7 @@ export class CSPFoundation {
                 avatarState,
                 avatarId,
                 avatarPlayMode,
+                locomotionModel,
                 _callbackPtr,
                 0,
             ]);
@@ -13881,6 +13884,36 @@ export class CSPFoundation {
         setTexture(value) {
             Module.ccall("csp_systems_TextureInfo_SetTexture_void_bool", "void", ["number", "boolean"], [this.pointer, value]);
         }
+        /**
+         * @description Gets the type of stereo the texture uses.
+         * @return The type of stereo used by this texture.
+         */
+        getStereoVideoType() {
+            let _result = Module.ccall("csp_systems_TextureInfo_GetStereoVideoTypeC_StereoVideoType", "number", ["number"], [this.pointer]);
+            return _result;
+        }
+        /**
+         * @description Sets the type of stereo the texture uses.
+         * @param value - The type of stereo used by this texture.
+         */
+        setStereoVideoType(value) {
+            Module.ccall("csp_systems_TextureInfo_SetStereoVideoType_void_StereoVideoType", "void", ["number", "number"], [this.pointer, value]);
+        }
+        /**
+         * @description Gets whether the stereo video left and right are flipped.
+         * @return True if the stereo frames are flipped, false for default.
+         */
+        getIsStereoFlipped() {
+            let _result = Module.ccall("csp_systems_TextureInfo_GetIsStereoFlippedC_bool", "boolean", ["number"], [this.pointer]);
+            return _result;
+        }
+        /**
+         * @description Sets whether the stereo video left and right are flipped.
+         * @param value - True if the stereo frames are flipped, false for default.
+         */
+        setIsStereoFlipped(value) {
+            Module.ccall("csp_systems_TextureInfo_SetIsStereoFlipped_void_bool", "void", ["number", "boolean"], [this.pointer, value]);
+        }
         delete() {
             if (this.ownsPointer && !this.disposed) {
                 Module.ccall("csp_systems_TextureInfo_Dtor", "void", ["number"], [this.pointer]);
@@ -16543,10 +16576,11 @@ export class CSPFoundation {
          * @param state - The initial Avatar State to set.
          * @param avatarId - The ID to be set on the AvatarSpaceComponent
          * @param avatarPlayMode - The Initial AvatarPlayMode to set.
+         * @param locomotionModel - The Initial LocomotionModel to set.
          * @param callback - Csp::multiplayer::entitycreatedcallback a callback that executes when the creation is complete,
          * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
          */
-        async createAvatar(name, userId, transform, isVisible, state, avatarId, avatarPlayMode) {
+        async createAvatar(name, userId, transform, isVisible, state, avatarId, avatarPlayMode, locomotionModel) {
             var _resolve;
             var _promise = new Promise((_r) => {
                 _resolve = _r;
@@ -16559,7 +16593,7 @@ export class CSPFoundation {
                 Module.removeFunction(_callbackPtr);
             };
             _callbackPtr = Module.addFunction(_callback, "vii");
-            Module.ccall("csp_multiplayer_OfflineRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarState_StringRC_AvatarPlayMode_EntityCreatedCallback", "void", [
+            Module.ccall("csp_multiplayer_OfflineRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarState_StringRC_AvatarPlayMode_LocomotionModel_EntityCreatedCallback", "void", [
                 "number",
                 "string",
                 "string",
@@ -16570,6 +16604,7 @@ export class CSPFoundation {
                 "number",
                 "number",
                 "number",
+                "number",
             ], [
                 this.pointer,
                 name,
@@ -16579,6 +16614,7 @@ export class CSPFoundation {
                 state,
                 avatarId,
                 avatarPlayMode,
+                locomotionModel,
                 _callbackPtr,
                 0,
             ]);
@@ -16870,10 +16906,11 @@ export class CSPFoundation {
          * @param state - The initial Avatar State to set.
          * @param avatarId - The ID to be set on the AvatarSpaceComponent
          * @param avatarPlayMode - The Initial AvatarPlayMode to set.
+         * @param locomotionModel - The Initial LocomotionModel to set.
          * @param callback - Csp::multiplayer::entitycreatedcallback a callback that executes when the creation is complete,
          * which will provide a non-owning pointer to the new SpaceEntity so that it can be used on the local client.
          */
-        async createAvatar(name, userId, spaceTransform, isVisible, state, avatarId, avatarPlayMode) {
+        async createAvatar(name, userId, spaceTransform, isVisible, state, avatarId, avatarPlayMode, locomotionModel) {
             var _resolve;
             var _promise = new Promise((_r) => {
                 _resolve = _r;
@@ -16886,7 +16923,7 @@ export class CSPFoundation {
                 Module.removeFunction(_callbackPtr);
             };
             _callbackPtr = Module.addFunction(_callback, "vii");
-            Module.ccall("csp_multiplayer_OnlineRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarState_StringRC_AvatarPlayMode_EntityCreatedCallback", "void", [
+            Module.ccall("csp_multiplayer_OnlineRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarState_StringRC_AvatarPlayMode_LocomotionModel_EntityCreatedCallback", "void", [
                 "number",
                 "string",
                 "string",
@@ -16897,6 +16934,7 @@ export class CSPFoundation {
                 "number",
                 "number",
                 "number",
+                "number",
             ], [
                 this.pointer,
                 name,
@@ -16906,6 +16944,7 @@ export class CSPFoundation {
                 state,
                 avatarId,
                 avatarPlayMode,
+                locomotionModel,
                 _callbackPtr,
                 0,
             ]);
@@ -23093,6 +23132,21 @@ export class CSPFoundation {
         setStereoVideoType(value) {
             Module.ccall("csp_multiplayer_VideoPlayerSpaceComponent_SetStereoVideoType_void_StereoVideoType", "void", ["number", "number"], [this.pointer, value]);
         }
+        /**
+         * @description Gets whether the stereo video left and right are flipped.
+         * @return True if the stereo frames are flipped, false for default.
+         */
+        getIsStereoFlipped() {
+            let _result = Module.ccall("csp_multiplayer_VideoPlayerSpaceComponent_GetIsStereoFlippedC_bool", "boolean", ["number"], [this.pointer]);
+            return _result;
+        }
+        /**
+         * @description Sets whether the stereo video left and right are flipped.
+         * @param value - True if the stereo frames are flipped, false for default.
+         */
+        setIsStereoFlipped(value) {
+            Module.ccall("csp_multiplayer_VideoPlayerSpaceComponent_SetIsStereoFlipped_void_bool", "void", ["number", "boolean"], [this.pointer, value]);
+        }
         /**
          * \addtogroup IVisibleComponent
         @{