Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > AppleARKit > UAppleARKitSettings

Light Theme

Dark Theme

UAppleARKitSettings

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAppleARKitSettings

References

Module	AppleARKit
Header	/Engine/Plugins/Runtime/AR/AppleAR/AppleARKit/Source/AppleARKit/Public/AppleARKitSettings.h
Include	#include "AppleARKitSettings.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine, defaultconfig)
class UAppleARKitSettings :
public UObject,
public FSelfRegisteringExec

Variables

	Name	Description
FString	ARKitTimecodeProvider	Used to specify the timecode provider to use when identifying when an update occurred.
bool	bAdjustThreadPrioritiesDuringARSession	Whether to adjust thread priorities during an AR session or not
bool	bFaceTrackingLogData	Whether file writing is enabled at all or not
bool	bFaceTrackingWriteEachFrame	Whether to publish each frame or when the "FaceAR WriteCurveFile
bool	bRequireARKitSupport	Where to write the curve files and image files
bool	bShouldWriteCameraImagePerFrame	Whether to publish the camera image each frame
EARFaceTracking...	DefaultFaceTrackingDirection	The default tracking to use when tracking face blend shapes (face relative or mirrored).
FName	DefaultFaceTrackingLiveLinkSubjectName	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
FName	DefaultPoseTrackingLiveLinkSubjectName	The default name to use when publishing pose tracking name
EARFaceTracking...	FaceTrackingFileWriterType	The type of face AR publisher that writes to disk to create
FString	FaceTrackingLogDir
int32	GameThreadPriorityOverride	The game thread priority to change to when an AR session is running, default is 47
int32	LiveLinkPublishingPort	The port to use when listening/sending LiveLink face blend shapes via the network
TArray< ELiveli...	LivelinkTrackingTypes	Livelink tracking type. To publish face blend shapes, or body pose data to LiveLink, or none
int32	RenderThreadPriorityOverride	The render thread priority to change to when an AR session is running, default is 45
int32	WrittenCameraImageQuality	The quality setting to generate the jpeg images at.
ETextureRotatio...	WrittenCameraImageRotation	Defaults to none. Use Right when in portrait mode
float	WrittenCameraImageScale	The scale to write the images at. Used to reduce data footprint

Constructors

	Name	Description
	UAppleARKitSettings()

Functions

	Name	Description
void	CreateFaceTrackingLogDir()
void	CreateImageLogDir()
EARFaceTrack...	GetFaceTrackingDirection()
EARFaceTrack...	GetFaceTrackingFileWriterType()
FName	GetFaceTrackingLiveLinkSubjectName()
FString	GetFaceTrackingLogDir()	Accessors to the properties.
int32	GetGameThreadPriorityOverride()
int32	GetLiveLinkPublishingPort()
FName	GetPoseTrackingLiveLinkSubjectName()
int32	GetRenderThreadPriorityOverride()
UTimecodePro...	GetTimecodeProvider()
int32	GetWrittenCameraImageQuality()
ETextureRota...	GetWrittenCameraImageRotation()
float	GetWrittenCameraImageScale()
bool	IsFaceTrackingLoggingEnabled()
bool	IsLiveLinkEnabledForFaceTracking()
bool	IsLiveLinkEnabledForPoseTracking()
bool	ShouldAdjustThreadPriorities()
bool	ShouldFaceTrackingLogPerFrame()
bool	ShouldWriteCameraImagePerFrame()

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss