public final 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
public final class Config.Builder

This class can be used to create a Config instance.

Public methods
boolean
equals(Object other)
final @NonNull AnchorPersistenceMode

feature that allows anchors to be persisted through sessions.
final AugmentedImageDatabase

the current active AugmentedImageDatabase.
final @NonNull Set<@NonNull AugmentedObjectCategory>

feature that allows tracking of recognizable objects in the environment.
final @NonNull DepthEstimationMode

feature that allows more accurate information about scene depth and meshes.
final @NonNull DeviceTrackingMode

feature that allows tracking of the AR device.
final @NonNull EyeTrackingMode

feature that allows tracking of the users gaze direction.
final @NonNull FaceTrackingMode

feature that allows the tracking of human faces.
final @NonNull GeospatialMode

feature that allows geospatial localization and tracking.
final @NonNull HandTrackingMode

feature that allows tracking of the user's hands and hand joints.
final @NonNull PlaneTrackingMode

feature that allows tracking of and provides information about scene planes.
final float

the physical size in meters of the QR code.
final @NonNull QrCodeTrackingMode

feature that allows tracking of and provides information about QR codes See QrCodeTrackingMode
int
@NonNull String

Returns a string representation of Config for debugging.

Public methods

equals

public boolean equals(Object other)

getAnchorPersistence

Added in 1.0.0-beta02
public final @NonNull AnchorPersistenceMode getAnchorPersistence()

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

getAugmentedImageDatabase

Added in 1.0.0-beta02
public final AugmentedImageDatabase getAugmentedImageDatabase()

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

getAugmentedObjectCategories

Added in 1.0.0-beta02
public final @NonNull Set<@NonNull AugmentedObjectCategory> getAugmentedObjectCategories()

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

getDepthEstimation

Added in 1.0.0-beta02
public final @NonNull DepthEstimationMode getDepthEstimation()

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

getDeviceTracking

Added in 1.0.0-beta02
public final @NonNull DeviceTrackingMode getDeviceTracking()

feature that allows tracking of the AR device. See DeviceTrackingMode

getEyeTracking

Added in 1.0.0-beta02
public final @NonNull EyeTrackingMode getEyeTracking()

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

getFaceTracking

Added in 1.0.0-beta02
public final @NonNull FaceTrackingMode getFaceTracking()

feature that allows the tracking of human faces. See FaceTrackingMode

getGeospatial

Added in 1.0.0-beta02
public final @NonNull GeospatialMode getGeospatial()

feature that allows geospatial localization and tracking. See GeospatialMode

getHandTracking

Added in 1.0.0-beta02
public final @NonNull HandTrackingMode getHandTracking()

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

getPlaneTracking

Added in 1.0.0-beta02
public final @NonNull PlaneTrackingMode getPlaneTracking()

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

getQrCodeSizeMeters

Added in 1.0.0-beta02
public final float getQrCodeSizeMeters()

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

getQrCodeTracking

Added in 1.0.0-beta02
public final @NonNull QrCodeTrackingMode getQrCodeTracking()

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

hashCode

public int hashCode()

toString

public @NonNull String toString()

Returns a string representation of Config for debugging.

Note: Not intended for production use.