GoogleARCore
Summary
Enumerations |
|
---|---|
ApkAvailabilityStatus{
|
enum Possible statuses of the Google Play Services for AR (ARCore) APK availability on a device. |
ApkInstallationStatus{
|
enum Possible statuses for a Google Play Services for AR (ARCore) installation request on this device. |
AugmentedFaceMode{
|
enum Defines possible modes for AugmentedFace detection. |
AugmentedFaceRegion{
|
enum Defines face regions for which the pose can be queried. |
AugmentedImageTrackingMethod{
|
enum Indicates whether an image is being tracked using the camera image, or is being tracked based on its last known pose. |
CameraConfigDepthSensorUsage{
|
enum Type of hardware depth sensor, such as a time-of-flight sensor (or ToF sensor), usage for a camera config. |
CameraConfigStereoCameraUsage{
|
enum Type of stereo camera usage for a camera config. |
CameraFocusMode{
|
enum Selects the desired focus mode of the camera. |
CameraMetadataTag
|
enum This enum follows the layout of NdkCameraMetadataTags. |
CloudAnchorMode{
|
enum Defines possible modes for ARCore Cloud Anchors. |
DepthMode{
|
enum Desired depth mode. |
DepthStatus{
|
enum Status for an attempt to retrieve the current depth texture. |
DetectedPlaneFindingMode{
|
enum Selects the behavior of the plane detection subsystem. |
DetectedPlaneType{
|
enum Simple summary of the normal vector of a plane. |
DeviceCameraDirection{
|
enum The direction the device camera used by the session is facing. |
DisplayUvCoordinateType{
|
enum Types of UV coordinates used for the display. |
FeaturePointOrientationMode{
|
enum The orientation mode of the feature point. |
InstantPlacementMode{
|
enum Indicates whether Instant Placement is enabled or disabled. |
InstantPlacementPointTrackingMethod{
|
enum Tracking methods for InstantPlacementPoint . |
LightEstimateState{
|
enum Possible states for LightEstimate . |
LightEstimationMode{
|
enum Defines possible modes for ARCore real-world light estimation. |
LostTrackingReason{
|
enum Describes the reason for a loss in motion tracking. |
PlaybackResult{
|
enum Results from attempting to set playback dataset filepath. |
PlaybackStatus{
|
enum Describes the current playback status. |
RecordingResult{
|
enum Results from recording methods. |
RecordingStatus{
|
enum Describes the current recording status. |
SessionStatus{
|
enum Possible states for the ARCore session. |
TrackableHitFlags{
|
enum Flags representing categories of raycast hits. |
TrackableQueryFilter{
|
enum A filter for trackable queries. |
TrackingState{
|
enum Possible tracking states for ARCore. |
Classes |
|
---|---|
GoogleARCore. |
Renders the device's camera as a background to the attached Unity camera component. |
GoogleARCore. |
The |
GoogleARCore. |
Configuration to record camera and sensor data from an ARCore session. |
GoogleARCore. |
A component that manages the ARCore Session in a Unity scene. |
GoogleARCore. |
Holds settings that are used to configure the session. |
GoogleARCore. |
Attaches a GameObject to an ARCore |
GoogleARCore. |
Manages Android permissions for the Unity application. |
GoogleARCore. |
A class used for monitoring the status of an asynchronous task. |
GoogleARCore. |
A face detected and trackable by ARCore. |
GoogleARCore. |
An image in the real world detected and tracked by ARCore. |
GoogleARCore. |
A database storing a list of images to be detected and tracked by ARCore. |
GoogleARCore. |
This class caches information and content about a Texture2D for use by ARCore on threads other than the main thread. |
GoogleARCore. |
A point in the real world based on the Depth map generated and tracked by ARCore. |
GoogleARCore. |
A planar surface in the real world detected and tracked by ARCore. |
GoogleARCore. |
A component that automatically adjusts lighting settings for the scene to be inline with those estimated by ARCore. |
GoogleARCore. |
A point in the real world tracked by ARCore. |
GoogleARCore. |
Provides a snapshot of the state of ARCore at a specific timestamp associated with the current frame. |
GoogleARCore. |
Trackable Instant Placement point returned by Frame.RaycastInstantPlacement(float, float, float, TrackableHit). |
GoogleARCore. |
Represents an ARCore session, which is an attachment point from the app to the ARCore service. |
GoogleARCore. |
Extension methods for the SessionStatus enumeration. |
GoogleARCore. |
An object ARCore is tracking in the real world. |
GoogleARCore. |
Provides access to information about the current ARCore SDK runtime. |
Structs |
|
---|---|
GoogleARCore. |
Structure holding data summarizing the result of an Android permissions request. |
GoogleARCore. |
An entry in a AugmentedImageDatabase. |
GoogleARCore. |
A configuration for ARCore accessing the device's camera sensor. |
GoogleARCore. |
An ARCore camera image with its data accessible from the CPU in YUV-420-888 format. |
GoogleARCore. |
A struct to provide camera intrinsics in ARCore. |
GoogleARCore. |
CameraMetadataRational follows the layout of ACameraMetadata_rational struct in NDK. |
GoogleARCore. |
Struct to contain camera metadata's value. |
GoogleARCore. |
Stores UV display coordinates for mapping the four corners of the display. |
GoogleARCore. |
An estimate of lighting conditions in the environment corresponding to an AR frame. |
GoogleARCore. |
A point in a point cloud. |
GoogleARCore. |
Definition of a track to record on. |
GoogleARCore. |
Data that was recorded to a track for a given frame. |
GoogleARCore. |
Contains information about a raycast hit against a physical object tracked by ARCore. |
Interfaces |
|
---|---|
GoogleARCore. |
Interface for checking Android permission. |
Namespaces |
|
---|---|
GoogleARCore. |
Enumerations
ApkAvailabilityStatus
ApkAvailabilityStatus
Possible statuses of the Google Play Services for AR (ARCore) APK availability on a device.
ApkInstallationStatus
ApkInstallationStatus
Possible statuses for a Google Play Services for AR (ARCore) installation request on this device.
AugmentedFaceMode
AugmentedFaceMode
Defines possible modes for AugmentedFace detection.
Properties | |
---|---|
Disabled
|
A mode where AugmentedFace detection is disabled. |
Mesh
|
A mode where AugmentedFace detection performs face pose, region pose, and face mesh estimation. |
AugmentedFaceRegion
AugmentedFaceRegion
Defines face regions for which the pose can be queried.
Left and right of an Augmented Face are defined relative to the person that the mesh belongs to.
Properties | |
---|---|
ForeheadLeft
|
A region around the left forehead of the AugmentedFace. |
ForeheadRight
|
A region around the right forehead of the AugmentedFace. |
NoseTip
|
A region around the nose of the AugmentedFace. |
AugmentedImageTrackingMethod
AugmentedImageTrackingMethod
Indicates whether an image is being tracked using the camera image, or is being tracked based on its last known pose.
Properties | |
---|---|
FullTracking
|
The Augmented Image is currently being tracked using the camera image. This state can only occur when the image's |
LastKnownPose
|
The Augmented Image is currently being tracked based on its last known pose, because it can no longer be tracked using the camera image. This state can only occur when the image's |
NotTracking
|
The Augmented Image is not currently being tracked. This state indicates that the image's |
CameraConfigDepthSensorUsage
CameraConfigDepthSensorUsage
Type of hardware depth sensor, such as a time-of-flight sensor (or ToF sensor), usage for a camera config.
CameraConfigStereoCameraUsage
CameraConfigStereoCameraUsage
Type of stereo camera usage for a camera config.
CameraFocusMode
CameraFocusMode
CameraMetadataTag
CameraMetadataTag
This enum follows the layout of NdkCameraMetadataTags.
The values in the file are used for requesting / marshaling camera image's metadata. The comments have been removed to keep the code readable. Please refer to NdkCameraMetadataTags.h for documentation: https://developer.android.com/ndk/reference/ndk_camera_metadata_tags_8h.html .
CloudAnchorMode
CloudAnchorMode
DepthMode
DepthMode
Desired depth mode.
Properties | |
---|---|
Automatic
|
On supported devices the best possible depth is estimated based on hardware and software sources. Available sources of automatic depth are:
|
Disabled
|
Depth is disabled. |
RawDepthOnly
|
On ARCore supported devices that also support the Depth API, provides a "raw", mostly unfiltered, depth image ( The raw depth image is sparse and does not provide valid depth for all pixel. Pixels without a valid depth estimate have a pixel value of 0. Raw depth data is also available when Raw depth is intended to be used in cases that involve understanding of the geometry in the environment. |
DepthStatus
DepthStatus
Status for an attempt to retrieve the current depth texture.
Properties | |
---|---|
IllegalState
|
A supported depth mode was not enabled in Session configuration. |
InternalError
|
An internal error occurred, so the depth image was not updated. This could occur if the session is not ready, or in the event of other internal errors. |
NotTracking
|
|
NotYetAvailable
|
The depth information is not available for this frame, the number of observed camera frames is not yet sufficient for depth estimation, or depth estimation was not possible due to poor lighting, camera occlusion, or no motion observed. |
Success
|
The depth image was retrieved successfully. |
DetectedPlaneFindingMode
DetectedPlaneFindingMode
Selects the behavior of the plane detection subsystem.
DetectedPlaneType
DetectedPlaneType
DeviceCameraDirection
DeviceCameraDirection
DisplayUvCoordinateType
DisplayUvCoordinateType
Types of UV coordinates used for the display.
Properties | |
---|---|
BackgroundImage
|
The background image bytes used for CPU access to the pass-through camera image available from |
BackgroundTexture
|
The background texture used to display the pass-through camera available from |
UnityScreen
|
The Unity Screen. |
FeaturePointOrientationMode
FeaturePointOrientationMode
The orientation mode of the feature point.
InstantPlacementMode
InstantPlacementMode
Indicates whether Instant Placement is enabled or disabled.
The default value is InstantPlacementMode
.Disabled
.
Properties | |
---|---|
Disabled
|
Instant Placement mode is disabled. When Instant Placement is disabled, any |
LocalYUp
|
Enable Instant Placement. If the hit test is successful, it will return a single This mode is currently intended to be used with hit tests against horizontal surfaces. Hit tests may also be performed against surfaces with any orientation, however:
|
InstantPlacementPointTrackingMethod
InstantPlacementPointTrackingMethod
Tracking methods for InstantPlacementPoint
.
Properties | |
---|---|
FullTracking
|
The ARCore does not limit the number of |
NotTracking
|
The The TrackingState is |
ScreenspaceWithApproximateDistance
|
The
ARCore concurrently tracks at most 20 |
LightEstimateState
LightEstimateState
Possible states for LightEstimate
.
Properties | |
---|---|
NotValid
|
Estimate is not valid and should not be used. |
Valid
|
Estimate is valid. |
LightEstimationMode
LightEstimationMode
Defines possible modes for ARCore real-world light estimation.
LostTrackingReason
LostTrackingReason
Describes the reason for a loss in motion tracking.
Properties | |
---|---|
BadState
|
An internal error is causing motion tracking to fail. |
CameraUnavailable
|
Motion tracking paused because the camera is in use by another application. Tracking will resume once this app regains priority, or once all apps with higher priority have stopped using the camera. Prior to ARCore SDK 1.13, |
ExcessiveMotion
|
Excessive movement of the device camera is causing motion tracking to fail. |
InsufficientFeatures
|
A lack of visually distinct environmental features in the camera feed is causing motion tracking to fail. |
InsufficientLight
|
Camera images are too dark, causing motion tracking to fail. On Android 12 (API level 31) or later, the user may have disabled camera access, causing ARCore to receive a blank camera feed. |
None
|
Motion tracking is working properly. |
PlaybackResult
PlaybackResult
Results from attempting to set playback dataset filepath.
PlaybackStatus
PlaybackStatus
Describes the current playback status.
RecordingResult
RecordingResult
Results from recording methods.
Properties | |
---|---|
ErrorIllegalState
|
When using Frame.StartRecording(ARCoreRecordingConfig), this means a recording is already in progress. When using Frame.RecordTrackData(Guid, byte[]), this means either RecordingStatus is not currently |
ErrorInvalidArgument
|
When using Session.StartRecording(ARCoreRecordingConfig), this means the ARCoreRecordingConfig was null or invalid. When using Session.RecordTrackData(Guid, byte[]), this means the track id or sample given are null or invalid. |
ErrorRecordingFailed
|
IO or other general failure. |
OK
|
The request completed successfully. |
RecordingStatus
RecordingStatus
SessionStatus
SessionStatus
Possible states for the ARCore session.
Properties | |
---|---|
ErrorApkNotAvailable
|
The ARCore session cannot begin tracking because the ARCore service APK is not available on the device. |
ErrorCameraNotAvailable
|
The ARCore session cannot begin tracking because the camera has been reallocated to a higher priority application or is otherwise unavailable. |
ErrorIllegalState
|
The ARCore session cannot begin tracking because the camera configuration was changed, and there is at least one unreleased image. |
ErrorInvalidCameraConfig
|
The ARCore session failed to set a camera config. Returned when no supported camera config exists for the given To recover, try a less restrictive filter and then enable the |
ErrorPermissionNotGranted
|
The ARCore session cannot begin tracking because an Android permission, such as android.permission.CAMERA, is not granted. Use |
ErrorSessionConfigurationNotSupported
|
The ARCore session cannot begin tracking because the session configuration supplied is not supported or no session configuration was supplied. To recover, fix the configuration and ensure ARCoreSession is not enabled. Once SessionStatus is SessionStatus.NotTracking, ARCoreSession can be enabled. |
FatalError
|
The ARCore session cannot begin tracking because a fatal error was encountered. |
Initializing
|
The ARCore session is initializing. |
LostTracking
|
The ARCore session has lost tracking and is attempting to recover. |
None
|
The ARCore session has not been initialized. |
NotTracking
|
The ARCore session is paused. |
Tracking
|
The ARCore session is tracking. |
TrackableHitFlags
TrackableHitFlags
Flags representing categories of raycast hits.
Properties | |
---|---|
Default
|
This value is used to collide with all things good for placing objects. If you pass this into Raycast, you will collide with planes within the bounding polygon and feature points with normals and the depth map. |
Depth
|
The collision is on the current frame's depth map. This is only available if Depth is supported on the device and the ARCoresessionConfig.DepthMode is enabled for the session. |
FeaturePoint
|
The collision is on a feature point in the current frame's point cloud. |
FeaturePointWithSurfaceNormal
|
The collision is on a feature point in the current frame's point cloud that has a surface normal estimate (orientation). |
None
|
This value is returned on a TrackableHit to indicate no collision occurred. If you pass this into Raycast, you will not get any collision results. |
PlaneWithinBounds
|
The collision is within the DetectedPlane's bounding box. |
PlaneWithinInfinity
|
The collision is on the DetectedPlane, but not limited to the bounding box or polygon. This acts as if the plane extends out to infinity. |
PlaneWithinPolygon
|
The collision is within the DetectedPlane's convex bounding polygon. |
TrackableQueryFilter
TrackableQueryFilter