unreal.ARSessionConfig

class unreal.ARSessionConfig(outer=None, name='None')

Bases: unreal.DataAsset

ARSession Config

C++ Source:

  • Module: AugmentedReality
  • File: ARSessionConfig.h

Editor Properties: (see get_editor_property/set_editor_property)

  • candidate_images (Array(ARCandidateImage)): [Read-Write] The list of candidate images to detect within the AR camera view
  • candidate_objects (Array(ARCandidateObject)): [Read-Write] A list of candidate objects to search for in the scene
  • desired_video_format (ARVideoFormat): [Read-Write] The desired video format (or the default if not supported) that this session should use if the camera is enabled Note: Call GetSupportedVideoFormats to get a list of device supported formats
  • enable_auto_focus (bool): [Read-Write] Whether the camera should use autofocus or not (can cause subtle shifts in position for small objects at macro camera distance)
  • enable_automatic_camera_overlay (bool): [Read-Write] Whether the AR camera feed should be drawn as an overlay or not. Defaults to true.
  • enable_automatic_camera_tracking (bool): [Read-Write] Whether the game camera should track the device movement or not. Defaults to true.
  • environment_capture_probe_type (AREnvironmentCaptureProbeType): [Read-Write] How the AR system should handle texture probe capturing
  • face_tracking_direction (ARFaceTrackingDirection): [Read-Write] Whether to track the face as if you are looking out of the device or as a mirror
  • face_tracking_update (ARFaceTrackingUpdate): [Read-Write] Whether to track the face as if you are looking out of the device or as a mirror
  • frame_sync_mode (ARFrameSyncMode): [Read-Write] EARFrameSyncMode:
  • horizontal_plane_detection (bool): [Read-Write] Should we detect flat horizontal surfaces: e.g. table tops, windows sills
  • light_estimation_mode (ARLightEstimationMode): [Read-Write] EARLightEstimationMode:
  • max_num_simultaneous_images_tracked (int32): [Read-Write] The maximum number of images to track at the same time. Defaults to 1
  • reset_camera_tracking (bool): [Read-Write] Whether the AR system should reset camera tracking (origin, transform) or not. Defaults to true.
  • reset_tracked_objects (bool): [Read-Write] Whether the AR system should remove any tracked objects or not. Defaults to true.
  • session_type (ARSessionType): [Read-Write] EARSessionType:
  • vertical_plane_detection (bool): [Read-Write] Should we detect flat vertical surfaces: e.g. paintings, monitors, book cases
  • world_alignment (ARWorldAlignment): [Read-Write] EARWorldAlignment:
  • world_map_data (Array(uint8)): [Read-Only] A previously saved world that is to be loaded when the session starts
add_candidate_image(new_candidate_image) → None

Add a new CandidateImage to the ARSessionConfig.

Parameters:new_candidate_image (ARCandidateImage) –
add_candidate_object(candidate_object) → None

CandidateObjects:

Parameters:candidate_object (ARCandidateObject) –
get_candidate_image_list() -> Array(ARCandidateImage)

CandidateImages:

Returns:
Return type:Array(ARCandidateImage)
get_candidate_object_list() -> Array(ARCandidateObject)

CandidateObjects:

Returns:
Return type:Array(ARCandidateObject)
get_desired_video_format() → ARVideoFormat

DesiredVideoFormat:

Returns:
Return type:ARVideoFormat
get_environment_capture_probe_type() → AREnvironmentCaptureProbeType

EnvironmentCaptureProbeType:

Returns:
Return type:AREnvironmentCaptureProbeType
get_face_tracking_direction() → ARFaceTrackingDirection

FaceTrackingDirection:

Returns:
Return type:ARFaceTrackingDirection
get_face_tracking_update() → ARFaceTrackingUpdate

FaceTrackingUpdate:

Returns:
Return type:ARFaceTrackingUpdate
get_frame_sync_mode() → ARFrameSyncMode

FrameSyncMode:

Returns:
Return type:ARFrameSyncMode
get_light_estimation_mode() → ARLightEstimationMode

LightEstimationMode:

Returns:
Return type:ARLightEstimationMode
get_max_num_simultaneous_images_tracked() → int32

MaxNumSimultaneousImagesTracked:

Returns:
Return type:int32
get_plane_detection_mode() → ARPlaneDetectionMode

PlaneDetectionMode:

Returns:
Return type:ARPlaneDetectionMode
get_session_type() → ARSessionType

SessionType:

Returns:
Return type:ARSessionType
get_world_alignment() → ARWorldAlignment

EARWorldAlignment:

Returns:
Return type:ARWorldAlignment
get_world_map_data() -> Array(uint8)

WorldMapData:

Returns:
Return type:Array(uint8)
set_candidate_object_list(candidate_objects) → None

CandidateObjects:

Parameters:candidate_objects (Array(ARCandidateObject)) –
set_desired_video_format(new_format) → None

DesiredVideoFormat:

Parameters:new_format (ARVideoFormat) –
set_enable_auto_focus(new_value) → None

bEnableAutoFocus:

Parameters:new_value (bool) –
set_face_tracking_direction(direction) → None

FaceTrackingDirection:

Parameters:direction (ARFaceTrackingDirection) –
set_face_tracking_update(update) → None

FaceTrackingUpdate:

Parameters:update (ARFaceTrackingUpdate) –
set_reset_camera_tracking(new_value) → None

bResetCameraTracking:

Parameters:new_value (bool) –
set_reset_tracked_objects(new_value) → None

bResetTrackedObjects:

Parameters:new_value (bool) –
set_world_map_data(world_map_data) → None

WorldMapData:

Parameters:world_map_data (Array(uint8)) –
should_enable_auto_focus() → bool

bEnableAutoFocus:

Returns:
Return type:bool
should_enable_camera_tracking() → bool

bEnableAutomaticCameraTracking:

Returns:
Return type:bool
should_render_camera_overlay() → bool

bEnableAutomaticCameraOverlay:

Returns:
Return type:bool
should_reset_camera_tracking() → bool

bResetCameraTracking:

Returns:
Return type:bool
should_reset_tracked_objects() → bool

bResetTrackedObjects:

Returns:
Return type:bool