1. Home
  2. WebAR
  3. What is a component

What is a component

Each component has a name, a status and a list of error codes.

Each component has at least the following apis :

  • checkCompatibility : boolean

returns true if the component is compatible with the smartphone and browser.

  • getStatus(): number

corresponding to its status

  • getState(): json

returns context information

  • canStart(): Boolean

true if component can be started.
For instance if Reco is being processing a demand to the online database, it will return false until the demand is complete.

  • start() :void

    Starts the component

  • stop() :void

    Stops the component

  • render():void

    called at every frame by the orchestrator

Status is a number from the following list :

  • LOADING, -READY,
  • STARTED,
  • RUNNING,
  • PAUSED,
  • SUCCEEDED,
  • FAILED,
  • COMPLETED
Was this article helpful to you? Yes No

How can we help?