HomeGuidesRecipesDocumentationChangelog
Log InDiscussions
Discussions

Unload Player

Use this method to unload the active player

Definition

unload()

The unload method cleans up an active player / configurator

player.unload();

Usage

This method is needed when the player needs to be reloaded for a different asset id, a different stage id, or when switching between the 3D and the 2D player for a given item.
The practice in this case would be to first unload the player, and then recreate the player object with the new parameters.