Skip to main content

Sync Framework on Spectacles [Beta]

Overview

Sync Framework is ported for compatibility with Spectacles, facilitating the development of Connected Lenses. Note that this version is specific to Spectacles and incompatible with mobile Snapchat Lenses.

Installing Sync Framework to your Project

Review the documentation for Connected Lenses on Spectacles to set up your Lens Studio environment appropriately.

Download from Asset Library

Install the Spectacles Sync Framework through the Asset Library under the Spectacles section.

Unpack Sync Framework Package

Unpack the Sync Framework package upon download by right clicking on the package and selecting “Unpack for Editing”.

Using Sync Framework for Spectacles

The Spectacles Sync Framework extends the functionality of the mobile Snapchat counterpart. Note that the mobile version is incompatible with Spectacles, and vice versa.

For more information about Sync Framework on mobile Snapchat, please refer to the Sync Framework documentation.

​​Additional Features in Spectacles

TypeScript Support

  • Sync Framework was originally created in JavaScript. Spectacles Sync Framework has TypeScript definitions so you can build experiences on top of TypeScript.

Spectacles Interaction Kit Support

  • Spectacles Interaction Kit (SIK) is bundled with the Sync Framework and should not be installed separately. For more information about SIK, please see the documentation.

Sync Transform Update

  • Smoothing is now applied to unowned objects.

  • New Location-relative synchronization. This will allow you to anchor your SceneObject contents based on the mapped environment. This is the recommended default for most.

Co-location Flow

  • New co-location flow where you can place the content that is below the EnableOnReady SceneObject for when your experience is ready to start after it has been localized in your space.
  • Ability to skip the co-location flow in Lens Studio, for faster development. This option is a checkbox on the “Session Controller [CONFIGURE_ME]” component.

Singleplayer and Multiplayer Menu

  • Reference for starting a Multiplayer or Singleplayer session

  • Configuration for single player behavior:

    • In manual mode, the Sync framework will be unavailable when the singleplayer button is pressed.

    • In simulated mode, the Sync framework will not connect to the internet, but will simulate networked behavior. In most circumstances, a Lens that works in multiplayer mode will work in singleplayer simulated mode without any changes.

Was this page helpful?
Yes
No

AI-Powered Search