Skip to content

Commit df016d0

Browse files
authored
chore: Added more XR deprecation warnings (#10977)
1 parent d3bc119 commit df016d0

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

packages/xr/src/Providers/SumerianProvider.ts

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,17 @@ const SUMERIAN_DEPRECATION_MESSAGE =
2525

2626
const logger = new Logger('SumerianProvider');
2727

28+
/**
29+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
30+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
31+
* and as a result, will no longer be available.
32+
*/
2833
export class SumerianProvider extends AbstractXRProvider {
34+
/**
35+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
36+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
37+
* and as a result, will no longer be available.
38+
*/
2939
constructor(options: ProviderOptions = {}) {
3040
super(options);
3141
}
@@ -51,6 +61,11 @@ export class SumerianProvider extends AbstractXRProvider {
5161
});
5262
}
5363

64+
/**
65+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
66+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
67+
* and as a result, will no longer be available.
68+
*/
5469
public async loadScene(
5570
sceneName: string,
5671
domElementId: string,
@@ -216,6 +231,11 @@ export class SumerianProvider extends AbstractXRProvider {
216231
}
217232
}
218233

234+
/**
235+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
236+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
237+
* and as a result, will no longer be available.
238+
*/
219239
public isSceneLoaded(sceneName: string) {
220240
const scene = this.getScene(sceneName);
221241
return scene.isLoaded || false;
@@ -243,6 +263,11 @@ export class SumerianProvider extends AbstractXRProvider {
243263
return this.options.scenes[sceneName];
244264
}
245265

266+
/**
267+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
268+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
269+
* and as a result, will no longer be available.
270+
*/
246271
public getSceneController(sceneName: string) {
247272
if (!this.options.scenes) {
248273
const errorMsg = 'No scenes were defined in the configuration';
@@ -267,41 +292,81 @@ export class SumerianProvider extends AbstractXRProvider {
267292
return sceneController;
268293
}
269294

295+
/**
296+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
297+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
298+
* and as a result, will no longer be available.
299+
*/
270300
public isVRCapable(sceneName: string): boolean {
271301
const sceneController = this.getSceneController(sceneName);
272302
return sceneController.vrCapable;
273303
}
274304

305+
/**
306+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
307+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
308+
* and as a result, will no longer be available.
309+
*/
275310
public isVRPresentationActive(sceneName: string): boolean {
276311
const sceneController = this.getSceneController(sceneName);
277312
return sceneController.vrPresentationActive;
278313
}
279314

315+
/**
316+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
317+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
318+
* and as a result, will no longer be available.
319+
*/
280320
public start(sceneName: string) {
281321
const sceneController = this.getSceneController(sceneName);
282322
sceneController.start();
283323
}
284324

325+
/**
326+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
327+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
328+
* and as a result, will no longer be available.
329+
*/
285330
public enterVR(sceneName: string) {
286331
const sceneController = this.getSceneController(sceneName);
287332
sceneController.enterVR();
288333
}
289334

335+
/**
336+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
337+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
338+
* and as a result, will no longer be available.
339+
*/
290340
public exitVR(sceneName: string) {
291341
const sceneController = this.getSceneController(sceneName);
292342
sceneController.exitVR();
293343
}
294344

345+
/**
346+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
347+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
348+
* and as a result, will no longer be available.
349+
*/
295350
public isMuted(sceneName: string): boolean {
296351
const sceneController = this.getSceneController(sceneName);
297352
return sceneController.muted;
298353
}
299354

355+
/**
356+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
357+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
358+
* and as a result, will no longer be available.
359+
*/
300360
public setMuted(sceneName: string, muted: boolean) {
301361
const sceneController = this.getSceneController(sceneName);
302362
sceneController.muted = muted;
303363
}
304364

365+
/**
366+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
367+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
368+
* and as a result, will no longer be available.
369+
*/
305370
public onSceneEvent(
306371
sceneName: string,
307372
eventName: string,
@@ -311,6 +376,11 @@ export class SumerianProvider extends AbstractXRProvider {
311376
sceneController.on(eventName, eventHandler);
312377
}
313378

379+
/**
380+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
381+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
382+
* and as a result, will no longer be available.
383+
*/
314384
public enableAudio(sceneName: string) {
315385
const sceneController = this.getSceneController(sceneName);
316386
sceneController.enableAudio();

packages/xr/src/XR.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ const logger = new Logger('XR');
99

1010
const DEFAULT_PROVIDER_NAME = 'SumerianProvider';
1111

12+
/**
13+
* @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
14+
* available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
15+
* and as a result, will no longer be available.
16+
*/
1217
export class XRClass {
1318
private _options: XROptions;
1419

0 commit comments

Comments
 (0)