HomeGuides
HomeGuidesLearn about the Immerse SDK installerLog In

Auto-Connect

📘

This feature requires the Immerse SDK Enterprise Edition

This is different to the free Immerse SDK. Contact [email protected] if you require access.

Understand the difference between the Free and Enterprise SDK

The fastest way to get into a session is to use the Auto-Connect feature. This was the default behavior in version 4.x of the SDK. With this option enabled, as soon as the application starts the process of connecting to the platform will start immediately.

Connection foldout in Immerse SDK settingsConnection foldout in Immerse SDK settings

Connection foldout in Immerse SDK settings

1. Authenticating the User

The first step is to authenticate the user. For the Unity Editor or WebGL and Windows applications launched via the Immerse website, step this is automatic. For other platforms, such as Android, a PIN panel will be displayed for the user to input their generated PIN.

2. Connecting to Multi-user

Once authenticated, the auto-connect process will attempt to connect to the multi-user service using the credentials received from the authentication step.

Options

Description

Start Message Queue

Start processing Messages as soon as a connection is made.

Offline Mode

Skip the authentication step and connect to a mock multi-user service.
Platform services such as Reporting will be unavailable.

PIN Input Prefab

The prefab to use when a PIN is required for authentication (such as Android applications)

Always Use PIN

Always display the PIN panel for authentication. This is useful for testing PIN Input methods in the Unity editor.
(Intended for development use)

Manual Connection

If you wish to connect services manually, an example on how to do this is included with the Platform Services package in the SessionAuthenticator component.


Related pages