class Config

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
open String

Returns a string representation of Config for debugging.

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 See QrCodeTrackingMode

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Returns a string representation of Config for debugging.

Note: Not intended for production use.

Public properties

anchorPersistence

Added in 1.0.0-beta02
val anchorPersistence: AnchorPersistenceMode

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

augmentedImageDatabase

Added in 1.0.0-beta02
val augmentedImageDatabase: AugmentedImageDatabase?

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

augmentedObjectCategories

Added in 1.0.0-beta02
val augmentedObjectCategories: Set<AugmentedObjectCategory>

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

depthEstimation

Added in 1.0.0-beta02
val depthEstimation: DepthEstimationMode

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

deviceTracking

Added in 1.0.0-beta02
val deviceTracking: DeviceTrackingMode

feature that allows tracking of the AR device. See DeviceTrackingMode

eyeTracking

Added in 1.0.0-beta02
val eyeTracking: EyeTrackingMode

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

faceTracking

Added in 1.0.0-beta02
val faceTracking: FaceTrackingMode

feature that allows the tracking of human faces. See FaceTrackingMode

geospatial

Added in 1.0.0-beta02
val geospatial: GeospatialMode

feature that allows geospatial localization and tracking. See GeospatialMode

handTracking

Added in 1.0.0-beta02
val handTracking: HandTrackingMode

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

planeTracking

Added in 1.0.0-beta02
val planeTracking: PlaneTrackingMode

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

qrCodeSizeMeters

Added in 1.0.0-beta02
val qrCodeSizeMeters: Float

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-beta02
val qrCodeTracking: QrCodeTrackingMode

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