SceneViewerSessionOptions
interface SceneViewerSessionOptions
Options for the SceneViewerSession
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| file | string | null | ✔️ | This URL specifies the glTF or glb file that should be loaded into Scene Viewer. This should be URL-escaped. If null is given, it will try to use current model shown on the canvas. This behavior only works when the format of the model shown is either "glTF" or "glb". | |
| fallbackURL | string | null | ✔️ | This is a Google Chrome feature supported only for web-based implementations. When the Google app com.google.android.googlequicksearchbox is not present on the device, this is the URL that Google Chrome navigates to. | |
| mode | string | ✔️ | "ar_only" | See SCENE_VIEWER_MODE for available modes (also check their official page for details). |
| title | string | null | ✔️ | A name for the model. If present, it will be displayed in the UI. The name will be truncated with ellipses after 60 characters. | |
| link | string | null | ✔️ | A URL for an external webpage. If present, a button will be surfaced in the UI that intents to this URL when clicked. | |
| sound | string | null | ✔️ | A URL to a looping audio track that is synchronized with the first animation embedded in a glTF file. It should be provided alongside a glTF with an animation of matching length. If present, the sound is looped after the model is loaded. This should be URL-escaped. | |
| resizable | boolean | ✔️ | true | When set to false, users will not be able to scale the model in the AR experience. Scaling works normally in the 3D experience. |
| vertical | boolean | ✔️ | false | When set to true, users will be able to place the model on a vertical surface. |
| disableOcclusion | boolean | ✔️ | false | When set to true, SceneViewer will disable object blending |
| initialScale | string | null | ✔️ | "auto" | Initial scale of the 3D model. If set to null, 3D model will shown as its original size and will disable the "View actual size" button. Default value is "auto", and "1" will show model size in 100%, "2" in 200%, "0.5" in 50% and so on. |
| shareText | string | null | ✔️ | A text that will be displayed when user clicked the share button. |