connected-spaces-platform.web 6.0.0 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -373,6 +373,22 @@ function csp_web_EResponseCodesFactory(
373
373
  }
374
374
  ProxyClassFactories["csp_web_EResponseCodes"] = csp_web_EResponseCodesFactory;
375
375
 
376
+ function csp_multiplayer_AvatarStateFactory(
377
+ nativePointer: NativePointer,
378
+ ): Multiplayer.AvatarState {
379
+ return nativePointer.pointer as Multiplayer.AvatarState;
380
+ }
381
+ ProxyClassFactories["csp_multiplayer_AvatarState"] =
382
+ csp_multiplayer_AvatarStateFactory;
383
+
384
+ function csp_multiplayer_AvatarPlayModeFactory(
385
+ nativePointer: NativePointer,
386
+ ): Multiplayer.AvatarPlayMode {
387
+ return nativePointer.pointer as Multiplayer.AvatarPlayMode;
388
+ }
389
+ ProxyClassFactories["csp_multiplayer_AvatarPlayMode"] =
390
+ csp_multiplayer_AvatarPlayModeFactory;
391
+
376
392
  function csp_multiplayer_ErrorCodeFactory(
377
393
  nativePointer: NativePointer,
378
394
  ): Multiplayer.ErrorCode {
@@ -522,22 +538,6 @@ function csp_multiplayer_AudioPropertyKeysFactory(
522
538
  ProxyClassFactories["csp_multiplayer_AudioPropertyKeys"] =
523
539
  csp_multiplayer_AudioPropertyKeysFactory;
524
540
 
525
- function csp_multiplayer_AvatarStateFactory(
526
- nativePointer: NativePointer,
527
- ): Multiplayer.AvatarState {
528
- return nativePointer.pointer as Multiplayer.AvatarState;
529
- }
530
- ProxyClassFactories["csp_multiplayer_AvatarState"] =
531
- csp_multiplayer_AvatarStateFactory;
532
-
533
- function csp_multiplayer_AvatarPlayModeFactory(
534
- nativePointer: NativePointer,
535
- ): Multiplayer.AvatarPlayMode {
536
- return nativePointer.pointer as Multiplayer.AvatarPlayMode;
537
- }
538
- ProxyClassFactories["csp_multiplayer_AvatarPlayMode"] =
539
- csp_multiplayer_AvatarPlayModeFactory;
540
-
541
541
  function csp_multiplayer_LocomotionModelFactory(
542
542
  nativePointer: NativePointer,
543
543
  ): Multiplayer.LocomotionModel {
@@ -753,6 +753,14 @@ function csp_multiplayer_ReflectionShapeFactory(
753
753
  ProxyClassFactories["csp_multiplayer_ReflectionShape"] =
754
754
  csp_multiplayer_ReflectionShapeFactory;
755
755
 
756
+ function csp_multiplayer_ScreenSharingPropertyKeysFactory(
757
+ nativePointer: NativePointer,
758
+ ): Multiplayer.ScreenSharingPropertyKeys {
759
+ return nativePointer.pointer as Multiplayer.ScreenSharingPropertyKeys;
760
+ }
761
+ ProxyClassFactories["csp_multiplayer_ScreenSharingPropertyKeys"] =
762
+ csp_multiplayer_ScreenSharingPropertyKeysFactory;
763
+
756
764
  function csp_multiplayer_ScriptScopeFactory(
757
765
  nativePointer: NativePointer,
758
766
  ): Multiplayer.ScriptScope {
@@ -1846,6 +1854,14 @@ function csp_multiplayer_ReflectionSpaceComponentFactory(
1846
1854
  ProxyClassFactories["csp_multiplayer_ReflectionSpaceComponent"] =
1847
1855
  csp_multiplayer_ReflectionSpaceComponentFactory;
1848
1856
 
1857
+ function csp_multiplayer_ScreenSharingSpaceComponentFactory(
1858
+ nativePointer: NativePointer,
1859
+ ): NativeClassWrapper {
1860
+ return new Multiplayer.ScreenSharingSpaceComponent(nativePointer);
1861
+ }
1862
+ ProxyClassFactories["csp_multiplayer_ScreenSharingSpaceComponent"] =
1863
+ csp_multiplayer_ScreenSharingSpaceComponentFactory;
1864
+
1849
1865
  function csp_multiplayer_ScriptSpaceComponentFactory(
1850
1866
  nativePointer: NativePointer,
1851
1867
  ): NativeClassWrapper {
@@ -3397,6 +3413,35 @@ export namespace Web {
3397
3413
  }
3398
3414
  }
3399
3415
 
3416
+ export namespace Multiplayer {
3417
+ /**
3418
+ * @description Enumerates the supported states for an avatar.
3419
+ * These are used to establish the related animation that the avatar will use on its state machine.
3420
+ */
3421
+ export enum AvatarState {
3422
+ Idle = 0,
3423
+ Walking,
3424
+ Running,
3425
+ Flying,
3426
+ Jumping,
3427
+ Falling,
3428
+ Num,
3429
+ }
3430
+ }
3431
+
3432
+ export namespace Multiplayer {
3433
+ /**
3434
+ * @description Enumerates the supported play mode for the avatar.
3435
+ */
3436
+ export enum AvatarPlayMode {
3437
+ Default = 0,
3438
+ AR,
3439
+ VR,
3440
+ Creator,
3441
+ Num,
3442
+ }
3443
+ }
3444
+
3400
3445
  export namespace Multiplayer {
3401
3446
  /**
3402
3447
  * @description Enum used to indicate the failure state of a multiplayer request.
@@ -3550,6 +3595,7 @@ export namespace Multiplayer {
3550
3595
  Text = 25,
3551
3596
  Hotspot = 26,
3552
3597
  CinematicCamera = 27,
3598
+ ScreenSharing = 28,
3553
3599
  //,
3554
3600
  spare,
3555
3601
  values,
@@ -3734,35 +3780,6 @@ export namespace Multiplayer {
3734
3780
  }
3735
3781
  }
3736
3782
 
3737
- export namespace Multiplayer {
3738
- /**
3739
- * @description Enumerates the supported states for an avatar.
3740
- * These are used to establish the related animation that the avatar will use on its state machine.
3741
- */
3742
- export enum AvatarState {
3743
- Idle = 0,
3744
- Walking,
3745
- Running,
3746
- Flying,
3747
- Jumping,
3748
- Falling,
3749
- Num,
3750
- }
3751
- }
3752
-
3753
- export namespace Multiplayer {
3754
- /**
3755
- * @description Enumerates the supported play mode for the avatar.
3756
- */
3757
- export enum AvatarPlayMode {
3758
- Default = 0,
3759
- AR,
3760
- VR,
3761
- Creator,
3762
- Num,
3763
- }
3764
- }
3765
-
3766
3783
  export namespace Multiplayer {
3767
3784
  /**
3768
3785
  * @description Enumerates the supported locomotion models available for the avatar movements.
@@ -4179,6 +4196,25 @@ export namespace Multiplayer {
4179
4196
  }
4180
4197
  }
4181
4198
 
4199
+ export namespace Multiplayer {
4200
+ /**
4201
+ * @description Enumerates the list of properties that can be replicated for a screen sharing component.
4202
+ */
4203
+ export enum ScreenSharingPropertyKeys {
4204
+ Position = 0,
4205
+ Rotation,
4206
+ Scale,
4207
+ IsVisible,
4208
+ IsARVisible,
4209
+ IsShadowCaster,
4210
+ UserId,
4211
+ DefaultImageCollectionId,
4212
+ DefaultImageAssetId,
4213
+ AttenuationRadius,
4214
+ Num,
4215
+ }
4216
+ }
4217
+
4182
4218
  export namespace Multiplayer {
4183
4219
  /**
4184
4220
  * @description Enumerates the supported scopes of a script.
@@ -22993,7 +23029,7 @@ export namespace Common {
22993
23029
  _callbackPtr = Module.addFunction(_callback, "vii");
22994
23030
 
22995
23031
  Module.ccall(
22996
- "csp_common_IRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarStateRC_StringRC_AvatarPlayModeRC_EntityCreatedCallback",
23032
+ "csp_common_IRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarState_StringRC_AvatarPlayMode_EntityCreatedCallback",
22997
23033
  "void",
22998
23034
  [
22999
23035
  "number",
@@ -35278,7 +35314,7 @@ export namespace Multiplayer {
35278
35314
  _callbackPtr = Module.addFunction(_callback, "vii");
35279
35315
 
35280
35316
  Module.ccall(
35281
- "csp_multiplayer_OnlineRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarStateRC_StringRC_AvatarPlayModeRC_EntityCreatedCallback",
35317
+ "csp_multiplayer_OnlineRealtimeEngine_CreateAvatar_void_StringRC_StringRC_SpaceTransformRC_bool_AvatarState_StringRC_AvatarPlayMode_EntityCreatedCallback",
35282
35318
  "void",
35283
35319
  [
35284
35320
  "number",
@@ -44017,6 +44053,440 @@ export namespace Multiplayer {
44017
44053
  }
44018
44054
  }
44019
44055
 
44056
+ export namespace Multiplayer {
44057
+ /**
44058
+ @ingroup ScreenSharingSpaceComponent
44059
+ * @description Enables screen sharing within the space.
44060
+ * /// The screen sharing component facilitates the sharing of a user's screen within a space.
44061
+ * The component itself does not make assumptions about the mechanism by which the screen is shared.
44062
+ * It provides properties to define a default image to be displayed when no users are
44063
+ * sharing their screen, as well a UserId property to store the Id of the user currently sharing their screen.
44064
+ */
44065
+ export class ScreenSharingSpaceComponent
44066
+ extends Multiplayer.ComponentBase
44067
+ implements
44068
+ Multiplayer.IShadowCasterComponent,
44069
+ Multiplayer.ITransformComponent,
44070
+ Multiplayer.IVisibleComponent,
44071
+ INativeResource
44072
+ {
44073
+ /** @internal */
44074
+ constructor(pointer: NativePointer) {
44075
+ super(pointer);
44076
+ }
44077
+
44078
+ static fromComponentBase(
44079
+ baseInstance: Multiplayer.ComponentBase,
44080
+ ): Multiplayer.ScreenSharingSpaceComponent {
44081
+ const nativeClassWrapper = baseInstance as unknown as NativeClassWrapper;
44082
+ return new Multiplayer.ScreenSharingSpaceComponent(
44083
+ new NativePointer(
44084
+ nativeClassWrapper.pointer,
44085
+ nativeClassWrapper.ownsPointer,
44086
+ ),
44087
+ );
44088
+ }
44089
+
44090
+ /**
44091
+ * @description Constructs the screen sharing component, and associates it with the specified Parent space entity.
44092
+ * @param parent - The Space entity that owns this component.
44093
+ */
44094
+ static create_logSystem_parent(
44095
+ logSystem: Common.LogSystem,
44096
+ parent: Multiplayer.SpaceEntity,
44097
+ ): ScreenSharingSpaceComponent {
44098
+ var _ptr = Module._malloc(8);
44099
+ Module.ccall(
44100
+ "csp_multiplayer_ScreenSharingSpaceComponent_Ctor_LogSystemP_SpaceEntityP",
44101
+ "void",
44102
+ ["number", "number", "number"],
44103
+ [_ptr, logSystem.pointer, parent.pointer],
44104
+ );
44105
+ var _nPtr = getNativePointer(_ptr);
44106
+
44107
+ return new ScreenSharingSpaceComponent(_nPtr);
44108
+ }
44109
+
44110
+ /**
44111
+ * @description Gets the ID of the user who is currently sharing their screen to this component.
44112
+ * NOTE: An empty string means that no user is currently sharing their screen to this component.
44113
+ * @return The ID of the user who is currently sharing their screen to this component.
44114
+ */
44115
+
44116
+ getUserId(): string {
44117
+ let _result = Module.ccall(
44118
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetUserIdC_StringRC",
44119
+ "number",
44120
+ ["number"],
44121
+ [this.pointer],
44122
+ );
44123
+
44124
+ const _resultString = Module.UTF8ToString(_result);
44125
+ free(_result);
44126
+
44127
+ _result = _resultString;
44128
+
44129
+ return _result;
44130
+ }
44131
+
44132
+ /**
44133
+ * @description Sets the ID of the user who is sharing their screen to this component.
44134
+ * @param value - The ID of the user who is sharing their screen to this component. This must be set to an empty string when
44135
+ * the user finishes sharing.
44136
+ */
44137
+
44138
+ setUserId(value: string): void {
44139
+ Module.ccall(
44140
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetUserId_void_StringRC",
44141
+ "void",
44142
+ ["number", "string"],
44143
+ [this.pointer, value],
44144
+ );
44145
+ }
44146
+
44147
+ /**
44148
+ * @description Gets the ID of the asset collection associated with the default image for this component.
44149
+ * NOTE: To retrieve this component's default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.
44150
+ * @return The ID of the default image asset collection associated with this component.
44151
+ */
44152
+
44153
+ getDefaultImageCollectionId(): string {
44154
+ let _result = Module.ccall(
44155
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetDefaultImageCollectionIdC_StringRC",
44156
+ "number",
44157
+ ["number"],
44158
+ [this.pointer],
44159
+ );
44160
+
44161
+ const _resultString = Module.UTF8ToString(_result);
44162
+ free(_result);
44163
+
44164
+ _result = _resultString;
44165
+
44166
+ return _result;
44167
+ }
44168
+
44169
+ /**
44170
+ * @description Sets the ID of the asset collection associated with the default image for this component.
44171
+ * NOTE: To retrieve this component's default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.
44172
+ * @param value - The ID of the default image asset collection associated with this component.
44173
+ */
44174
+
44175
+ setDefaultImageCollectionId(value: string): void {
44176
+ Module.ccall(
44177
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetDefaultImageCollectionId_void_StringRC",
44178
+ "void",
44179
+ ["number", "string"],
44180
+ [this.pointer, value],
44181
+ );
44182
+ }
44183
+
44184
+ /**
44185
+ * @description Gets the ID of the asset associated with the default image for this component.
44186
+ * NOTE: To retrieve this component's default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.
44187
+ * @return The ID of the default image asset associated with this component.
44188
+ */
44189
+
44190
+ getDefaultImageAssetId(): string {
44191
+ let _result = Module.ccall(
44192
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetDefaultImageAssetIdC_StringRC",
44193
+ "number",
44194
+ ["number"],
44195
+ [this.pointer],
44196
+ );
44197
+
44198
+ const _resultString = Module.UTF8ToString(_result);
44199
+ free(_result);
44200
+
44201
+ _result = _resultString;
44202
+
44203
+ return _result;
44204
+ }
44205
+
44206
+ /**
44207
+ * @description Sets the ID of the asset associated with the default image for this component.
44208
+ * NOTE: To retrieve this component's default image, both the DefaultImageCollectionId and the DefaultImageAssetId are required.
44209
+ * @param value - The ID of the default image asset associated with this component.
44210
+ */
44211
+
44212
+ setDefaultImageAssetId(value: string): void {
44213
+ Module.ccall(
44214
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetDefaultImageAssetId_void_StringRC",
44215
+ "void",
44216
+ ["number", "string"],
44217
+ [this.pointer, value],
44218
+ );
44219
+ }
44220
+
44221
+ /**
44222
+ * @description Gets the radius from this component origin within which the audio of this video can be heard by the user.
44223
+ * NOTE: Only when the user position is within this radius the audio of the video should be heard.
44224
+ * @return The radius within which the audio of the video can be heard by the user.
44225
+ */
44226
+
44227
+ getAttenuationRadius(): number {
44228
+ let _result = Module.ccall(
44229
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetAttenuationRadiusC_float",
44230
+ "number",
44231
+ ["number"],
44232
+ [this.pointer],
44233
+ );
44234
+
44235
+ return _result;
44236
+ }
44237
+
44238
+ /**
44239
+ * @description Sets the radius from this component origin within which the audio of this video can be heard by the user.
44240
+ * NOTE: Only when the user position is within this radius the audio of the video should be heard.
44241
+ * @param value - The radius within which the audio of the video can be heard by the user.
44242
+ */
44243
+
44244
+ setAttenuationRadius(value: number): void {
44245
+ assert(value >= Limits.FLOAT_MIN);
44246
+ assert(value <= Limits.FLOAT_MAX);
44247
+
44248
+ Module.ccall(
44249
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetAttenuationRadius_void_float",
44250
+ "void",
44251
+ ["number", "number"],
44252
+ [this.pointer, value],
44253
+ );
44254
+ }
44255
+
44256
+ /**
44257
+ * \addtogroup ITransformComponent
44258
+ @{
44259
+ @copydoc IPositionComponent::GetPosition()
44260
+ */
44261
+
44262
+ getPosition(): Common.Vector3 {
44263
+ var _ret = Module._malloc(8);
44264
+
44265
+ Module.ccall(
44266
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetPositionC_Vector3RC",
44267
+ "void",
44268
+ ["number", "number"],
44269
+ [_ret, this.pointer],
44270
+ );
44271
+ var _nPtr = new Common.Vector3(getNativePointer(_ret));
44272
+ Module._free(_ret);
44273
+
44274
+ return _nPtr;
44275
+ }
44276
+
44277
+ /**
44278
+ @copydoc IPositionComponent::SetPosition()
44279
+ */
44280
+
44281
+ setPosition(value: Common.Vector3): void {
44282
+ Module.ccall(
44283
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetPosition_void_Vector3RC",
44284
+ "void",
44285
+ ["number", "number"],
44286
+ [this.pointer, value.pointer],
44287
+ );
44288
+ }
44289
+
44290
+ /**
44291
+ @copydoc IRotationComponent::GetRotation()
44292
+ */
44293
+
44294
+ getRotation(): Common.Vector4 {
44295
+ var _ret = Module._malloc(8);
44296
+
44297
+ Module.ccall(
44298
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetRotationC_Vector4RC",
44299
+ "void",
44300
+ ["number", "number"],
44301
+ [_ret, this.pointer],
44302
+ );
44303
+ var _nPtr = new Common.Vector4(getNativePointer(_ret));
44304
+ Module._free(_ret);
44305
+
44306
+ return _nPtr;
44307
+ }
44308
+
44309
+ /**
44310
+ @copydoc IRotationComponent::SetRotation()
44311
+ */
44312
+
44313
+ setRotation(value: Common.Vector4): void {
44314
+ Module.ccall(
44315
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetRotation_void_Vector4RC",
44316
+ "void",
44317
+ ["number", "number"],
44318
+ [this.pointer, value.pointer],
44319
+ );
44320
+ }
44321
+
44322
+ /**
44323
+ @copydoc IScaleComponent::GetScale()
44324
+ */
44325
+
44326
+ getScale(): Common.Vector3 {
44327
+ var _ret = Module._malloc(8);
44328
+
44329
+ Module.ccall(
44330
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetScaleC_Vector3RC",
44331
+ "void",
44332
+ ["number", "number"],
44333
+ [_ret, this.pointer],
44334
+ );
44335
+ var _nPtr = new Common.Vector3(getNativePointer(_ret));
44336
+ Module._free(_ret);
44337
+
44338
+ return _nPtr;
44339
+ }
44340
+
44341
+ /**
44342
+ @copydoc IScaleComponent::SetScale()
44343
+ */
44344
+
44345
+ setScale(value: Common.Vector3): void {
44346
+ Module.ccall(
44347
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetScale_void_Vector3RC",
44348
+ "void",
44349
+ ["number", "number"],
44350
+ [this.pointer, value.pointer],
44351
+ );
44352
+ }
44353
+
44354
+ /**
44355
+ @copydoc ITransformComponent::GetTransform()
44356
+ */
44357
+
44358
+ getTransform(): Multiplayer.SpaceTransform {
44359
+ var _ret = Module._malloc(8);
44360
+
44361
+ Module.ccall(
44362
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetTransformC_SpaceTransform",
44363
+ "void",
44364
+ ["number", "number"],
44365
+ [_ret, this.pointer],
44366
+ );
44367
+ var _nPtr = new Multiplayer.SpaceTransform(getNativePointer(_ret));
44368
+ Module._free(_ret);
44369
+ return _nPtr;
44370
+ }
44371
+
44372
+ /**
44373
+ @copydoc ITransformComonent::SetTransform()
44374
+ */
44375
+
44376
+ setTransform(value: Multiplayer.SpaceTransform): void {
44377
+ Module.ccall(
44378
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetTransform_void_SpaceTransformRC",
44379
+ "void",
44380
+ ["number", "number"],
44381
+ [this.pointer, value.pointer],
44382
+ );
44383
+ }
44384
+
44385
+ /**
44386
+ @}
44387
+ * \addtogroup IVisibleComponent
44388
+ @{
44389
+ @copydoc IVisibleComponent::GetIsVisible()
44390
+ */
44391
+
44392
+ getIsVisible(): boolean {
44393
+ let _result = Module.ccall(
44394
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetIsVisibleC_bool",
44395
+ "boolean",
44396
+ ["number"],
44397
+ [this.pointer],
44398
+ );
44399
+
44400
+ return _result;
44401
+ }
44402
+
44403
+ /**
44404
+ @copydoc IVisibleComponent::SetIsVisible()
44405
+ */
44406
+
44407
+ setIsVisible(value: boolean): void {
44408
+ Module.ccall(
44409
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetIsVisible_void_bool",
44410
+ "void",
44411
+ ["number", "boolean"],
44412
+ [this.pointer, value],
44413
+ );
44414
+ }
44415
+
44416
+ /**
44417
+ @copydoc IVisibleComponent::GetIsARVisible()
44418
+ */
44419
+
44420
+ getIsARVisible(): boolean {
44421
+ let _result = Module.ccall(
44422
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetIsARVisibleC_bool",
44423
+ "boolean",
44424
+ ["number"],
44425
+ [this.pointer],
44426
+ );
44427
+
44428
+ return _result;
44429
+ }
44430
+
44431
+ /**
44432
+ @copydoc IVisibleComponent::SetIsARVisible()
44433
+ */
44434
+
44435
+ setIsARVisible(value: boolean): void {
44436
+ Module.ccall(
44437
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetIsARVisible_void_bool",
44438
+ "void",
44439
+ ["number", "boolean"],
44440
+ [this.pointer, value],
44441
+ );
44442
+ }
44443
+
44444
+ /**
44445
+ @}
44446
+ * \addtogroup IShadowCasterComponent
44447
+ @{
44448
+ @copydoc IShadowCasterComponent::GetIsShadowCaster()
44449
+ */
44450
+
44451
+ getIsShadowCaster(): boolean {
44452
+ let _result = Module.ccall(
44453
+ "csp_multiplayer_ScreenSharingSpaceComponent_GetIsShadowCasterC_bool",
44454
+ "boolean",
44455
+ ["number"],
44456
+ [this.pointer],
44457
+ );
44458
+
44459
+ return _result;
44460
+ }
44461
+
44462
+ /**
44463
+ @copydoc IShadowCasterComponent::SetIsShadowCaster()
44464
+ */
44465
+
44466
+ setIsShadowCaster(value: boolean): void {
44467
+ Module.ccall(
44468
+ "csp_multiplayer_ScreenSharingSpaceComponent_SetIsShadowCaster_void_bool",
44469
+ "void",
44470
+ ["number", "boolean"],
44471
+ [this.pointer, value],
44472
+ );
44473
+ }
44474
+
44475
+ delete(): void {
44476
+ if (this.ownsPointer && !this.disposed) {
44477
+ Module.ccall(
44478
+ "csp_multiplayer_ScreenSharingSpaceComponent_Dtor",
44479
+ "void",
44480
+ ["number"],
44481
+ [this.pointer],
44482
+ );
44483
+
44484
+ this.disposed = true;
44485
+ }
44486
+ }
44487
+ }
44488
+ }
44489
+
44020
44490
  export namespace Multiplayer {
44021
44491
  /**
44022
44492
  @ingroup ScriptSpaceComponent
@@ -54117,7 +54587,7 @@ export namespace Systems {
54117
54587
  }
54118
54588
 
54119
54589
  /**
54120
- * @description A getter which returns the String passed via the result.
54590
+ * @description Returns the type of avatar selected by the user.
54121
54591
  */
54122
54592
 
54123
54593
  getAvatarType(): Systems.AvatarType {
@@ -54131,6 +54601,10 @@ export namespace Systems {
54131
54601
  return _result;
54132
54602
  }
54133
54603
 
54604
+ /**
54605
+ * @description Returns the string used to identify or locate the avatar.
54606
+ */
54607
+
54134
54608
  getAvatarIdentifier(): string {
54135
54609
  let _result = Module.ccall(
54136
54610
  "csp_systems_AvatarInfoResult_GetAvatarIdentifierC_StringRC",
@@ -54147,6 +54621,21 @@ export namespace Systems {
54147
54621
  return _result;
54148
54622
  }
54149
54623
 
54624
+ /**
54625
+ * @description Returns whether or not the user's avatar is intended to be visible or not.
54626
+ */
54627
+
54628
+ getAvatarVisible(): boolean {
54629
+ let _result = Module.ccall(
54630
+ "csp_systems_AvatarInfoResult_GetAvatarVisibleC_bool",
54631
+ "boolean",
54632
+ ["number"],
54633
+ [this.pointer],
54634
+ );
54635
+
54636
+ return _result;
54637
+ }
54638
+
54150
54639
  delete(): void {
54151
54640
  if (this.ownsPointer && !this.disposed) {
54152
54641
  Module.ccall(
@@ -54746,12 +55235,14 @@ export namespace Systems {
54746
55235
  * @description Sets the avatar type and identifier for a user.
54747
55236
  * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
54748
55237
  * @param inIdentifier - A string used to identify or locate the avatar.
55238
+ * @param inAvatarVisible - A bool used to identify whether the user's avatar should be visible or not.
54749
55239
  * @param callback - Callback to call when task finishes.
54750
55240
  */
54751
55241
 
54752
55242
  async setAvatarInfo(
54753
55243
  type: Systems.AvatarType,
54754
55244
  identifier: string,
55245
+ avatarVisible: boolean,
54755
55246
  ): Promise<Systems.NullResult> {
54756
55247
  var _resolve;
54757
55248
 
@@ -54776,10 +55267,10 @@ export namespace Systems {
54776
55267
  _callbackPtr = Module.addFunction(_callback, "vii");
54777
55268
 
54778
55269
  Module.ccall(
54779
- "csp_systems_SettingsSystem_SetAvatarInfo_void_AvatarType_StringRC_NullResultCallback",
55270
+ "csp_systems_SettingsSystem_SetAvatarInfo_void_AvatarType_StringRC_bool_NullResultCallback",
54780
55271
  "void",
54781
- ["number", "number", "string", "number", "number"],
54782
- [this.pointer, type, identifier, _callbackPtr, 0],
55272
+ ["number", "number", "string", "boolean", "number", "number"],
55273
+ [this.pointer, type, identifier, avatarVisible, _callbackPtr, 0],
54783
55274
  );
54784
55275
 
54785
55276
  return _promise;
@@ -55817,7 +56308,7 @@ export namespace Systems {
55817
56308
  * The initial load behaviour will differ based on the concrete IRealtimeEngine passed to this function.
55818
56309
  * If user does not have permission to discover or enter the space, callback will be called with EResultCode::Failed and
55819
56310
  * ERequestFailureReason::UserSpaceAccessDenied
55820
- * @param space - Space to enter into
56311
+ * @param spaceId - Space id to enter into
55821
56312
  * @param realtimeEngine - RealtimeEngine to load the space with. This object belongs to the caller, and does not
55822
56313
  * transfer ownership. Once the space is loaded, the caller should be sure to maintain the lifetime of the RealtimeEngine so long
55823
56314
  * as the space is active. Once the caller has called csp::systems::SpaceSystem::ExitSpace and received the callback, then they are
@@ -56088,7 +56579,7 @@ export namespace Systems {
56088
56579
 
56089
56580
  /**
56090
56581
  * @description Updates the name and/or the description of a Space
56091
- * @param space - The space to update
56582
+ * @param spaceId - The space id to update
56092
56583
  * @param name - If a new name is provided it will be used to update the space name
56093
56584
  * @param description - If a new description is provided it will be used to update the space
56094
56585
  * description
@@ -56166,7 +56657,7 @@ export namespace Systems {
56166
56657
 
56167
56658
  /**
56168
56659
  * @description Deletes a given space and the associated objects that belong to it. Including UserService group, Metadata, and Thumbnail.
56169
- * @param space - Space to delete
56660
+ * @param spaceId - Space id to delete
56170
56661
  * @param callback - Callback when asynchronous task finishes
56171
56662
  */
56172
56663
 
@@ -56504,7 +56995,7 @@ export namespace Systems {
56504
56995
 
56505
56996
  /**
56506
56997
  * @description Invites a given email to a specific space.
56507
- * @param space - Space to invite to
56998
+ * @param spaceId - Space id to invite to
56508
56999
  * @param email - Email to invite to space
56509
57000
  * @param isModeratorRole - If present and true sets the user's role in the space to "moderator", pass false or
56510
57001
  * nullptr to leave role as default
@@ -56582,7 +57073,7 @@ export namespace Systems {
56582
57073
 
56583
57074
  /**
56584
57075
  * @description Invites all the given emails to a specific space.
56585
- * @param space - Space to invite to
57076
+ * @param spaceId - Space id to invite to
56586
57077
  * @param inviteUsers - Collection containing the email link URL and the users to invite with their emails and roles
56587
57078
  * @param callback - Callback when asynchronous task finishes
56588
57079
  */
@@ -56625,7 +57116,7 @@ export namespace Systems {
56625
57116
 
56626
57117
  /**
56627
57118
  * @description Returns an array of obfuscated email addresses, addresses of users that have not yet accepted the space invite
56628
- * @param space - Space for which the invites where sent
57119
+ * @param spaceId - Space ID for which the invites where sent
56629
57120
  * @param callback - Callback when asynchronous task finishes
56630
57121
  */
56631
57122
 
@@ -56666,7 +57157,7 @@ export namespace Systems {
56666
57157
 
56667
57158
  /**
56668
57159
  * @description Returns an array of ids of users that accepted the space invite
56669
- * @param space - Space for which the invites where sent
57160
+ * @param spaceId - Space ID for which the invites where sent
56670
57161
  * @param callback - Callback when asynchronous task finishes
56671
57162
  */
56672
57163
 
@@ -56707,7 +57198,7 @@ export namespace Systems {
56707
57198
 
56708
57199
  /**
56709
57200
  * @description Removes a user from a space by the user's unique ID.
56710
- * @param space - Space to remove user from
57201
+ * @param spaceId - Space id to remove user from
56711
57202
  * @param userId - Unique id of user
56712
57203
  * @param callback - Callback when asynchronous task finishes
56713
57204
  */
@@ -56750,7 +57241,7 @@ export namespace Systems {
56750
57241
 
56751
57242
  /**
56752
57243
  * @description Adds a user to a space by the user's unique ID.
56753
- * @param space - Space to add user to
57244
+ * @param spaceId - Space id to add user to
56754
57245
  * @param userId - Unique id of user
56755
57246
  * @param callback - Callback when asynchronous task finishes
56756
57247
  */
@@ -56793,7 +57284,7 @@ export namespace Systems {
56793
57284
 
56794
57285
  /**
56795
57286
  * @description Creates new Site information and associates it with the Space.
56796
- * @param space - Space to associate the Site information with
57287
+ * @param spaceId - Space ID to associate the Site information with
56797
57288
  * @param siteInfo - Site information to be added
56798
57289
  * @param callback - Callback when asynchronous task finishes
56799
57290
  */
@@ -56836,7 +57327,7 @@ export namespace Systems {
56836
57327
 
56837
57328
  /**
56838
57329
  * @description Removes the Site information from the Space.
56839
- * @param space - Space for which to remove the associated Site information
57330
+ * @param spaceId - Space ID for which to remove the associated Site information
56840
57331
  * @param siteInfo - Site information to be removed
56841
57332
  * @param callback - Callback when asynchronous task
56842
57333
  */
@@ -56879,7 +57370,7 @@ export namespace Systems {
56879
57370
 
56880
57371
  /**
56881
57372
  * @description Retrieves the Sites information associated with a Space.
56882
- * @param space - Space to be queried for Site information
57373
+ * @param spaceId - Space ID to be queried for Site information
56883
57374
  * @param callback - Callback when asynchronous task finishes
56884
57375
  */
56885
57376
 
@@ -56920,7 +57411,7 @@ export namespace Systems {
56920
57411
 
56921
57412
  /**
56922
57413
  * @description Updates the space role for a particular user
56923
- * @param space - The space that the requested user is part of
57414
+ * @param spaceId - The space ID that the requested user is part of
56924
57415
  * @param newUserRoleInfo - New user role information containing the new role for the specified user
56925
57416
  * @param callback - Callback when asynchronous task finishes
56926
57417
  */
@@ -56963,7 +57454,7 @@ export namespace Systems {
56963
57454
 
56964
57455
  /**
56965
57456
  * @description Retrieves the User role information for the User Ids that have been passed in
56966
- * @param space - Space for which the User Roles will be retrieved
57457
+ * @param spaceId - Space ID for which the User Roles will be retrieved
56967
57458
  * @param requestedUserIds - Array of User Ids for which the User Roles will be retrieved
56968
57459
  * @param callback - Callback when asynchronous task finishes
56969
57460
  */
@@ -57090,7 +57581,7 @@ export namespace Systems {
57090
57581
 
57091
57582
  /**
57092
57583
  * @description Retrieves the Space metadata information
57093
- * @param space - Space for which the metadata will be retrieved
57584
+ * @param spaceId - Space ID for which the metadata will be retrieved
57094
57585
  * @param callback - Callback when asynchronous task finishes
57095
57586
  */
57096
57587
 
@@ -57131,7 +57622,7 @@ export namespace Systems {
57131
57622
 
57132
57623
  /**
57133
57624
  * @description Updates the Space thumbnail image or adds one if it didn't have it previously using FileAssetDataSource
57134
- * @param space - Space for which the thumbnail will be updated
57625
+ * @param spaceId - Space ID for which the thumbnail will be updated
57135
57626
  * @param newThumbnail - New thumbnail information
57136
57627
  * @param callback - Callback when asynchronous task finishes
57137
57628
  */
@@ -57174,7 +57665,7 @@ export namespace Systems {
57174
57665
 
57175
57666
  /**
57176
57667
  * @description Updates the Space thumbnail image or adds one if it didn't have it previously using BufferAssetDataSource
57177
- * @param space - Space for which the thumbnail will be updated
57668
+ * @param spaceId - Space ID for which the thumbnail will be updated
57178
57669
  * @param newThumbnail - New thumbnail information
57179
57670
  * @param callback - Callback when asynchronous task finishes
57180
57671
  */
@@ -57219,7 +57710,7 @@ export namespace Systems {
57219
57710
  * @description Retrieves the space thumbnail information associated with the space
57220
57711
  * If the space does not have a thumbnail associated with it the result callback will be successful, the HTTP res code will be ResponseNotFound
57221
57712
  * and the Uri field inside the UriResult will be empty
57222
- * @param space - Space for which the thumbnail information will be retrieved
57713
+ * @param spaceId - Space ID for which the thumbnail information will be retrieved
57223
57714
  * @param callback - Callback when asynchronous task finishes
57224
57715
  */
57225
57716
 
@@ -57258,7 +57749,7 @@ export namespace Systems {
57258
57749
 
57259
57750
  /**
57260
57751
  * @description Adds user to group banned list. Banned list can be retrieved from the space
57261
- * @param space - Space for which the ban will be issued on
57752
+ * @param spaceId - Space ID for which the ban will be issued on
57262
57753
  * @param requestedUserId - User id to be banned from the space
57263
57754
  * @param callback - Callback when asynchronous task finishes
57264
57755
  */
@@ -57301,7 +57792,7 @@ export namespace Systems {
57301
57792
 
57302
57793
  /**
57303
57794
  * @description Deletes user from group banned list. Banned list can be retrieved from the space
57304
- * @param space - Space for which the Space for which the ban will be removed on
57795
+ * @param spaceId - Space ID for which the Space for which the ban will be removed on
57305
57796
  * @param requestedUserId - User id to have ban removed from the space
57306
57797
  * @param callback - Callback when asynchronous task finishes
57307
57798
  */