Session.Feature

AI-generated Key Takeaways

• Session.Feature defines fundamental session features for ARCore sessions.

• All currently defined Session.Feature elements are compatible with each other.

• The FRONT_CAMERA feature is deprecated and its functionality is now handled by camera configurations.

• The SHARED_CAMERA feature allows sharing the camera between ARCore and the application, with specific requirements and restrictions when ARCore is active.

public static final enum Session.Feature

Fundamental session features that can be requested using Session.Session(Context, Set).

All currently defined features are mutually compatible.

Inherited Methods

From class java.lang.Enum

final Object	clone()
final int	compareTo(Session.Feature arg0)
int	compareTo(Object arg0)
final Optional<EnumDesc<Session.Feature>>	describeConstable()
final boolean	equals(Object arg0)
final void	finalize()
final Class<Session.Feature>	getDeclaringClass()
final int	hashCode()
final String	name()
final int	ordinal()
String	toString()
static <T extends Enum<T>> T	valueOf(Class<T> arg0, String arg1)

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface java.lang.constant.Constable

abstract Optional<? extends ConstantDesc>

describeConstable()

From interface java.lang.Comparable

abstract int

compareTo(Session.Feature arg0)

Enum Values

public static final Session.Feature FRONT_CAMERA

FRONT_CAMERA

public static final Session.Feature FRONT_CAMERA

This field was deprecated.
To create a session using the front-facing (selfie) camera, use Session.setCameraConfig(CameraConfig) with the desired config retrieved from Session.getSupportedCameraConfigs(CameraConfigFilter).

Use the front-facing (selfie) camera. When the front camera is selected, ARCore's behavior changes in the following ways:

• The display will be mirrored. Specifically, Camera.getProjectionMatrix(float[], int, float, float) will include a horizontal flip in the generated projection matrix and APIs that reason about things in screen space such as Frame.transformCoordinates2d(Coordinates2d, float[], Coordinates2d, float[]) will mirror screen coordinates. Open GL apps should consider using glFrontFace to render mirrored assets without changing their winding direction.
• Camera.getTrackingState() will always return TrackingState.PAUSED.
• All forms of Frame.hitTest() will always return an empty list.
• Camera.getDisplayOrientedPose() will always return an identity pose.
• Session.createAnchor(Pose) will always throw NotTrackingException.
• Planes will never be detected.
• Session.configure(Config) will throw if the supplied configuration requests Cloud Anchors or Augmented Images.

public static final Session.Feature SHARED_CAMERA

SHARED_CAMERA

public static final Session.Feature SHARED_CAMERA

Enable sharing the camera between ARCore and the app. See the class-level documentation for SharedCamera for an example of how to use this method.

Note:

• You must check that a compatible version of ARCore is installed before calling this method. See the class-level documentation for Session for details.
• You must wrap CameraDevice.StateCallback and CameraCaptureSession.StateCallback callbacks using SharedCamera.createARDeviceStateCallback(android.hardware.camera2.CameraDevice.StateCallback, android.os.Handler) and SharedCamera.createARSessionStateCallback(android.hardware.camera2.CameraCaptureSession.StateCallback, android.os.Handler) respectively.

While ARCore is paused you can use the Camera2 APIs directly without restriction.

While ARCore is active, the app may continue to use Camera2 APIs, except it must not call CameraCaptureSession#setRepeatingRequest as this will interfere with ARCore operation.