Skip to main content

Upgrading to BeamXR 1.0

Upgrading from prior versions has a few gotchas that you need to be aware of.

Please make sure to read this before upgrading.

Pre-Upgrade

Make sure to backup or re-obtain your experience key and secret (from the Developer Portal). These will be removed from your Beam Streaming Manager and will not be recoverable after upgrading.

info

The Director Kit has been heavily re-designed for 1.0 to support the new recording features. You will have to adjust any prior variants of it.

Once you are ready to upgrade, simply update to the latest packages (either via Git or local install).

You may need to reload Unity to completely flush out any lingering DLLs.

Required Changes

Both the Streaming Manager and Streaming Camera have had Streaming removed from their names. They are now the BeamManager and BeamCamera respectively. You shouldn't have to rename any function calls.

The new Beam Settings functionality is the home for your experience key and secret. You will need to enter them here. You will also need to re-create any device options you may have had for Android or Windows. These can now be specified per device name and/or model.

Microphone objects are no longer required to be placed within the scene and should be automatically handled by Beam.

The Unity Events have been changed, specifically for Recording. These now include a capture type (cloud or local) and unified state enum. The start and stop recording events also include the capture type.

Beam Object Hiders have been modified to work with any specific camera view, you may need to re-adjust them.

The Director Kit has been overhauled to make it simpler to modify and create variants of. We recommend creating a variant of it before re-skinning it to make it easier to use in future versions. All of the parts can be replaced with custom variants to speed up visual changes.