Prismm Frontend Docs

Appearance

AsSDK Init ​

AsSDK requires an init step to access. This page will describe all the parameters and their function.

Init ​

ts
import { AsSDK } from '@allseated-registry/framework/sdk';

AsSDK.init({
  // ...params
});

callOperator ​

CallOperator is a class in charge of handlings calls. There are currently multiple CallOperators that extend the base class CallOperator, such as ExvoCallOperator and VopsCallOperator.

localUser ​

LocalUser, formerly known as MoMe, is a class in charge of handling the local user. It handles the status of the user and his connection to the entity (such as Avatar) if he has one. For some products it's also in charge of sending certain logs in some products. There are currently multiple LocalUsers that extend the base class LocalUser, such as ExvoLocalUser and VVLocalUser.

playerController ​

PlayerController is in charge of movement, in some cases wether it's through Matterport/2D.

statistic ​

Statistic is the class in charge of sending statistics to the server. The base class is overridden to change the base parameters of the logs, or to listen to and send specific logs from EventListener. There are currently multiple Statistics that extend the base class Stats, such as ExvoStats.

firebaseConfig ​

FirebaseConfig is the class in charge of handling the firebase configuration. It's used to initialize the firebase app and to get the firebase database. Each SDK user should use their own FB, and not all sit under "collaboration-allseated".?

googleKey ​

GoogleSSO Key. This is the key used to initialize the Google SSO.

facebookKey ​

Facebook SSO Key. This is the key used to initialize the Facebook SSO.

cloudURL ​

Cloud URL. This is the URL used to initialize the cloud. Right now it is allseated-res-cloudinary.com

serviceURL ​

The azure service url where all of your services will be held. Right now it's prod.as.cluster

alternateURLs ​

An alternative list of URLS for the services. This is used in case the main URL is down, or you want to use a different version like dev.

firstPersonInitializer ​

Allows you to override the default FirstPerson with a custom one. The type for it is (iCamera: PerspectiveCamera) => FirstPerson. CurveCreator and Photographer both override this initializer.

flyViewInitializer ​

If you want to override the default FlyView (for instance with an ExvoFlyView). The type for it is (iCamera: PerspectiveCamera) => FlyView.