Lens Studio v4.0+
Inherits from Component
Creates Colocated Connected Lenses experiences by enabling the creation and tracking of a shared space which can be used to place several users in the same coordinate frame. This shared space will be made available and can be tracked by any friend you invite to join your session via Snapcode. Users are expected to be located in the same room when using the colocated feature. This component needs to be attached to the camera.
join(MultiplayerSession session) :
Joins an existing session, retrieving the shared space that the colocated session initiator just created. Throws an exception if a join or build operation is in progress or if a shared space is already present.
startBuilding(MultiplayerSession session) :
Starts the shared space building process locally in the session initiator’s device.
If a session is provided, the shared space is placed into the session after building has completed, which is required for Colocated experiences running on mobile devices. When running the experience in Lens Studio Preview or solo mode the session is not required.
Throws an exception if a join or build operation is in progress or if a map is already present.
Provides the shared space building progress expressed in values 0-1. These values can be used to populate a progress bar. Once this value has reached 1, the colocated tracking component attempts to share the space which the user created.
Indicates whether a shared space can be built on this device. Colocated Tracking is available on devices with ARKit/ARCore in the rear camera. This flag should be checked before attempting to build or join a session. If it is false, you should inform users: “Sorry, your device does not support shared AR experiences.”
Indicates whether a shared space is present and ready to be tracked.
Indicates whether a shared space building operation is in progress. Once the flag is false, the shared space still needs to be shared. Use
onTrackingAvailable to determine when your space has been shared.
Indicates whether a session joining operation is in progress.
Indicates whether a shared space is actively being tracked. This value will be true while tracking is active, either with or without the shared space in view. This property matches the equivalent one in
Event fired when the building operation fails (for example, sharing your space failed). Once
onTrackingAvailable event is triggered, this event will not be triggered anymore.
Event fired when a shared space starts being actively tracked. This property is an analogue of the
onMarkerFound property in
Event fired when a join operation completes but no shared space was found in the session.
Event fired when a shared space stops being actively tracked. This property is an analogue of the
onMarkerLost property in
Event fired when a shared space has been shared or received and the device can attempt to start tracking. If this event is not being triggered for a long period, the process will time out and
onBuildFailed event will be triggered.
Destroys the component.
Returns the SceneObject the component is attached to.
Returns the Transform this component is attached to.
Returns the name of this object’s type.
isOfType(String type) :
Returns true if the object matches or derives from the passed in type.
isSame(ScriptObject other) :
Returns true if this object is the same as
other. Useful for checking if two references point to the same thing.
If disabled, the Component will stop enacting its behavior.
Still Looking for help?Visit Support