Skip to main content


PlayCanvas ( is an open-source 3D game engine/interactive 3D application engine alongside a proprietary cloud-hosted creation platform that allows for simultaneous editing from multiple computers via a browser-based interface.


Provides an integration that interfaces with the PlayCanvas environment and lifecycle to drive the PlayCanvas camera to do virtual overlays.


runOpens the camera with the specified Pipeline Modules and starts running in a PlayCanvas scene.
runXr (deprecated)Opens the camera and starts running World Tracking and/or Image Tracking in a PlayCanvas scene.
runFaceEffects (deprecated)Opens the camera and starts running Face Effects in a PlayCanvas scene.
stopRemove the modules added in run and stop the camera.
stopXr (deprecated)Remove the modules added in runXr and stop the camera.
stopFaceEffects (deprecated)Remove the modules added in runFaceEffects and stop the camera.