unreal.AppleARKitSettings

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

Bases: unreal.Object

Apple ARKit Settings

C++ Source:

  • Plugin: AppleARKit
  • Module: AppleARKit
  • File: AppleARKitSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • adjust_thread_priorities_during_ar_session (bool): [Read-Write] Whether to adjust thread priorities during an AR session or not
  • ar_kit_timecode_provider (str): [Read-Write] Used to specify the timecode provider to use when identifying when an update occurred. Useful when using external timecode generators to sync multiple devices/machines
  • default_face_tracking_direction (ARFaceTrackingDirection): [Read-Write] The default tracking to use when tracking face blend shapes (face relative or mirrored). Defaults to face relative
  • default_face_tracking_live_link_subject_name (Name): [Read-Write] The default name to use when publishing face tracking name
  • enable_live_link_for_face_tracking (bool): [Read-Write] Whether to publish face blend shapes to LiveLink or not
  • face_tracking_file_writer_type (ARFaceTrackingFileWriterType): [Read-Write] The type of face AR publisher that writes to disk to create
  • face_tracking_log_data (bool): [Read-Write] Whether file writing is enabled at all or not
  • face_tracking_log_dir (str): [Read-Write] Where to write the curve files and image files
  • face_tracking_write_each_frame (bool): [Read-Write] Whether to publish each frame or when the “FaceAR WriteCurveFile
  • game_thread_priority_override (int32): [Read-Write] The game thread priority to change to when an AR session is running, default is 47
  • live_link_publishing_port (int32): [Read-Write] The port to use when listening/sending LiveLink face blend shapes via the network
  • render_thread_priority_override (int32): [Read-Write] The render thread priority to change to when an AR session is running, default is 45
  • should_write_camera_image_per_frame (bool): [Read-Write] Whether to publish the camera image each frame
  • written_camera_image_quality (int32): [Read-Write] The quality setting to generate the jpeg images at. Defaults to 85, which is “high quality”. Lower values reduce data footprint
  • written_camera_image_rotation (TextureRotationDirection): [Read-Write] Defaults to none. Use Right when in portrait mode
  • written_camera_image_scale (float): [Read-Write] The scale to write the images at. Used to reduce data footprint
adjust_thread_priorities_during_ar_session

(bool) – [Read-Only] Whether to adjust thread priorities during an AR session or not

ar_kit_timecode_provider

(str) – [Read-Only] Used to specify the timecode provider to use when identifying when an update occurred. Useful when using external timecode generators to sync multiple devices/machines

default_face_tracking_direction

(ARFaceTrackingDirection) – [Read-Only] The default tracking to use when tracking face blend shapes (face relative or mirrored). Defaults to face relative

(Name) – [Read-Only] The default name to use when publishing face tracking name

(bool) – [Read-Only] Whether to publish face blend shapes to LiveLink or not

face_tracking_file_writer_type

(ARFaceTrackingFileWriterType) – [Read-Only] The type of face AR publisher that writes to disk to create

face_tracking_log_data

(bool) – [Read-Only] Whether file writing is enabled at all or not

face_tracking_log_dir

(str) – [Read-Only] Where to write the curve files and image files

face_tracking_write_each_frame

(bool) – [Read-Only] Whether to publish each frame or when the “FaceAR WriteCurveFile

game_thread_priority_override

(int32) – [Read-Only] The game thread priority to change to when an AR session is running, default is 47

(int32) – [Read-Only] The port to use when listening/sending LiveLink face blend shapes via the network

render_thread_priority_override

(int32) – [Read-Only] The render thread priority to change to when an AR session is running, default is 45

should_write_camera_image_per_frame

(bool) – [Read-Only] Whether to publish the camera image each frame

written_camera_image_quality

(int32) – [Read-Only] The quality setting to generate the jpeg images at. Defaults to 85, which is “high quality”. Lower values reduce data footprint

written_camera_image_rotation

(TextureRotationDirection) – [Read-Only] Defaults to none. Use Right when in portrait mode

written_camera_image_scale

(float) – [Read-Only] The scale to write the images at. Used to reduce data footprint