unreal.AppleARKitSettings

class unreal.AppleARKitSettings(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: 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] Adjust Thread Priorities During ARSession: Whether to adjust thread priorities during an AR session or not

  • ar_kit_timecode_provider (str): [Read-Write] ARKit Timecode Provider: 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] Default Face Tracking Direction: 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] Default Face Tracking Live Link Subject Name: The default name to use when publishing face tracking name If multiple faces are tracked, the subject name for the faces will be: #1: DefaultFaceTrackingLiveLinkSubjectName #2: DefaultFaceTrackingLiveLinkSubjectName-1 #3: DefaultFaceTrackingLiveLinkSubjectName-2, etc

  • default_pose_tracking_live_link_subject_name (Name): [Read-Write] Default Pose Tracking Live Link Subject Name: The default name to use when publishing pose tracking name

  • face_tracking_file_writer_type (ARFaceTrackingFileWriterType): [Read-Write] Face Tracking File Writer Type: The type of face AR publisher that writes to disk to create

  • face_tracking_log_data (bool): [Read-Write] Face Tracking Log Data: Whether file writing is enabled at all or not

  • face_tracking_log_dir (str): [Read-Write] Face Tracking Log Dir

  • face_tracking_write_each_frame (bool): [Read-Write] Face Tracking Write Each Frame: Whether to publish each frame or when the “FaceAR WriteCurveFile

  • game_thread_priority_override (int32): [Read-Write] Game Thread Priority Override: The game thread priority to change to when an AR session is running, default is 47

  • live_link_publishing_port (int32): [Read-Write] Live Link Publishing Port: The port to use when listening/sending LiveLink face blend shapes via the network

  • livelink_tracking_types (Array[LivelinkTrackingType]): [Read-Write] Livelink Tracking Types: Livelink tracking type. To publish face blend shapes, or body pose data to LiveLink, or none

  • render_thread_priority_override (int32): [Read-Write] Render Thread Priority Override: The render thread priority to change to when an AR session is running, default is 45

  • require_ar_kit_support (bool): [Read-Write] Require ARKit Support: When True the project can only be installed on devices that support ARKit.

  • should_write_camera_image_per_frame (bool): [Read-Write] Should Write Camera Image Per Frame: Whether to publish the camera image each frame

  • written_camera_image_quality (int32): [Read-Write] Written Camera Image Quality: 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] Written Camera Image Rotation: Defaults to none. Use Right when in portrait mode

  • written_camera_image_scale (float): [Read-Write] Written Camera Image Scale: The scale to write the images at. Used to reduce data footprint

property adjust_thread_priorities_during_ar_session: bool

[Read-Only] Adjust Thread Priorities During ARSession: Whether to adjust thread priorities during an AR session or not

Type:

(bool)

property ar_kit_timecode_provider: str

[Read-Only] ARKit Timecode Provider: 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

Type:

(str)

property default_face_tracking_direction: ARFaceTrackingDirection

[Read-Only] Default Face Tracking Direction: The default tracking to use when tracking face blend shapes (face relative or mirrored). Defaults to face relative

Type:

(ARFaceTrackingDirection)

[Read-Only] Default Face Tracking Live Link Subject Name: The default name to use when publishing face tracking name If multiple faces are tracked, the subject name for the faces will be: #1: DefaultFaceTrackingLiveLinkSubjectName #2: DefaultFaceTrackingLiveLinkSubjectName-1 #3: DefaultFaceTrackingLiveLinkSubjectName-2, etc

Type:

(Name)

[Read-Only] Default Pose Tracking Live Link Subject Name: The default name to use when publishing pose tracking name

Type:

(Name)

property face_tracking_file_writer_type: ARFaceTrackingFileWriterType

[Read-Only] Face Tracking File Writer Type: The type of face AR publisher that writes to disk to create

Type:

(ARFaceTrackingFileWriterType)

property face_tracking_log_data: bool

[Read-Only] Face Tracking Log Data: Whether file writing is enabled at all or not

Type:

(bool)

property face_tracking_log_dir: str

[Read-Only] Face Tracking Log Dir

Type:

(str)

property face_tracking_write_each_frame: bool

[Read-Only] Face Tracking Write Each Frame: Whether to publish each frame or when the “FaceAR WriteCurveFile

Type:

(bool)

property game_thread_priority_override: int

[Read-Only] Game Thread Priority Override: The game thread priority to change to when an AR session is running, default is 47

Type:

(int32)

[Read-Only] Live Link Publishing Port: The port to use when listening/sending LiveLink face blend shapes via the network

Type:

(int32)

[Read-Only] Livelink Tracking Types: Livelink tracking type. To publish face blend shapes, or body pose data to LiveLink, or none

Type:

(Array[LivelinkTrackingType])

property render_thread_priority_override: int

[Read-Only] Render Thread Priority Override: The render thread priority to change to when an AR session is running, default is 45

Type:

(int32)

property require_ar_kit_support: bool

[Read-Only] Require ARKit Support: When True the project can only be installed on devices that support ARKit.

Type:

(bool)

property should_write_camera_image_per_frame: bool

[Read-Only] Should Write Camera Image Per Frame: Whether to publish the camera image each frame

Type:

(bool)

property written_camera_image_quality: int

[Read-Only] Written Camera Image Quality: The quality setting to generate the jpeg images at. Defaults to 85, which is “high quality”. Lower values reduce data footprint

Type:

(int32)

property written_camera_image_rotation: TextureRotationDirection

[Read-Only] Written Camera Image Rotation: Defaults to none. Use Right when in portrait mode

Type:

(TextureRotationDirection)

property written_camera_image_scale: float

[Read-Only] Written Camera Image Scale: The scale to write the images at. Used to reduce data footprint

Type:

(float)