UNPKG

1.63 kBTypeScriptView Raw
1import { XRProvider, XROptions, SceneOptions } from './types';
2export declare class XRClass {
3 private _options;
4 private _pluggables;
5 private _defaultProvider;
6 /**
7 * Initialize XR with AWS configurations
8 *
9 * @param {XROptions} options - Configuration object for XR
10 */
11 constructor(options: XROptions);
12 /**
13 * Configure XR part with configurations
14 *
15 * @param {XROptions} config - Configuration for XR
16 * @return {Object} - The current configuration
17 */
18 configure(options: XROptions): XROptions;
19 /**
20 * add plugin into XR category
21 * @param {Object} pluggable - an instance of the plugin
22 */
23 addPluggable(pluggable: XRProvider): Promise<object>;
24 loadScene(sceneName: string, domElementId: string, sceneOptions?: SceneOptions, provider?: string): Promise<any>;
25 isSceneLoaded(sceneName: string, provider?: string): boolean;
26 getSceneController(sceneName: string, provider?: string): any;
27 isVRCapable(sceneName: string, provider?: string): boolean;
28 isVRPresentationActive(sceneName: string, provider?: string): boolean;
29 start(sceneName: string, provider?: string): void;
30 enterVR(sceneName: string, provider?: string): void;
31 exitVR(sceneName: string, provider?: string): void;
32 isMuted(sceneName: string, provider?: string): boolean;
33 setMuted(sceneName: string, muted: boolean, provider?: string): void;
34 onSceneEvent(sceneName: string, eventName: string, eventHandler: Function, provider?: string): void;
35 enableAudio(sceneName: string, provider?: string): void;
36}
37export declare const XR: XRClass;