NsdkSettings
↳ extends UnityEngine.ScriptableObject
Declaration
public partial class NsdkSettings : ScriptableObjectSummary
Build time settings for NSDK AR. These are serialized to an asset file and can only be altered via the Unity Inspector window.
Properties
| Name | Type | Summary |
|---|---|---|
| readonly AccessExpiresAt | int | Time when the current runtime access token expires |
| readonly AccessToken | string | The effective access token. Returns the access token override if set, otherwise the developer auth access token. |
| readonly AccessTokenOverride | string | An access token that takes priority over developer authentication when set. |
| AuthEnvironment | AuthEnvironmentType | - |
| readonly DevicePlaybackSettings | INsdkPlaybackSettings | - |
| readonly EditorPlaybackSettings | INsdkPlaybackSettings | - |
| readonly FileNsdkLogLevel | LogLevel | The highest log level to print for a file logger |
| static readonly Instance | NsdkSettings | Accessor to NSDK settings asset instance. THIS SHOULD ONLY BE USED IN SPECIFIC SITUATIONS: 1) Editor classes that need to read/write values to the asset 2) By NsdkLoaderHelper to initialize the runtime settings on application load All other code should use NsdkLoaderHelper.ActiveSettings to get the settings, otherwise it will get the asset instance's values instead of the runtime instance's, which may be different in tests or if the dev has modified settings at runtime. |
| LocationAndCompassDataSource | LocationDataSource | Source of location and compass data fetched from the NianticSpatial.NSDK.AR.Input APIs |
| readonly LoopInfinitely | bool | - |
| readonly NsdkSimulationParams | NsdkSimulationParams | - |
| readonly PlaybackDatasetPath | string | - |
| readonly PreferLidarIfAvailable | bool | When enabled, LiDAR depth will be used instead of NSDK depth on devices where LiDAR is available. Features unique to the NsdkOcclusionExtension cannot be used. |
| readonly RefreshExpiresAt | int | Time when the current runtime refresh token expires |
| readonly RefreshToken | string | The current runtime refresh token |
| readonly RunManually | bool | - |
| SpoofCompassInfo | SpoofCompassInfo | Values returned by compass service when in Spoof mode |
| SpoofLocationInfo | SpoofLocationInfo | Values returned by location service when in Spoof mode |
| readonly StdOutNsdkLogLevel | LogLevel | The highest log level to print for the stdout logger - typically for internal testing. Keep this off unless you know what you are looking for |
| readonly UnityNsdkLogLevel | LogLevel | The highest log level to print for Unity logger |
| readonly UseDeveloperAuthentication | bool | - |
| readonly UseNsdkDepth | bool | When enabled, NSDK's depth and occlusion features can be used via ARFoundation. Additional occlusion features unique to NSDK can be configured in the NsdkOcclusionExtension component. |
| readonly UseNsdkDeviceMapping | bool | When enabled, NSDK's device mapping features can be used. |
| readonly UseNsdkMeshing | bool | When enabled, NSDK's meshing features can be used via ARFoundation. Additional mesh features unique to NSDK can be configured in the LightshipMeshingExtension component. |
| readonly UseNsdkScanning | bool | When enabled, NSDK's scanning features can be used. |
| readonly UseNsdkSceneSegmentation | bool | When enabled, NSDK's scene segmentation features can be used. |
| readonly UseNsdkVps2 | bool | When enabled, NSDK's VPS2 feature can be used. |
| readonly UsePlayback | bool | - |
Fields
| Name | Type | Summary |
|---|---|---|
| static BuildSettingsKey | string | - |
| static SettingsKey | string | - |
Methods
| Name | Type | Summary |
|---|---|---|
| UpdateAccess | void | - |