connected-spaces-platform.web 6.0.0 → 6.1.0

package/connectedspacesplatform.d.ts

@@ -205,6 +205,33 @@ export declare namespace Web {
         ResponseNetworkAuthenticationRequired = 511
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the supported states for an avatar.
+     * These are used to establish the related animation that the avatar will use on its state machine.
+     */
+    enum AvatarState {
+        Idle = 0,
+        Walking = 1,
+        Running = 2,
+        Flying = 3,
+        Jumping = 4,
+        Falling = 5,
+        Num = 6
+    }
+}
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the supported play mode for the avatar.
+     */
+    enum AvatarPlayMode {
+        Default = 0,
+        AR = 1,
+        VR = 2,
+        Creator = 3,
+        Num = 4
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enum used to indicate the failure state of a multiplayer request.
@@ -351,8 +378,9 @@ export declare namespace Multiplayer {
         Text = 25,
         Hotspot = 26,
         CinematicCamera = 27,
-        spare = 28,
-        values = 29,
+        ScreenSharing = 28,
+        spare = 29,
+        values = 30,
         Delete = 56
     }
 }
@@ -522,33 +550,6 @@ export declare namespace Multiplayer {
         Num = 11
     }
 }
-export declare namespace Multiplayer {
-    /**
-     * @description Enumerates the supported states for an avatar.
-     * These are used to establish the related animation that the avatar will use on its state machine.
-     */
-    enum AvatarState {
-        Idle = 0,
-        Walking = 1,
-        Running = 2,
-        Flying = 3,
-        Jumping = 4,
-        Falling = 5,
-        Num = 6
-    }
-}
-export declare namespace Multiplayer {
-    /**
-     * @description Enumerates the supported play mode for the avatar.
-     */
-    enum AvatarPlayMode {
-        Default = 0,
-        AR = 1,
-        VR = 2,
-        Creator = 3,
-        Num = 4
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the supported locomotion models available for the avatar movements.
@@ -938,6 +939,24 @@ export declare namespace Multiplayer {
         UnitBox = 1
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the list of properties that can be replicated for a screen sharing component.
+     */
+    enum ScreenSharingPropertyKeys {
+        Position = 0,
+        Rotation = 1,
+        Scale = 2,
+        IsVisible = 3,
+        IsARVisible = 4,
+        IsShadowCaster = 5,
+        UserId = 6,
+        DefaultImageCollectionId = 7,
+        DefaultImageAssetId = 8,
+        AttenuationRadius = 9,
+        Num = 10
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the supported scopes of a script.
@@ -8869,6 +8888,139 @@ export declare namespace Multiplayer {
         delete(): void;
     }
 }
+export declare namespace Multiplayer {
+    /**
+  @ingroup ScreenSharingSpaceComponent
+   * @description Enables screen sharing within the space.
+   * /// The screen sharing component facilitates the sharing of a user's screen within a space.
+   * The component itself does not make assumptions about the mechanism by which the screen is shared.
+   * It provides properties to define a default image to be displayed when no users are
+   * sharing their screen, as well a UserId property to store the Id of the user currently sharing their screen.
+   */
+    class ScreenSharingSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IShadowCasterComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.ScreenSharingSpaceComponent;
+        /**
+         * @description Constructs the screen sharing component, and associates it with the specified Parent space entity.
+         * @param parent - The Space entity that owns this component.
+         */
+        static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): ScreenSharingSpaceComponent;
+        /**
+         * @description Gets the ID of the user who is currently sharing their screen to this component.
+         * NOTE: An empty string means that no user is currently sharing their screen to this component.
+         * @return The ID of the user who is currently sharing their screen to this component.
+         */
+        getUserId(): string;
+        /**
+         * @description Sets the ID of the user who is sharing their screen to this component.
+         * @param value - The ID of the user who is sharing their screen to this component. This must be set to an empty string when
+         * the user finishes sharing.
+         */
+        setUserId(value: string): void;
+        /**
+         * @description Gets the ID of the asset collection associated with the default image for this component.
+         * NOTE: To retrieve this component's default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.
+         * @return The ID of the default image asset collection associated with this component.
+         */
+        getDefaultImageCollectionId(): string;
+        /**
+         * @description Sets the ID of the asset collection associated with the default image for this component.
+         * NOTE: To retrieve this component's default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.
+         * @param value - The ID of the default image asset collection associated with this component.
+         */
+        setDefaultImageCollectionId(value: string): void;
+        /**
+         * @description Gets the ID of the asset associated with the default image for this component.
+         * NOTE: To retrieve this component's default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.
+         * @return The ID of the default image asset associated with this component.
+         */
+        getDefaultImageAssetId(): string;
+        /**
+         * @description Sets the ID of the asset associated with the default image for this component.
+         * NOTE: To retrieve this component's default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.
+         * @param value - The ID of the default image asset associated with this component.
+         */
+        setDefaultImageAssetId(value: string): void;
+        /**
+         * @description Gets the radius from this component origin within which the audio of this video can be heard by the user.
+         * NOTE: Only when the user position is within this radius the audio of the video should be heard.
+         * @return The radius within which the audio of the video can be heard by the user.
+         */
+        getAttenuationRadius(): number;
+        /**
+         * @description Sets the radius from this component origin within which the audio of this video can be heard by the user.
+         * NOTE: Only when the user position is within this radius the audio of the video should be heard.
+         * @param value - The radius within which the audio of the video can be heard by the user.
+         */
+        setAttenuationRadius(value: number): void;
+        /**
+         * \addtogroup ITransformComponent
+        @{
+        @copydoc IPositionComponent::GetPosition()
+         */
+        getPosition(): Common.Vector3;
+        /**
+        @copydoc IPositionComponent::SetPosition()
+         */
+        setPosition(value: Common.Vector3): void;
+        /**
+        @copydoc IRotationComponent::GetRotation()
+         */
+        getRotation(): Common.Vector4;
+        /**
+        @copydoc IRotationComponent::SetRotation()
+         */
+        setRotation(value: Common.Vector4): void;
+        /**
+        @copydoc IScaleComponent::GetScale()
+         */
+        getScale(): Common.Vector3;
+        /**
+        @copydoc IScaleComponent::SetScale()
+         */
+        setScale(value: Common.Vector3): void;
+        /**
+        @copydoc ITransformComponent::GetTransform()
+         */
+        getTransform(): Multiplayer.SpaceTransform;
+        /**
+        @copydoc ITransformComonent::SetTransform()
+         */
+        setTransform(value: Multiplayer.SpaceTransform): void;
+        /**
+        @}
+         * \addtogroup IVisibleComponent
+        @{
+        @copydoc IVisibleComponent::GetIsVisible()
+         */
+        getIsVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVisible()
+         */
+        setIsVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsARVisible()
+         */
+        getIsARVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsARVisible()
+         */
+        setIsARVisible(value: boolean): void;
+        /**
+        @}
+         * \addtogroup IShadowCasterComponent
+        @{
+        @copydoc IShadowCasterComponent::GetIsShadowCaster()
+         */
+        getIsShadowCaster(): boolean;
+        /**
+        @copydoc IShadowCasterComponent::SetIsShadowCaster()
+         */
+        setIsShadowCaster(value: boolean): void;
+        delete(): void;
+    }
+}
 export declare namespace Multiplayer {
     /**
   @ingroup ScriptSpaceComponent
@@ -11294,10 +11446,17 @@ export declare namespace Systems {
         constructor(pointer: NativePointer);
         static fromResultBase(baseInstance: Systems.ResultBase): Systems.AvatarInfoResult;
         /**
-         * @description A getter which returns the String passed via the result.
+         * @description Returns the type of avatar selected by the user.
          */
         getAvatarType(): Systems.AvatarType;
+        /**
+         * @description Returns the string used to identify or locate the avatar.
+         */
         getAvatarIdentifier(): string;
+        /**
+         * @description Returns whether or not the user's avatar is intended to be visible or not.
+         */
+        getAvatarVisible(): boolean;
         delete(): void;
     }
 }
