@aws-amplify/xr

constructor

constructor(options?: ProviderOptions);

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method enableAudio

enableAudio: (sceneName: string) => void;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method enterVR

enterVR: (sceneName: string) => void;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method exitVR

exitVR: (sceneName: string) => void;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method getProviderName

getProviderName: () => string;

method getSceneController

getSceneController: (sceneName: string) => any;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method isMuted

isMuted: (sceneName: string) => boolean;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method isSceneLoaded

isSceneLoaded: (sceneName: string) => any;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method isVRCapable

isVRCapable: (sceneName: string) => boolean;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method isVRPresentationActive

isVRPresentationActive: (sceneName: string) => boolean;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method loadScene

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

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method onSceneEvent

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

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method setMuted

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

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.

method start

start: (sceneName: string) => void;

• Deprecated

  The Amazon Sumerian service is no longer accepting new customers. Existing customer scenes will not be available after February 21, 2023. The AWS Amplify XR features depend on the Amazon Sumerian service to function and as a result, will no longer be available.