• Version 4.0.4
  • Published
  • 168 kB
  • 2 dependencies
  • Apache-2.0 license


npm i @aws-amplify/xr
yarn add @aws-amplify/xr
pnpm add @aws-amplify/xr


XR category of aws-amplify



variable XR

const XR: XRClass;


    class SumerianProvider

    class SumerianProvider extends AbstractXRProvider {}


      constructor(options?: ProviderOptions);

        method enableAudio

        enableAudio: (sceneName: string) => void;

          method enterVR

          enterVR: (sceneName: string) => void;

            method exitVR

            exitVR: (sceneName: string) => void;

              method getProviderName

              getProviderName: () => string;

                method getSceneController

                getSceneController: (sceneName: string) => any;

                  method isMuted

                  isMuted: (sceneName: string) => boolean;

                    method isSceneLoaded

                    isSceneLoaded: (sceneName: string) => any;

                      method isVRCapable

                      isVRCapable: (sceneName: string) => boolean;

                        method isVRPresentationActive

                        isVRPresentationActive: (sceneName: string) => boolean;

                          method loadScene

                          loadScene: (
                          sceneName: string,
                          domElementId: string,
                          sceneOptions: SumerianSceneOptions
                          ) => Promise<void>;

                            method onSceneEvent

                            onSceneEvent: (
                            sceneName: string,
                            eventName: string,
                            eventHandler: Function
                            ) => void;

                              method setMuted

                              setMuted: (sceneName: string, muted: boolean) => void;

                                method start

                                start: (sceneName: string) => void;

                                  class XRError

                                  class XRError extends Error {}

                                    class XRNoDomElement

                                    class XRNoDomElement extends XRError {}

                                      class XRNoSceneConfiguredError

                                      class XRNoSceneConfiguredError extends XRError {}

                                        class XRProviderNotConfigured

                                        class XRProviderNotConfigured extends XRError {}

                                          class XRSceneLoadFailure

                                          class XRSceneLoadFailure extends XRError {}

                                            class XRSceneNotFoundError

                                            class XRSceneNotFoundError extends XRError {}

                                              class XRSceneNotLoadedError

                                              class XRSceneNotLoadedError extends XRError {}

                                                Package Files (4)

                                                Dependencies (2)

                                                Dev Dependencies (0)

                                                No dev dependencies.

                                                Peer Dependencies (0)

                                                No peer dependencies.


                                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-amplify/xr.

                                                • Markdown
                                                • HTML
                                                  <a href="https://www.jsdocs.io/package/@aws-amplify/xr"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>