Embed API for 3D Viewer v4.0

ReferenceFor developers

Base URL Structure ​

All 3D Viewer v4.0 Vuframe embed URLs start with:

https://embed4.vuframe.com/[embedCode]?player=4.1.0

where [embedCode] is your unique embed identifier.

Query Parameters ​

You can customize the embedlink behavior using various query parameters. Parameters can be added to any of the URL patterns above:

https://embed4.vuframe.com/12345678?player=4.1.0&ao=1

Available Query Parameters ​

The following query parameters can be used to customize your embedlink.

  • cache=0: Disable local caching of model files (default: unset, cache enabled)
  • sd=1: Set quality level to SD (Standard Definition - for legacy devices)
  • hd=1: Set quality level to HD (High Definition, fast devices).
  • uhd=1: Set quality level to UHD (Ultra High Definition - ultra-fast, desktop-like devices)
  • ao=1: If set to 1 ambient occlusion is enabled for the displayed model
  • ao_intensity=0.8: Set ambient occlusion intensity (default: 0.8)
  • ao_radius=1.5: you can set the radius or spreading of the ambient occlusion (default: 1.5)
  • ao_bias=0.75: Set the fall-off of ambient occlusion, use this to suppress black lines at the horizon (default: 0.75)
  • shadows=1: If set to 1 realtime shadows are enabled
  • shadow_strength=1: Set shadow strength, i.e. opacity (default: 0.5)
  • shadow_area=1.0: you can set the size of the area where shadows are thrown on (default: 1.0)
  • shadow_distance=100.0: Set distance (in units) after which shadows are faded out (default: 100.0)
  • autorotate=1: Enable automatic camera rotation
  • autorotate_speed=1: Set the speed of automatic camera rotation (default: 1)
  • bg_color=000000: Set background color from HEX, RGB, RGBA or html color name (default: white)

Example with Multiple Parameters ​

https://embed4.vuframe.com/12345678?player=4.1.0&uhd=1&ao=1&shadows=1&shadow_strength=0.71&shadow_area=15&shadow_distance=50&ao_intensity=1&ao_radius=0.5

Ambient Occlusion ​

Without ambient occlusion
Without ambient occlusion
With ambient occlusion
With ambient occlusion

Shadows ​

Without realtime shadows
Without realtime shadows
With realtime shadows
With realtime shadows

Shadow Area ​

The area must be smaller for small products than for large ones.

Ambient Occlusion Radius ​

The radius must be smaller for small products than for large ones.

Technical Notes ​

  • All query parameters are optional
  • Parameters use values 0 and 1 for boolean options (0 = off, 1 = on)
  • Multiple parameters should be separated with the & symbol
  • The first parameter after the embed code should be preceded by a ? symbol