| 1 | import { XRProvider, XROptions, SceneOptions } from './types';
|
| 2 | /**
|
| 3 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 4 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 5 | * and as a result, will no longer be available.
|
| 6 | */
|
| 7 | export declare class XRClass {
|
| 8 | private _options;
|
| 9 | private _pluggables;
|
| 10 | private _defaultProvider;
|
| 11 | /**
|
| 12 | * Initialize XR with AWS configurations
|
| 13 | *
|
| 14 | * @param {XROptions} options - Configuration object for XR
|
| 15 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 16 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 17 | * and as a result, will no longer be available.
|
| 18 | */
|
| 19 | constructor(options: XROptions);
|
| 20 | /**
|
| 21 | * Configure XR part with configurations
|
| 22 | *
|
| 23 | * @param {XROptions} config - Configuration for XR
|
| 24 | * {Object} - The current configuration
|
| 25 | * The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 26 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 27 | * and as a result, will no longer be available.
|
| 28 | */
|
| 29 | configure(options: XROptions): XROptions;
|
| 30 | /**
|
| 31 | * add plugin into XR category
|
| 32 | * @param {Object} pluggable - an instance of the plugin
|
| 33 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 34 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 35 | * and as a result, will no longer be available.
|
| 36 | */
|
| 37 | addPluggable(pluggable: XRProvider): Promise<object>;
|
| 38 | /**
|
| 39 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 40 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 41 | * and as a result, will no longer be available.
|
| 42 | */
|
| 43 | loadScene(sceneName: string, domElementId: string, sceneOptions?: SceneOptions, provider?: string): Promise<any>;
|
| 44 | /**
|
| 45 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 46 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 47 | * and as a result, will no longer be available.
|
| 48 | */
|
| 49 | isSceneLoaded(sceneName: string, provider?: string): boolean;
|
| 50 | /**
|
| 51 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 52 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 53 | * and as a result, will no longer be available.
|
| 54 | */
|
| 55 | getSceneController(sceneName: string, provider?: string): any;
|
| 56 | /**
|
| 57 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 58 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 59 | * and as a result, will no longer be available.
|
| 60 | */
|
| 61 | isVRCapable(sceneName: string, provider?: string): boolean;
|
| 62 | /**
|
| 63 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 64 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 65 | * and as a result, will no longer be available.
|
| 66 | */
|
| 67 | isVRPresentationActive(sceneName: string, provider?: string): boolean;
|
| 68 | /**
|
| 69 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 70 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 71 | * and as a result, will no longer be available.
|
| 72 | */
|
| 73 | start(sceneName: string, provider?: string): void;
|
| 74 | /**
|
| 75 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 76 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 77 | * and as a result, will no longer be available.
|
| 78 | */
|
| 79 | enterVR(sceneName: string, provider?: string): void;
|
| 80 | /**
|
| 81 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 82 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 83 | * and as a result, will no longer be available.
|
| 84 | */
|
| 85 | exitVR(sceneName: string, provider?: string): void;
|
| 86 | /**
|
| 87 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 88 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 89 | * and as a result, will no longer be available.
|
| 90 | */
|
| 91 | isMuted(sceneName: string, provider?: string): boolean;
|
| 92 | /**
|
| 93 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 94 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 95 | * and as a result, will no longer be available.
|
| 96 | */
|
| 97 | setMuted(sceneName: string, muted: boolean, provider?: string): void;
|
| 98 | /**
|
| 99 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 100 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 101 | * and as a result, will no longer be available.
|
| 102 | */
|
| 103 | onSceneEvent(sceneName: string, eventName: string, eventHandler: Function, provider?: string): void;
|
| 104 | /**
|
| 105 | * @deprecated The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be
|
| 106 | * available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function
|
| 107 | * and as a result, will no longer be available.
|
| 108 | */
|
| 109 | enableAudio(sceneName: string, provider?: string): void;
|
| 110 | }
|
| 111 | export declare const XR: XRClass;
|