Skip to main content

Connected Lenses (Multiplayer)

Multiplayer sessions, realtime stores, and colocated tracking.

Commonly used

Guides

All APIs in this topic

Add components to a scene object, reference assets and other modules with a script input, and create events with script.createEvent('<name>').

Components, assets, and modules

APIDescription
ColocatedTrackingComponentAllows SceneObject to be tracked in a Connected Lens Experience.
ConnectedLensModuleEnables the creation and management of networked Lens experiences, allowing for real-time communication and interaction between users through Connected Lenses.

Events

APIDescription
ConnectedLensEnteredEventEvent fired when the "Launch connected lens" button was pressed.

Objects and data

APIDescription
BaseMultiplayerSessionOptions
ColocatedLandmarks2DRenderObjectProviderNot usable from JS.
ColocatedLandmarks3DRenderObjectProviderNot usable from JS.
ColocatedLandmarksRenderObjectProviderBase
ConnectedLensSessionOptionsSettings for configuring a Connected Lens session.
DirectMultiplayerSessionOptions
MultiplayerSessionAn instance of a Connected Lens session among a group of participants who were successfully invited into the experience.
RealtimeStoreCreateOptions
StorageOptionsSettings for saving values in a MultiplayerSession.