resolution
: allowed values are 512
(SD), 1024
(HD), 2048
(UHD). Default: 1024hide_bg
: If set to 1 the player will use a solid color as a background instead of the default environment.bg_color
: Sets the color of the 3D environment to the given hex color. Note that this parameter overrides the background color defined in the Background Color Extension of the SmartVu®. Allowed values: 6-digit HEX color without #-sign, e.g. FFFFFF
for white, or transparent
plane
: Sets the color of the 3D floor to the given hex color. Allowed values: 6-digit HEX color without #-sign, e.g. FFFFFF
for white.autoplay
: If set to 1, the 3D preview on the page will start immediately. The play button will not be displayed.autopause
: If set to 1, the player pauses when idle to save CPU and battery.autorotate
: If set to 1, the 3D model starts spinning when the user is idle for 5 seconds.hide_sidebar
: If set to 1, the sidebar and its widgets of your SmartVu® will not be displayed. Note that this parameter overrides the sidebar behaviour defined in the SmartVu® Editor.hide_applink
: If set to 1, the "Open in App"-button in the bottom left corner of the 3D view will not be displayed.openinapp
(Deprecated): If set to 1, the "Open in App"-button in the bottom left corner of the 3D view will be displayed.hide_navigation
: If set to 1, the default navigation UI elements are hidden, e.g. the "Back" button only works in Embed modeenable_shadows
: If set to 1, shadows will be enabled on all devices. By default, shadows are disabled on all mobile devices. Note that this setting may cause a significant drop in performance for slower devices, so you should only set it for very simple models or if you plan to target desktop users exclusively.enable_xr
: pass enable_xr=0 to disable the AR buttonenable_mirror
: display a mirror surface below the modelenable_ao
: enable ambient occlusion for the displayed modelformat
: aura or glb, glb is default. Pass aura to use the new AuraWeb formatinitial_hotspot
: pass the hotspot the SmartVu® starts with, e.g. &initial_hotspot=footsteps-00
aa
: number of post-processing samples, range between 0 and 8. pass 0 to disable post-processing; default=2exposure
: global exposure of the scene – will not be applied if post-processing is disabled, default=1.0contrast
: global contrast of the scene – will not be applied if post-processing is disabled, default=1.0brand_color
: Sets the text and button color of the UI elements, e.g. Popups. Allowed values: 6-digit HEX color without #-sign, e.g. FFFFFF
for white. Default: white
.brand_bg
: Sets the background color of the UI elements, e.g. Popups. Allowed values: 6-digit HEX color without #-sign, e.g. FFFFFF
for white. Default: #121A27
force_sidebar
: If set to 1, the SmartVu sidebar UI is forced to be in its initial state (also requires the sidebar to be enabled for the SmartVu in studio)vf.activate_trigger
{
method: 'vf.activate_trigger',
id: <id of trigger>
}
vf.set_ego_limits
{
method: 'vf.set_ego_limites',
start_angle: 0,
min_angle: -90,
max_angle: 90,
}
vf.set_texture
alpha
parameter is optional to force transparency on or off, leave it to use auto-detection based on texture file extension.{
method: 'vf.set_texture',
id: <id of texture>,
url: <url of texture>,
alpha: <true
vf.show_object
{
method: 'vf.show_object',
path: <path to object>
}
vf.hide_object
{
method: 'vf.hide_object',
path: <path to object>
}
vf.pause
{
method: 'vf.pause',
ui: <true
vf.unpause
{
method: 'vf.unpause'
}
vf.ui.list_triggers
data.params.triggers
object with a list of all triggers contained in the scene.{
method: 'vf.ui.list_triggers'
}
vf.navigate_back
{
method: 'vf.navigate_back'
}
vf.set_background
{
method: 'vf.set_background',
color: <HEX COLOR>
}
vf.set_material_color
{
method: 'vf.set_material_coolor',
id: <name of the material>,
color: <HEX COLOR>
}
vf.allow_rotation
autorotate=1
is added as a param{
method: 'vf.allow_rotation',
state: <true
vf.did_activate_trigger
{
trigger_type: '',
trigger_id: ''
}
vf.did_enter_context
{
context: ''
}
vf.did_exit_context
{
context: ''
}
vf.did_hide_popup
{
title: ''
}
vf.did_list_triggers
{
triggers: [
{
path: 'root/child/trigger1',
type: 'EVENT',
}
]
}
vf.did_pause
vf.did_resume
vf.did_show_popup
{
title: ''
}
vf.did_change_background