Config.SemanticMode

  • Config.SemanticMode describes the behavior of the Scene Semantics API, which uses machine learning to label pixels in a camera feed.

  • The Scene Semantics API currently only reliably supports outdoor environments.

  • Not all ARCore supported devices support the Scene Semantics API, and support can be checked using Session.isSemanticModeSupported(Config.SemanticMode).

  • The default mode for Config.SemanticMode is DISABLED, and it can be changed to ENABLED using Config.setSemanticMode(Config.SemanticMode).

public static final enum Config.SemanticMode

Describes the desired behavior of the Scene Semantics API. Scene Semantics uses a machine learning model to label each pixel from the camera feed with a SemanticLabel. See the Scene Semantics Developer Guide for more information.

The Scene Semantics API is currently able to distinguish between outdoor labels specified by SemanticLabel. Usage indoors is currently unsupported and may yield unreliable results.

A small number of ARCore supported devices do not support the Scene Semantics API. Use Session.isSemanticModeSupported(Config.SemanticMode) to query for support for Scene Semantics. Affected devices are also indicated on the ARCore supported devices page.

The default value is DISABLED. Use Config.setSemanticMode(Config.SemanticMode) to set the desired mode.

Inherited Methods

Enum Values

DISABLED

public static final Config.SemanticMode DISABLED

The Scene Semantics API is disabled. Calls to Frame.acquireSemanticImage(), Frame.acquireSemanticConfidenceImage(), and Frame.getSemanticLabelFraction(SemanticLabel) will not return valid results.

This is the default mode.

ENABLED

public static final Config.SemanticMode ENABLED

The Scene Semantics API is enabled. Calls to Frame.acquireSemanticImage(), Frame.acquireSemanticConfidenceImage(), and Frame.getSemanticLabelFraction(SemanticLabel) will return valid results.

Use Config.setSemanticMode(Config.SemanticMode) to set this mode.