ARBodyTrackingConfiguration

Inherits: RefCounted < Object

Configuration for body tracking AR sessions.

Description

Configures a session for full-body skeletal tracking. Use with ARSession.run_body_tracking(). iOS only. On visionOS and macOS, is_supported() returns false and the configuration is inert.

Properties

bool

automatic_skeleton_scale_estimation_enabled

false

bool

is_auto_focus_enabled

true

bool

is_light_estimation_enabled

true

Methods

bool

is_supported() static


Property Descriptions

bool automatic_skeleton_scale_estimation_enabled = false 🔗

  • void set_automatic_skeleton_scale_estimation_enabled(value: bool)

  • bool get_automatic_skeleton_scale_estimation_enabled()

When enabled, ARKit automatically estimates the body’s skeleton scale.


bool is_auto_focus_enabled = true 🔗

  • void set_is_auto_focus_enabled(value: bool)

  • bool get_is_auto_focus_enabled()

When enabled, the camera may adjust focus automatically during tracking.


bool is_light_estimation_enabled = true 🔗

  • void set_is_light_estimation_enabled(value: bool)

  • bool get_is_light_estimation_enabled()

When enabled, ARKit produces ARLightEstimate data for each frame.


Method Descriptions

bool is_supported() static 🔗

Returns true when the current device supports ARKit body tracking.