class Config


Defines a configuration state of all available features to be set at runtime.

An instance of this class should be passed to Session.configure to set the current configuration. Use Builder to specify individual configuration settings, and use Builder.build to create an instance of Config to pass to Session.configure.

Summary

Nested types

This class can be used to create a Config instance.

Public functions

open operator Boolean
equals(other: Any?)
open Int

Public properties

AnchorPersistenceMode

Feature that allows anchors to be persisted through sessions.

AugmentedImageDatabase?

The current active AugmentedImageDatabase.

Set<AugmentedObjectCategory>

Feature that allows tracking of recognizable objects in the environment.

DepthEstimationMode

Feature that allows more accurate information about scene depth and meshes.

DeviceTrackingMode

Feature that allows tracking of the AR device.

EyeTrackingMode

Feature that allows tracking of the users gaze direction.

FaceTrackingMode

Feature that allows the tracking of human faces.

GeospatialMode

Feature that allows geospatial localization and tracking.

HandTrackingMode

Feature that allows tracking of the user's hands and hand joints.

PlaneTrackingMode

Feature that allows tracking of and provides information about scene planes.

Float

The physical size in meters of the QR code.

QrCodeTrackingMode

Feature that allows tracking of and provides information about QR codes.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

anchorPersistence

Added in 1.0.0-alpha15
val anchorPersistenceAnchorPersistenceMode

Feature that allows anchors to be persisted through sessions. See AnchorPersistenceMode.

augmentedImageDatabase

Added in 1.0.0-alpha15
val augmentedImageDatabaseAugmentedImageDatabase?

The current active AugmentedImageDatabase. If not empty, the image tracking feature will be enabled.

augmentedObjectCategories

Added in 1.0.0-alpha15
val augmentedObjectCategoriesSet<AugmentedObjectCategory>

Feature that allows tracking of recognizable objects in the environment. See AugmentedObjectCategory.

depthEstimation

Added in 1.0.0-alpha15
val depthEstimationDepthEstimationMode

Feature that allows more accurate information about scene depth and meshes. See DepthEstimationMode.

deviceTracking

Added in 1.0.0-alpha15
val deviceTrackingDeviceTrackingMode

Feature that allows tracking of the AR device. See DeviceTrackingMode.

eyeTracking

Added in 1.0.0-alpha15
val eyeTrackingEyeTrackingMode

Feature that allows tracking of the users gaze direction. See EyeTrackingMode.

faceTracking

Added in 1.0.0-alpha15
val faceTrackingFaceTrackingMode

Feature that allows the tracking of human faces. See FaceTrackingMode.

geospatial

Added in 1.0.0-alpha15
val geospatialGeospatialMode

Feature that allows geospatial localization and tracking. See GeospatialMode.

handTracking

Added in 1.0.0-alpha15
val handTrackingHandTrackingMode

Feature that allows tracking of the user's hands and hand joints. See HandTrackingMode.

planeTracking

Added in 1.0.0-alpha15
val planeTrackingPlaneTrackingMode

Feature that allows tracking of and provides information about scene planes. See PlaneTrackingMode.

qrCodeSizeMeters

Added in 1.0.0-alpha15
val qrCodeSizeMetersFloat

The physical size in meters of the QR code. If zero, the physical size will be estimated if the device supports it. If physical size estimation is not supported, configuring the Session adding an entry with qrCodeSizeMeters being 0f or lower will throw an IllegalStateException. It requires qrCodeTracking to be different from QrCodeTrackingMode.DISABLED.

qrCodeTracking

Added in 1.0.0-alpha15
val qrCodeTrackingQrCodeTrackingMode

Feature that allows tracking of and provides information about QR codes. See QrCodeTrackingMode.