@@ -11403,9 +11562,10 @@ export declare namespace Systems {
          * @description Sets the avatar type and identifier for a user.
          * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
          * @param inIdentifier - A string used to identify or locate the avatar.
+         * @param inAvatarVisible - A bool used to identify whether the user's avatar should be visible or not.
          * @param callback - Callback to call when task finishes.
          */
-        setAvatarInfo(type: Systems.AvatarType, identifier: string): Promise<Systems.NullResult>;
+        setAvatarInfo(type: Systems.AvatarType, identifier: string, avatarVisible: boolean): Promise<Systems.NullResult>;
         /**
          * @description Retrieves the avatar type and identifier for a user.
          * @param callback - Callback to call when task finishes.
@@ -11649,7 +11809,7 @@ export declare namespace Systems {
          * The initial load behaviour will differ based on the concrete IRealtimeEngine passed to this function.
          * If user does not have permission to discover or enter the space, callback will be called with EResultCode::Failed and
          * ERequestFailureReason::UserSpaceAccessDenied
-         * @param space - Space to enter into
+         * @param spaceId - Space id to enter into
          * @param realtimeEngine - RealtimeEngine to load the space with. This object belongs to the caller, and does not
          * transfer ownership. Once the space is loaded, the caller should be sure to maintain the lifetime of the RealtimeEngine so long
          * as the space is active. Once the caller has called csp::systems::SpaceSystem::ExitSpace and received the callback, then they are
@@ -11699,7 +11859,7 @@ export declare namespace Systems {
         createSpaceWithBuffer(name: string, description: string, attributes: Systems.SpaceAttributes, inviteUsers: Systems.InviteUserRoleInfoCollection | null, metadata: Common.Map<string, string>, thumbnail: Systems.BufferAssetDataSource, tags: Common.Array<string> | null): Promise<Systems.SpaceResult>;
         /**
          * @description Updates the name and/or the description of a Space
-         * @param space - The space to update
+         * @param spaceId - The space id to update
          * @param name - If a new name is provided it will be used to update the space name
          * @param description - If a new description is provided it will be used to update the space
          * description
@@ -11710,7 +11870,7 @@ export declare namespace Systems {
         updateSpace(spaceId: string, name: string | null, description: string | null, type: Systems.SpaceAttributes | null, tags: Common.Array<string> | null): Promise<Systems.BasicSpaceResult>;
         /**
          * @description Deletes a given space and the associated objects that belong to it. Including UserService group, Metadata, and Thumbnail.
-         * @param space - Space to delete
+         * @param spaceId - Space id to delete
          * @param callback - Callback when asynchronous task finishes
          */
         deleteSpace(spaceId: string): Promise<Systems.NullResult>;
@@ -11756,7 +11916,7 @@ export declare namespace Systems {
         getSpace(spaceId: string): Promise<Systems.SpaceResult>;
         /**
          * @description Invites a given email to a specific space.
-         * @param space - Space to invite to
+         * @param spaceId - Space id to invite to
          * @param email - Email to invite to space
          * @param isModeratorRole - If present and true sets the user's role in the space to "moderator", pass false or
          * nullptr to leave role as default
@@ -11767,67 +11927,67 @@ export declare namespace Systems {
         inviteToSpace(spaceId: string, email: string, isModeratorRole: boolean | null, emailLinkUrl: string | null, signupUrl: string | null): Promise<Systems.NullResult>;
         /**
          * @description Invites all the given emails to a specific space.
-         * @param space - Space to invite to
+         * @param spaceId - Space id to invite to
          * @param inviteUsers - Collection containing the email link URL and the users to invite with their emails and roles
          * @param callback - Callback when asynchronous task finishes
          */
         bulkInviteToSpace(spaceId: string, inviteUsers: Systems.InviteUserRoleInfoCollection): Promise<Systems.NullResult>;
         /**
          * @description Returns an array of obfuscated email addresses, addresses of users that have not yet accepted the space invite
-         * @param space - Space for which the invites where sent
+         * @param spaceId - Space ID for which the invites where sent
          * @param callback - Callback when asynchronous task finishes
          */
         getPendingUserInvites(spaceId: string): Promise<Systems.PendingInvitesResult>;
         /**
          * @description Returns an array of ids of users that accepted the space invite
-         * @param space - Space for which the invites where sent
+         * @param spaceId - Space ID for which the invites where sent
          * @param callback - Callback when asynchronous task finishes
          */
         getAcceptedUserInvites(spaceId: string): Promise<Systems.AcceptedInvitesResult>;
         /**
          * @description Removes a user from a space by the user's unique ID.
-         * @param space - Space to remove user from
+         * @param spaceId - Space id to remove user from
          * @param userId - Unique id of user
          * @param callback - Callback when asynchronous task finishes
          */
         removeUserFromSpace(spaceId: string, userId: string): Promise<Systems.NullResult>;
         /**
          * @description Adds a user to a space by the user's unique ID.
-         * @param space - Space to add user to
+         * @param spaceId - Space id to add user to
          * @param userId - Unique id of user
          * @param callback - Callback when asynchronous task finishes
          */
         addUserToSpace(spaceId: string, userId: string): Promise<Systems.SpaceResult>;
         /**
          * @description Creates new Site information and associates it with the Space.
-         * @param space - Space to associate the Site information with
+         * @param spaceId - Space ID to associate the Site information with
          * @param siteInfo - Site information to be added
          * @param callback - Callback when asynchronous task finishes
          */
         addSiteInfo(spaceId: string, siteInfo: Systems.Site): Promise<Systems.SiteResult>;
         /**
          * @description Removes the Site information from the Space.
-         * @param space - Space for which to remove the associated Site information
+         * @param spaceId - Space ID for which to remove the associated Site information
          * @param siteInfo - Site information to be removed
          * @param callback - Callback when asynchronous task
          */
         removeSiteInfo(spaceId: string, siteInfo: Systems.Site): Promise<Systems.NullResult>;
         /**
          * @description Retrieves the Sites information associated with a Space.
-         * @param space - Space to be queried for Site information
+         * @param spaceId - Space ID to be queried for Site information
          * @param callback - Callback when asynchronous task finishes
          */
         getSitesInfo(spaceId: string): Promise<Systems.SitesCollectionResult>;
         /**
          * @description Updates the space role for a particular user
-         * @param space - The space that the requested user is part of
+         * @param spaceId - The space ID that the requested user is part of
          * @param newUserRoleInfo - New user role information containing the new role for the specified user
          * @param callback - Callback when asynchronous task finishes
          */
         updateUserRole(spaceId: string, newUserRoleInfo: Systems.UserRoleInfo): Promise<Systems.NullResult>;
         /**
          * @description Retrieves the User role information for the User Ids that have been passed in
-         * @param space - Space for which the User Roles will be retrieved
+         * @param spaceId - Space ID for which the User Roles will be retrieved
          * @param requestedUserIds - Array of User Ids for which the User Roles will be retrieved
          * @param callback - Callback when asynchronous task finishes
          */
@@ -11847,20 +12007,20 @@ export declare namespace Systems {
         getSpacesMetadata(spaces: Common.Array<string>): Promise<Systems.SpacesMetadataResult>;
         /**
          * @description Retrieves the Space metadata information
-         * @param space - Space for which the metadata will be retrieved
+         * @param spaceId - Space ID for which the metadata will be retrieved
          * @param callback - Callback when asynchronous task finishes
          */
         getSpaceMetadata(spaceId: string): Promise<Systems.SpaceMetadataResult>;
         /**
          * @description Updates the Space thumbnail image or adds one if it didn't have it previously using FileAssetDataSource
-         * @param space - Space for which the thumbnail will be updated
+         * @param spaceId - Space ID for which the thumbnail will be updated
          * @param newThumbnail - New thumbnail information
          * @param callback - Callback when asynchronous task finishes
          */
         updateSpaceThumbnail(spaceId: string, newThumbnail: Systems.FileAssetDataSource): Promise<Systems.NullResult>;
         /**
          * @description Updates the Space thumbnail image or adds one if it didn't have it previously using BufferAssetDataSource
-         * @param space - Space for which the thumbnail will be updated
+         * @param spaceId - Space ID for which the thumbnail will be updated
          * @param newThumbnail - New thumbnail information
          * @param callback - Callback when asynchronous task finishes
          */
@@ -11869,20 +12029,20 @@ export declare namespace Systems {
          * @description Retrieves the space thumbnail information associated with the space
          * If the space does not have a thumbnail associated with it the result callback will be successful, the HTTP res code will be ResponseNotFound
          * and the Uri field inside the UriResult will be empty
-         * @param space - Space for which the thumbnail information will be retrieved
+         * @param spaceId - Space ID for which the thumbnail information will be retrieved
          * @param callback - Callback when asynchronous task finishes
          */
         getSpaceThumbnail(spaceId: string): Promise<Systems.UriResult>;
         /**
          * @description Adds user to group banned list. Banned list can be retrieved from the space
-         * @param space - Space for which the ban will be issued on
+         * @param spaceId - Space ID for which the ban will be issued on
          * @param requestedUserId - User id to be banned from the space
          * @param callback - Callback when asynchronous task finishes
          */
         addUserToSpaceBanList(spaceId: string, requestedUserId: string): Promise<Systems.NullResult>;
         /**
          * @description Deletes user from group banned list. Banned list can be retrieved from the space
-         * @param space - Space for which the Space for which the ban will be removed on
+         * @param spaceId - Space ID for which the Space for which the ban will be removed on
          * @param requestedUserId - User id to have ban removed from the space
          * @param callback - Callback when asynchronous task finishes
          */