description: For a point P in the AR local space, whose location and rotation are "OriginLocation" and "OriginRotation" in the world space modify the alignment transform so that the same point P will be transformed to the origin in the world space. : whether "OriginLocation" and "OriginRotation" are specified in UE4's world space or AR system's local space. : if set, only the yaw roation of the alignment transform will be modified, pitch and roll will be zeroed out.

code: static void SetARWorldOriginLocationAndRotation ( FVector OriginLocation, FRotator OriginRotation, bool bIsTransformInWorldSpace, bool bMaintainUpDirection )


description: Enable or disable Mixed Reality Capture camera.

module: AugmentedReality

code: static void SetEnabledXRCamera ( bool bOnOff )


description: Begin a new Augmented Reality session. Subsequently, use the `GetARSessionStatus()_ function to figure out the status of the session.

code: static void StartARSession ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig )


description: Stop a running Augmented Reality session and clear any state.

code: static void StopARSession()


description: Starts or stops a battery intensive service on device.

code: static bool ToggleARCapture ( const bool bOnOff, const EARCaptureType CaptureType )


description: Given a pinned `ComponentToUnpin_, remove its attachment to the real world.

code: static void UnpinComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToUnpin )


description: Change screen size of Mixed Reality Capture camera.

code: static FIntPoint ResizeXRCamera ( const FIntPoint & InSize )


className: UARBlueprintLibrary

code: class UARBlueprintLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


description: FriendlyName

code: const [FString](API\Runtime\Core\Containers\FString) & GetFriendlyName() const


code: static [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * CreateNewARCandidateImage ( [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * InCandidateTexture, [FString](API\Runtime\Core\Containers\FString) InFriendlyName, float InPhysicalWidth, float InPhysicalHeight, EARCandidateImageOrientation InOrientation )


description: CandidateTexture

code: [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * GetCandidateTexture() const


description: Height

code: float GetPhysicalHeight() const


description: Orientation


description: Width

code: float GetPhysicalWidth() const


description: Used to enforce physical sizes matching the aspect ratio of the images

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


className: UARCandidateImage

description: An asset that points to an image to be detected in a scene and provides the size of the object in real life

code: class UARCandidateImage : public [UDataAsset](API\Runtime\Engine\Engine\UDataAsset)

CandidateTexture

type: TObjectPtr<UTe...

description: The image to detect in scenes

FriendlyName

type: FString

description: The friendly name to report back when the image is detected in scenes

Height

type: float

description: The physical height in centimeters of the object that this candidate image represents.

Orientation

type: EARCandidateIma...

description: The orientation to treat the candidate image as. Ignored in ARCore

Width

description: The physical width in centimeters of the object that this candidate image represents


description: BoundingBox

code: const FBox & GetBoundingBox() const


description: CandidateObjectData

code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetCandidateObjectData() const


code: void SetBoundingBox ( const FBox & InBoundingBox )


code: void SetCandidateObjectData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InCandidateObject )


className: UARCandidateObject

description: An asset that points to an object to be detected in a scene

code: class UARCandidateObject : public [UDataAsset](API\Runtime\Engine\Engine\UDataAsset)


code: void SetFriendlyName ( const [FString](API\Runtime\Core\Containers\FString) & NewName )


className: FMRMeshDelegate

code: typedef TMulticastDelegate_OneParam< void, [UMRMeshComponent](API\Runtime\MRMesh\UMRMeshComponent) * > FMRMeshDelegate


code: void ManageMeshComponentForDebugMode ( bool bDebugModeEnabled, const [FARSessionPayload](API\Runtime\AugmentedReality\FARSessionPayload) & SessionPayload )


description: Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.

code: virtual void OnUnregister()


code: virtual void OnRep_Payload()


description: Event when native representation is removed, called on server and clients.

code: void ReceiveRemove()


code: virtual void Remove ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry )


code: void RemoveMeshComponent ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry )


code: void SetNativeID ( [FGuid](API\Runtime\Core\Misc\FGuid) NativeID )


code: virtual void Update ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry )


code: void UpdateVisualization()


description: Latent action to check AR availability on the current platform.

code: virtual void CheckARServiceAvailability ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, EARServiceAvailability & OutAvailability )


className: UARComponent

description: A MRMeshComponent will be created if mesh visualization is enabled (seeUARSessionConfig::bGenerateMeshDataFromTrackedGeometry) It can be accessed via 'GetMRMesh' or 'UARTrackedGeometry::GetUnderlyingMesh'

code: class UARComponent : public [USceneComponent](API\Runtime\Engine\Components\USceneComponent)

bFirstUpdate

type: bool

description: If this component has ever been updated

bIsRemoved

description: If 'ReceiveRemove' has been called for this component

bUseDefaultReplication

description: If the default replication logic should be used for this component

DefaultMeshMaterial

type: TObjectPtr<UMa...

description: The default material to be used for the generated mesh component.

DefaultWireframeMeshMaterial

description: The default wireframe material to be used for the generated mesh component.

MRMeshComponent

type: TObjectPtr<UMR...

MyTrackedGeometry

type: TObjectPtr<UAR...

description: The tracked geometry used for updating this component, only set on "local" client

NativeID

type: FGuid

OnMRMeshCreated

type: FMRMeshDelegate

SavedWireframeColor

type: FLinearColor


description: the dependency handler for the current platform. Can return null if the current platform doesn't support AR, or the AR system doesn't require dependency handling.

code: static [UARDependencyHandler](API\Runtime\AugmentedReality\UARDependencyHandler) * GetARDependencyHandler()


description: Latent action to install AR service on the current platform.

code: virtual void InstallARService ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, EARServiceInstallRequestResult & OutInstallResult )


description: Latent action to request permission to run the supplied session configuration.

code: virtual void RequestARSessionPermission ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig, [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo, EARServicePermissionRequestResult & OutPermissionResult )


description: Latent action to start AR session. Will make sure dependency and permission issues are resolved internally, only returns the AR session starts successfully.

code: virtual void StartARSessionLatent ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig, [FLatentActionInfo](API\Runtime\Engine\Engine\FLatentActionInfo) LatentInfo )


className: UARDependencyHandler

description: Call "UARBlueprintLibrary::StartARSession" to start the session. Alternatively, you can also call "StartARSessionLatent" which handles dependency and permission internally.

code: class UARDependencyHandler : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Draw a box visulizing the bounds of the probe

code: virtual void DebugDraw ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutlineColor, float OutlineThickness, float PersistForSeconds ) const


description: EnvironmentCaptureTexture


description: Extent

code: FVector GetExtent() const


code: void GetNetworkPayload ( [FAREnvironmentProbeUpdatePayload](API\Runtime\AugmentedReality\FAREnvironmentProbeUpdatePayload) & Payload )


code: UAREnvironmentCaptureProbe()


code: void UpdateEnvironmentCapture ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, FVector InExtent )


description: Access the GUID which defines this texture's resources externally throughFExternalTextureRegistry

code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) GetExternalTextureGuid() const


className: UAREnvironmentCaptureProbe

description: A tracked environment texture probe that gives you a cube map for reflections

code: class UAREnvironmentCaptureProbe : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)

EnvironmentCaptureTexture

description: The cube map of the reflected environment

Extent

type: FVector

description: The size of area this probe covers


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


code: UAREnvironmentCaptureProbeTexture ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: UTextureinterface implementation.

code: virtual float GetSurfaceWidth() const


className: UAREnvironmentCaptureProbeTexture

description: Base class for all AR textures that represent the environment for lighting and reflection

code: class UAREnvironmentCaptureProbeTexture : public [UTextureCube](API\Runtime\Engine\Engine\UTextureCube)

ExternalTextureGuid

description: The guid of texture that gets registered as an external texture

Size

description: The width and height of the texture

TextureType

type: EARTextureType

description: The type of texture this is

Timestamp

description: The timestamp this texture was captured at


code: virtual void OnRep_Payload()


description: Event when native representation is updated, called on server and clients.

code: void ReceiveUpdate ( const [FAREnvironmentProbeUpdatePayload](API\Runtime\AugmentedReality\FAREnvironmentProbeUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FAREnvironmentProbeUpdatePayload](API\Runtime\AugmentedReality\FAREnvironmentProbeUpdatePayload) & NewPayload )


description: Event when native representation is first added, called on server and clients.

code: void ReceiveAdd ( const [FAREnvironmentProbeUpdatePayload](API\Runtime\AugmentedReality\FAREnvironmentProbeUpdatePayload) & Payload )


description: Overridable native event for when native representation is updated.

code: virtual void Update ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry )


className: UAREnvironmentProbeComponent

code: class UAREnvironmentProbeComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

ReplicatedPayload

type: FAREnvironmentP...


code: static int32 GetDebugMode()


code: void ReceiveAdd ( const [FARFaceUpdatePayload](API\Runtime\AugmentedReality\FARFaceUpdatePayload) & Payload )


code: void ReceiveUpdate ( const [FARFaceUpdatePayload](API\Runtime\AugmentedReality\FARFaceUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FARFaceUpdatePayload](API\Runtime\AugmentedReality\FARFaceUpdatePayload) & NewPayload )


code: static void SetFaceComponentDebugMode ( EFaceComponentDebugMode NewDebugMode )


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


className: UARFaceComponent

code: class UARFaceComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

bFaceOutOfScreen

description: Whether the mesh should be rotated so that it's facing out of the screen.

bUpdateVertexNormal

description: Whether to automatically update the vertex normal when the mesh is updated.

type: FARFaceUpdatePa...

TransformSetting

type: EARFaceTransfor...

description: Determines how the transform from tracking data and the component's transform are mixed together.


code: virtual void DebugDraw ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutlineColor, float OutlineThickness, float PersistForSeconds ) const


code: const [TMap](API\Runtime\Core\Containers\TMap)< EARFaceBlendShape, float > GetBlendShapes() const


code: const FARBlendShapeMap & GetBlendShapesRef() const


code: float GetBlendShapeValue ( EARFaceBlendShape BlendShape ) const


code: const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & GetIndexBuffer() const


code: const FTransform & GetLocalSpaceEyeTransform ( EAREye Eye ) const


code: void GetNetworkPayload ( [FARFaceUpdatePayload](API\Runtime\AugmentedReality\FARFaceUpdatePayload) & Payload )


code: const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & GetVertexBuffer() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< FVector2D > & GetUVs() const


code: FTransform GetWorldSpaceEyeTransform ( EAREye Eye ) const


code: void UpdateFaceGeometry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InTransform, const FTransform & InAlignmentTransform, FARBlendShapeMap & InBlendShapes, [TArray](API\Runtime\Core\Containers\TArray)< FVector > & InVertices, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & Indices, [TArray](API\Runtime\Core\Containers\TArray)< FVector2D > & InUVs, const FTransform & InLeftEyeTransform, const FTransform & InRightEyeTransform, const FVector & InLookAtTarget )


code: float GetAltitudeMeters() const


className: UARFaceGeometry

code: class UARFaceGeometry : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)

LookAtTarget

description: The target the eyes are looking at


code: float GetLongitude() const


code: float GetLatitude() const


code: void GetNetworkPayload ( [FARGeoAnchorUpdatePayload](API\Runtime\AugmentedReality\FARGeoAnchorUpdatePayload) & Payload )


className: UARGeoAnchor

code: class UARGeoAnchor : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)


code: void UpdateGeoAnchor ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, float InLongitude, float InLatitude, float InAltitudeMeters, EARAltitudeSource InAltitudeSource )


code: static int32 GetDebugMode()


code: virtual void OnRep_Payload()


code: void ReceiveAdd ( const [FARGeoAnchorUpdatePayload](API\Runtime\AugmentedReality\FARGeoAnchorUpdatePayload) & Payload )


code: void ReceiveUpdate ( const [FARGeoAnchorUpdatePayload](API\Runtime\AugmentedReality\FARGeoAnchorUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FARGeoAnchorUpdatePayload](API\Runtime\AugmentedReality\FARGeoAnchorUpdatePayload) & NewPayload )


code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


code: static void SetGeoAnchorComponentDebugMode ( EGeoAnchorComponentDebugMode NewDebugMode )


className: UARGeoAnchorComponent

code: class UARGeoAnchorComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

ReplicatedPayload

type: FARGeoAnchorUpd...


description: add an Geo anchor at a specific location with an altitude (in meters).

code: virtual bool AddGeoAnchorAtLocationWithAltitude ( float Longitude, float Latitude, float AltitudeMeters, [FString](API\Runtime\Core\Containers\FString) OptionalAnchorName )


description: add an Geo anchor at a specific location.

code: virtual bool AddGeoAnchorAtLocation ( float Longitude, float Latitude, [FString](API\Runtime\Core\Containers\FString) OptionalAnchorName )


description: the async task to check Geo tracking availability at the user's current location. Can return null if the feature is not supported.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCheckGeoTrackingAvailabilityAsyncTask](API\Runtime\AugmentedReality\FCheckGeoTrackingAvailabilityAsy-), ESPMode::ThreadSafe > CheckGeoTrackingAvailability ( [FString](API\Runtime\Core\Containers\FString) & OutError )


description: the async task to convert a UE4 world position into a Geo location. Can return null if the feature is not supported.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FGetGeoLocationAsyncTask](API\Runtime\AugmentedReality\FGetGeoLocationAsyncTask), ESPMode::ThreadSafe > GetGeoLocationAtWorldPosition ( const FVector & WorldPosition, [FString](API\Runtime\Core\Containers\FString) & OutError )


code: virtual void Update ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry )


description: the async task to check Geo tracking availability at a specific location. Can return null if the feature is not supported.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCheckGeoTrackingAvailabilityAsyncTask](API\Runtime\AugmentedReality\FCheckGeoTrackingAvailabilityAsy-), ESPMode::ThreadSafe > CheckGeoTrackingAvailability ( float Longitude, float Latitude, [FString](API\Runtime\Core\Containers\FString) & OutError )


description: the current session's Geo tracking state accuracy.

code: virtual EARGeoTrackingAccuracy GetGeoTrackingAccuracy() const


description: the current session's Geo tracking state.

code: virtual EARGeoTrackingState GetGeoTrackingState() const


description: the current session's Geo tracking state reason.

code: virtual EARGeoTrackingStateReason GetGeoTrackingStateReason() const


description: the interface object to support Geo tracking, return null on platforms don't support the feature.

code: static [UARGeoTrackingSupport](API\Runtime\AugmentedReality\UARGeoTrackingSupport) * GetGeoTrackingSupport()


className: UARGeoTrackingSupport

description: Interface class for Geo tracking related features.

code: class UARGeoTrackingSupport : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Saves the point cloud centered at the specified location capturing all of the features within the specified extent as an object that can be detected later

code: static [UARGetCandidateObjectAsyncTaskBlueprintProxy](API\Runtime\AugmentedReality\UARGetCandidateObjectAsyncTaskBl-) * ARGetCandidateObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, FVector Location, FVector Extent )


className: FInstanceARActorToBeDestroyedDelegate

description: Called just before the AR actor is destroyed on the server


code: class UARGetCandidateObjectAsyncTaskBlueprintProxy : public [UARBaseAsyncTaskBlueprintProxy](API\Runtime\AugmentedReality\UARBaseAsyncTaskBlueprintProxy)

OnFailed

type: FARGetCandidate...


className: FInstanceARActorSpawnedDelegate

description: Called when an AR actor is spawned on the server

code: class FInstanceARActorSpawnedDelegate


className: FOnSpawnARActorDelegate

code: typedef TMulticastDelegate_ThreeParams< void, [AARActor](API\Runtime\AugmentedReality\AARActor) *, [UARComponent](API\Runtime\AugmentedReality\UARComponent) *, [FGuid](API\Runtime\Core\Misc\FGuid) > FOnSpawnARActorDelegate


className: FRequestDestroyARActorDelegate

code: typedef TMulticastDelegate_OneParam< void, [AARActor](API\Runtime\AugmentedReality\AARActor) * > FRequestDestroyARActorDelegate


className: FRequestSpawnARActorDelegate

code: typedef TMulticastDelegate_TwoParams< void, [UClass](API\Runtime\CoreUObject\UObject\UClass) *, [FGuid](API\Runtime\Core\Misc\FGuid) > FRequestSpawnARActorDelegate


description: Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.

code: virtual void OnUnregister()


className: RequestDestroyARActorDelegate


className: RequestSpawnARActorDelegate


className: UARLightEstimate

code: class UARLightEstimate : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UARLifeCycleComponent

code: class UARLifeCycleComponent : public [USceneComponent](API\Runtime\Engine\Components\USceneComponent)

OnARActorSpawnedDelegate

type: FInstanceARActo...


code: virtual void OnRep_Payload()


description: Event when native representation is first added, called on server and clients.

code: void ReceiveAdd ( const [FARMeshUpdatePayload](API\Runtime\AugmentedReality\FARMeshUpdatePayload) & Payload )


description: Event when native representation is updated, called on server and clients.

code: void ReceiveUpdate ( const [FARMeshUpdatePayload](API\Runtime\AugmentedReality\FARMeshUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FARMeshUpdatePayload](API\Runtime\AugmentedReality\FARMeshUpdatePayload) & NewPayload )


description: Overridable native event for when native representation is updated.

code: virtual void Update ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry )


className: UARMeshComponent

code: class UARMeshComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

ReplicatedPayload

type: FARMeshUpdatePa...


code: void GetNetworkPayload ( [FARMeshUpdatePayload](API\Runtime\AugmentedReality\FARMeshUpdatePayload) & Payload )


code: virtual bool GetObjectClassificationAtLocation ( const FVector & InWorldLocation, EARObjectClassification & OutClassification, FVector & OutClassificationLocation, float MaxLocationDiff )


className: UARMeshGeometry

code: class UARMeshGeometry : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)


code: void ReceiveAdd ( const [FARObjectUpdatePayload](API\Runtime\AugmentedReality\FARObjectUpdatePayload) & Payload )


code: void ReceiveUpdate ( const [FARObjectUpdatePayload](API\Runtime\AugmentedReality\FARObjectUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FARObjectUpdatePayload](API\Runtime\AugmentedReality\FARObjectUpdatePayload) & NewPayload )


className: UARObjectComponent

code: class UARObjectComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

type: FARObjectUpdate...


code: virtual void DebugDraw ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & Color, float Scale, float PersistForSeconds ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > GetARSystem() const


className: DebugPinId

code: static uint32 DebugPinId = 0;


description: Maps from a Pin's Local Space to the Tracking Space. Mapping the origin from the Pin's Local Space to Tracking Space yield the Pin's position in Tracking Space.


code: void * GetNativeResource()


description: Convenience function. Same as LocalToTrackingTransform, but appends the TrackingToWorld Transform.


description: the PinnedComponent that thisUARPinis pinning to the TrackedGeometry

code: [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * GetPinnedComponent() const


description: Return the current tracking state of this Pin.


description: The TrackedGeometry (if any) that this this pin is being "stuck" into.

code: [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * GetTrackedGeometry() const


code: virtual void InitARPin ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystemOwner, [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * InComponentToPin, const FTransform & InLocalToTrackingTransform, [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * InTrackedGeometry, const [FName](API\Runtime\Core\UObject\FName) InDebugName )


description: Notify the ARPin about changes to how it is being tracked.

code: void OnTrackingStateChanged ( EARTrackingState NewTrackingState )


description: Notify thisUARPinthat the transform of the Pin has changed

code: void OnTransformUpdated ( const FTransform & NewLocalToTrackingTransform )


code: void SetNativeResource ( void * InNativeResource )


code: void SetOnARTrackingStateChanged ( const [FOnARTrackingStateChanged](API\Runtime\AugmentedReality\FOnARTrackingStateChanged) & InHandler )


code: void SetPinnedComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * InComponentToPin )


code: void SetOnARTransformUpdated ( const [FOnARTransformUpdated](API\Runtime\AugmentedReality\FOnARTransformUpdated) & InHandler )


className: UARPin

code: class UARPin : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Notify theUARPinthat the AlignmentTransform has changing.

code: void UpdateAlignmentTransform ( const FTransform & NewAlignmentTransform )


code: static int32 GetDebugMode()


code: static const [TMap](API\Runtime\Core\Containers\TMap)< EARObjectClassification, [FLinearColor](API\Runtime\Core\Math\FLinearColor) > & GetObjectClassificationDebugColors()


code: virtual void OnRep_Payload()


code: void ReceiveAdd ( const [FARPlaneUpdatePayload](API\Runtime\AugmentedReality\FARPlaneUpdatePayload) & Payload )


code: void ReceiveUpdate ( const [FARPlaneUpdatePayload](API\Runtime\AugmentedReality\FARPlaneUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FARPlaneUpdatePayload](API\Runtime\AugmentedReality\FARPlaneUpdatePayload) & NewPayload )


code: static void SetObjectClassificationDebugColors ( const [TMap](API\Runtime\Core\Containers\TMap)< EARObjectClassification, [FLinearColor](API\Runtime\Core\Math\FLinearColor) > & InColors )


code: static void SetPlaneComponentDebugMode ( EPlaneComponentDebugMode NewDebugMode )


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


code: virtual void Update ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry )


className: UARPlaneComponent

code: class UARPlaneComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

type: FARPlaneUpdateP...


code: virtual void DebugDraw ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutlineColor, float OutlineThickness, float PersistForSeconds ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< FVector > GetBoundaryPolygonInLocalSpace() const


code: FVector GetCenter() const


code: FVector GetExtent() const


code: void GetNetworkPayload ( [FARPlaneUpdatePayload](API\Runtime\AugmentedReality\FARPlaneUpdatePayload) & Payload )


code: [UARPlaneGeometry](API\Runtime\AugmentedReality\UARPlaneGeometry) * GetSubsumedBy() const


code: void SetOrientation ( EARPlaneOrientation InOrientation )


code: void UpdateTrackedGeometry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, const FVector InCenter, const FVector InExtent )


code: void UpdateTrackedGeometry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, const FVector InCenter, const FVector InExtent, const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & InBoundingPoly, [UARPlaneGeometry](API\Runtime\AugmentedReality\UARPlaneGeometry) * InSubsumedBy )


className: UARPlaneGeometry

code: class UARPlaneGeometry : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)


code: virtual void OnRep_Payload()


code: void ReceiveAdd ( const [FARPointUpdatePayload](API\Runtime\AugmentedReality\FARPointUpdatePayload) & Payload )


code: void ReceiveUpdate ( const [FARPointUpdatePayload](API\Runtime\AugmentedReality\FARPointUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FARPointUpdatePayload](API\Runtime\AugmentedReality\FARPointUpdatePayload) & NewPayload )


className: UARPointComponent

code: class UARPointComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

type: FARPointUpdateP...


code: static int32 GetDebugMode()


code: void ReceiveAdd ( const [FARPoseUpdatePayload](API\Runtime\AugmentedReality\FARPoseUpdatePayload) & Payload )


code: void ReceiveUpdate ( const [FARPoseUpdatePayload](API\Runtime\AugmentedReality\FARPoseUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FARPoseUpdatePayload](API\Runtime\AugmentedReality\FARPoseUpdatePayload) & NewPayload )


code: static void SetPoseComponentDebugMode ( EPoseComponentDebugMode NewDebugMode )


code: virtual void Update ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry )


code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


className: UARPoseComponent

code: class UARPoseComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

type: FARPoseUpdatePa...


code: void ReceiveAdd ( const [FARQRCodeUpdatePayload](API\Runtime\AugmentedReality\FARQRCodeUpdatePayload) & Payload )


code: void ReceiveUpdate ( const [FARQRCodeUpdatePayload](API\Runtime\AugmentedReality\FARQRCodeUpdatePayload) & Payload )


code: void ServerUpdatePayload ( const [FARQRCodeUpdatePayload](API\Runtime\AugmentedReality\FARQRCodeUpdatePayload) & NewPayload )


code: static void SetQRCodeComponentDebugMode ( EQRCodeComponentDebugMode NewDebugMode )


className: UARQRCodeComponent

code: class UARQRCodeComponent : public [UARComponent](API\Runtime\AugmentedReality\UARComponent)

type: FARQRCodeUpdate...


className: UARSaveWorldAsyncTaskBlueprintProxy

code: class UARSaveWorldAsyncTaskBlueprintProxy : public [UARBaseAsyncTaskBlueprintProxy](API\Runtime\AugmentedReality\UARBaseAsyncTaskBlueprintProxy)

OnFailed

type: FARSaveWorldPin


description: Saves an AR world to a byte array for network replication or saving to disk

code: static [UARSaveWorldAsyncTaskBlueprintProxy](API\Runtime\AugmentedReality\UARSaveWorldAsyncTaskBlueprintPr-) * ARSaveWorld ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject )


description: Add a new CandidateImage to the ARSessionConfig.

code: void AddCandidateImage ( [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * NewCandidateImage )


description: CandidateObjects

code: void AddCandidateObject ( [UARCandidateObject](API\Runtime\AugmentedReality\UARCandidateObject) * CandidateObject )


description: Remove all candidate images from the ARSessionConfig.

code: void ClearCandidateImages()


description: CandidateImages

code: const [TArray](API\Runtime\Core\Containers\TArray)< [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * > & GetCandidateImageList() const


description: CandidateObjects

code: const [TArray](API\Runtime\Core\Containers\TArray)< [UARCandidateObject](API\Runtime\AugmentedReality\UARCandidateObject) * > & GetCandidateObjectList() const


description: DefaultWireframeMeshMaterial

code: [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetDefaultWireframeMeshMaterial() const


description: DefaultMeshMaterial

code: [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetDefaultMeshMaterial() const


description: DesiredVideoFormat


description: EnabledSessionTrackingFeatures


description: EnvironmentProbeComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetEnvironmentProbeComponentClass() const


description: EnvironmentCaptureProbeType


description: FaceTrackingDirection


description: FaceComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetFaceComponentClass() const


description: FaceTrackingUpdate


description: FrameSyncMode


description: GeoAnchorComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetGeoAnchorComponentClass() const


description: ImageComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetImageComponentClass() const


description: MaxNumberOfTrackedFaces


description: LightEstimationMode


description: MaxNumSimultaneousImagesTracked


description: MeshComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetMeshComponentClass() const


code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetObjectComponentClass() const


description: PlaneDetectionMode


description: PlaneComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetPlaneComponentClass() const


description: PointComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetPointComponentClass() const


description: PoseComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetPoseComponentClass() const


description: QRCodeComponentClass

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetQRCodeComponentClass() const


description: SceneReconstructionMethod


description: SerializedARCandidateImageDatabase

code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetSerializedARCandidateImageDatabase() const


description: SessionType

code: EARSessionType GetSessionType() const


description: EARWorldAlignment


description: WorldMapData

code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetWorldMapData() const


description: Remove a candidate image from the ARSessionConfig, by pointer, note the image object must match, not the content of the image.

code: void RemoveCandidateImage ( [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * CandidateImage )


description: Remove a candidate image from the ARSessionConfig, by index.

code: void RemoveCandidateImageAtIndex ( int Index )


description: CandidateObjects

code: void SetCandidateObjectList ( const [TArray](API\Runtime\Core\Containers\TArray)< [UARCandidateObject](API\Runtime\AugmentedReality\UARCandidateObject) * > & InCandidateObjects )


description: DesiredVideoFormat

code: void SetDesiredVideoFormat ( [FARVideoFormat](API\Runtime\AugmentedReality\FARVideoFormat) NewFormat )


description: bEnableAutoFocus

code: void SetEnableAutoFocus ( bool bNewValue )


description: FaceTrackingDirection

code: void SetFaceTrackingDirection ( EARFaceTrackingDirection InDirection )


description: bResetCameraTracking

code: void SetResetCameraTracking ( bool bNewValue )


description: FaceTrackingUpdate

code: void SetFaceTrackingUpdate ( EARFaceTrackingUpdate InUpdate )


description: bResetTrackedObjects

code: void SetResetTrackedObjects ( bool bNewValue )


description: EnabledSessionTrackingFeatures

code: void SetSessionTrackingFeatureToEnable ( EARSessionTrackingFeature InSessionTrackingFeature )


description: SceneReconstructionMethod

code: void SetSceneReconstructionMethod ( EARSceneReconstruction InSceneReconstructionMethod )


description: bHorizontalPlaneDetection


description: WorldMapData

code: void SetWorldMapData ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > WorldMapData )


description: bVerticalPlaneDetection


description: bEnableAutoFocus

code: bool ShouldEnableAutoFocus() const


description: bEnableAutomaticCameraTracking

code: bool ShouldEnableCameraTracking() const


description: bEnableAutomaticCameraOverlay

code: bool ShouldRenderCameraOverlay() const


description: bResetCameraTracking

code: bool ShouldResetCameraTracking() const


description: bResetTrackedObjects

code: bool ShouldResetTrackedObjects() const


description: bUseOptimalVideoFormat


description: The constructor for the AR Session Config Data Asset.

code: UARSessionConfig()


className: UARSessionConfig

description: An Unreal Data Asset that defines what features are used in the AR session.

code: class UARSessionConfig : public [UDataAsset](API\Runtime\Engine\Engine\UDataAsset)

bEnableAutoFocus

type: bool

description: Boolean to determine whether the camera should autofocus.

bEnableAutomaticCameraOverlay

description: Boolean to determine whether the AR camera feed should be drawn as an overlay.

bEnableAutomaticCameraTracking

description: Boolean to determine whether the virtual camera should track the device movement.

bGenerateCollisionForMeshData

description: Boolean to determine whether the AR system should generate collision data from the mesh data.

bGenerateMeshDataFromTrackedGeometry

description: Boolean to determine whether the AR system should generate mesh data that can be used for rendering, collision, NavMesh, and more.

bHorizontalPlaneDetection

description: Boolean to determine whether flat, horizontal surfaces are detected.

bRenderMeshDataInWireframe

description: Boolean to determine whether the AR system should render the mesh data as wireframe.

bResetCameraTracking

description: Boolean to determine whether the AR system should reset camera tracking, such as its origin and transforms, when a new AR session starts.

bResetTrackedObjects

description: Boolean to determine whether the AR system should remove any tracked objects when a new AR session starts.

bTrackSceneObjects

description: Boolean to determine whether the AR system should track scene objects:

bUseAutomaticImageScaleEstimation

description: Boolean to determine whether to automatically estimate and set the scale of a detected, or tracked, image.

bUseMeshDataForOcclusion

description: Boolean to determine whether the AR system should render the mesh data as occlusion meshes.

bUseOptimalVideoFormat

description: Boolean to determine whether to automatically pick the video format that best matches the device screen size

bUsePersonSegmentationForOcclusion

description: Boolean to determine whether to use the person segmentation results for occluding virtual content.

bUseSceneDepthForOcclusion

description: Boolean to determine whether to use the scene depth information for occluding virtual content.

bUseStandardOnboardingUX

description: Boolean to determine whether to use the standard onboarding UX, if the system supports it.

bVerticalPlaneDetection

description: Boolean to determine whether flat, vertical surfaces are detected.

CandidateImages

type: TArray<TObject...

description: The list of candidate images to detect within the AR camera view. This feature is used by ARKit.

CandidateObjects

description: The list of candidate objects to search for in the scene. This feature is used by ARKit.

DefaultMeshMaterial

type: TObjectPtr<UMa...

description: The default mesh material used by the generated mesh component.

DefaultWireframeMeshMaterial

description: The default mesh material used by the wireframe setting of the generated mesh component.

DesiredVideoFormat

type: FARVideoFormat

description: The desired video format (or the default, if not supported) that this session should use if the camera is enabled.

EnabledSessionTrackingFeature

type: EARSessionTrack...

EnvironmentCaptureProbeType

type: EAREnvironmentC...

EnvironmentProbeComponentClass

type: TSubclassOf<UA...

FaceTrackingDirection

type: EARFaceTracking...

FrameSyncMode

type: EARFrameSyncMod...

LightEstimationMode

type: EARLightEstimat...

MaxNumberOfTrackedFaces

description: The maximum number of faces to track simultaneously. This feature is used by ARKit.

MaxNumSimultaneousImagesTracked

description: The maximum number of images to track at the same time.

SceneReconstructionMethod

type: EARSceneReconst...

SerializedARCandidateImageDatabase

type: TArray< uint8 >

description: Data array for storing the cooked image database. This feature is used by ARCore.

SessionType

type: EARSessionType

WorldAlignment

type: EARWorldAlignme...

WorldMapData

description: A previously saved world that will be loaded when the session starts.


description: Factory function for creating a new AR texture of a particular type

code: template<class T> static T * CreateARTexture ( EARTextureType InTextureType )


description: Access the GUID which defines this texture's resources externally throughFExternalTextureRegistry

code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) GetExternalTextureGuid() const


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: UTextureinterface implementation.

code: virtual float GetSurfaceWidth() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


code: UARTexture ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UARTexture

description: Base class for all AR texture types. Derived fromUTextureinstead ofUTexture2DbecauseUTexture2Dis all about streaming and source art ? probably should have beenUTexture2DDynamic

code: class UARTexture : public [UTexture](API\Runtime\Engine\Engine\UTexture)

ExternalTextureGuid

type: FGuid

description: The guid of texture that gets registered as an external texture

Size

description: The width and height of the texture

TextureType

type: EARTextureType

description: The type of texture this is

Timestamp

type: float

description: The timestamp this texture was captured at


code: UARTextureCameraDepth ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UARTextureCameraDepth

description: Base class for all AR textures that represent the camera depth data

code: class UARTextureCameraDepth : public [UARTexture](API\Runtime\AugmentedReality\UARTexture)

bIsTemporallySmoothed

type: bool

description: Whether or not the depth information is temporally smoothed

DepthAccuracy

type: EARDepthAccurac...

description: The accuracy of the depth information captured this frame

DepthQuality

type: EARDepthQuality

description: The quality of the depth information captured this frame


code: UARTextureCameraImage ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UARTraceResultDummy

code: class UARTraceResultDummy : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UARTextureCameraImage

description: Base class for all AR textures that represent the camera image data

code: class UARTextureCameraImage : public [UARTexture](API\Runtime\AugmentedReality\UARTexture)


description: the distance from the camera to the traced location in Unreal Units.

code: static float GetDistanceFromCamera ( const [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) & TraceResult )


description: SetAlignmentTransform()

code: static FTransform GetLocalToTrackingTransform ( const [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) & TraceResult )


description: Get the transform of the trace result in Unreal World Space.

code: static FTransform GetLocalToWorldTransform ( const [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) & TraceResult )


description: Get the transform of the trace result in the AR system's local space.

code: static FTransform GetLocalTransform ( const [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) & TraceResult )


description: Get the type of the tracked object (if any) that effected this trace result.

code: static EARLineTraceChannels GetTraceChannel ( const [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) & TraceResult )


description: Get the real-world object (as observed by the Augmented Reality system) that was intersected by the line trace.

code: static [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * GetTrackedGeometry ( const [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) & TraceResult )


className: UARTraceResultLibrary

code: class UARTraceResultLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


className: UARTrackableNotifyComponent

description: Component used to listen to ar trackable object changes

code: class UARTrackableNotifyComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)

OnAddTrackedEnvProbe

type: FTrackableEnvPr...

description: Tracked environment capture probe events.

OnAddTrackedFace

type: FTrackableFaceD...

description: Tracked Face events.

OnAddTrackedGeometry

type: FTrackableDeleg...

description: Base class catch all.

OnAddTrackedImage

type: FTrackableImage...

description: Tracked Image events.

OnAddTrackedObject

type: FTrackableObjec...

description: Tracked object events.

OnAddTrackedPlane

type: FTrackablePlane...

description: Tracked plane events.

OnAddTrackedPoint

type: FTrackablePoint...

description: Tracked Point events.

OnRemoveTrackedEnvProbe

description: Event that happens when any ar environment capture probe item is removed from the scene

OnRemoveTrackedFace

description: Event that happens when any ar Face item is removed from the scene

OnRemoveTrackedGeometry

description: Event that happens when any trackable ar item is removed from the scene

OnRemoveTrackedImage

description: Event that happens when any ar Image item is removed from the scene

OnRemoveTrackedObject

description: Event that happens when any ar detected object item is removed from the scene

OnRemoveTrackedPlane

description: Event that happens when any ar plane item is removed from the scene

OnRemoveTrackedPoint

description: Event that happens when any ar Point item is removed from the scene

OnUpdateTrackedEnvProbe

description: Event that happens when any ar environment capture probe item is updated

OnUpdateTrackedFace

description: Event that happens when any ar Face item is updated

OnUpdateTrackedGeometry

description: Event that happens when any trackable ar item is updated

OnUpdateTrackedImage

description: Event that happens when any ar Image item is updated

OnUpdateTrackedObject

description: Event that happens when any ar detected object item is updated

OnUpdateTrackedPlane

description: Event that happens when any ar plane item is updated

OnUpdateTrackedPoint

description: Event that happens when any ar Point item is updated


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > GetARSystem() const


code: virtual void DebugDraw ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutlineColor, float OutlineThickness, float PersistForSeconds ) const


code: int32 GetLastUpdateFrameNumber() const


code: float GetLastUpdateTimestamp() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


code: void GetNetworkPayload ( [FARMeshUpdatePayload](API\Runtime\AugmentedReality\FARMeshUpdatePayload) & Payload )


code: bool HasSpatialMeshUsageFlag ( const EARSpatialMeshUsageFlags InFlag ) const


code: void InitializeNativeResource ( [IARRef](API\Runtime\AugmentedReality\IARRef) * InNativeResource )


code: void SetDebugName ( [FName](API\Runtime\Core\UObject\FName) InDebugName )


code: void SetLastUpdateTimestamp ( double InTimestamp )


code: void SetName ( const [FString](API\Runtime\Core\Containers\FString) & InName )


code: void SetObjectClassification ( EARObjectClassification InClassification )


code: void SetSpatialMeshUsageFlags ( const EARSpatialMeshUsageFlags InFlags )


code: void SetTrackingState ( EARTrackingState NewState )


code: void SetUnderlyingMesh ( [UMRMeshComponent](API\Runtime\MRMesh\UMRMeshComponent) * InMRMeshComponent )


code: void UpdateAlignmentTransform ( const FTransform & NewAlignmentTransform )


code: void UpdateSessionPayload ( [FARSessionPayload](API\Runtime\AugmentedReality\FARSessionPayload) & Payload ) const


code: void UpdateTrackedGeometry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform )


code: void UpdateTrackedGeometryNoMove ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp )


code: void UpdateTrackingState ( EARTrackingState NewTrackingState )


className: UARTrackedGeometry

code: class UARTrackedGeometry : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

LocalToAlignedTrackingTransform

type: FTransform

NativeResource

type: TUniquePtr<IAR...

description: A pointer to the native resource in the native AR system

ObjectClassification

type: EARObjectClassi...

description: What the scene understanding system thinks this object is

SpatialMeshUsageFlags

type: EARSpatialMeshU...

description: How the scene understanding system thinks this mesh should be displayed

TrackingState

type: EARTrackingStat...

UnderlyingMesh

type: TObjectPtr<UMR...

description: For AR systems that support arbitrary mesh geometry associated with a tracked point


code: virtual void DebugDraw ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutlineColor, float OutlineThickness, float PersistForSeconds ) const


description: DetectedImage

code: [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * GetDetectedImage() const


code: void GetNetworkPayload ( [FARImageUpdatePayload](API\Runtime\AugmentedReality\FARImageUpdatePayload) & Payload )


description: ARKit will return the physical size of the ARCandidate image.

code: FVector2D GetEstimateSize()


code: void UpdateTrackedGeometry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, FVector2D InEstimatedSize, [UARCandidateImage](API\Runtime\AugmentedReality\UARCandidateImage) * InDetectedImage )


className: UARTrackedImage

code: class UARTrackedImage : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)

DetectedImage

type: TObjectPtr<UAR...

description: The candidate image that was detected in the scene

EstimatedSize

description: The estimated image size that was detected in the scene


description: DetectedObject

code: [UARCandidateObject](API\Runtime\AugmentedReality\UARCandidateObject) * GetDetectedObject() const


code: void GetNetworkPayload ( [FARObjectUpdatePayload](API\Runtime\AugmentedReality\FARObjectUpdatePayload) & Payload )


code: void UpdateTrackedGeometry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, [UARCandidateObject](API\Runtime\AugmentedReality\UARCandidateObject) * InDetectedObject )


className: UARTrackedObject

code: class UARTrackedObject : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)


code: void GetNetworkPayload ( [FARPointUpdatePayload](API\Runtime\AugmentedReality\FARPointUpdatePayload) & Payload )


className: UARTrackedPoint

code: class UARTrackedPoint : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)


code: void GetNetworkPayload ( [FARPoseUpdatePayload](API\Runtime\AugmentedReality\FARPoseUpdatePayload) & Payload )


code: const [FARPose3D](API\Runtime\AugmentedReality\FARPose3D) & GetTrackedPoseData() const


code: void UpdateTrackedPose ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, const [FARPose3D](API\Runtime\AugmentedReality\FARPose3D) & InTrackedPose )


className: UARTrackedPose

code: class UARTrackedPose : public [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry)


code: void GetNetworkPayload ( [FARQRCodeUpdatePayload](API\Runtime\AugmentedReality\FARQRCodeUpdatePayload) & Payload )


code: void UpdateTrackedGeometry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > & InTrackingSystem, uint32 FrameNumber, double Timestamp, const FTransform & InLocalToTrackingTransform, const FTransform & InAlignmentTransform, FVector2D InEstimatedSize, const [FString](API\Runtime\Core\Containers\FString) & CodeData, int32 InVersion )


className: UARTrackedQRCode

code: class UARTrackedQRCode : public [UARTrackedImage](API\Runtime\AugmentedReality\UARTrackedImage)

QRCode

type: FString

description: The encoded information in the qr code

Version

description: The version of the qr code


description: Check Geo tracking availability at the user's current location.

code: static [UCheckGeoTrackingAvailabilityAsyncTaskBlueprintProxy](API\Runtime\AugmentedReality\UCheckGeoTrackingAvailabilityAsy-) * CheckGeoTrackingAvailability ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject )


className: UARTypesDummyClass

code: class UARTypesDummyClass : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Check Geo tracking availability at a specific Geo location.

code: static [UCheckGeoTrackingAvailabilityAsyncTaskBlueprintProxy](API\Runtime\AugmentedReality\UCheckGeoTrackingAvailabilityAsy-) * CheckGeoTrackingAvailabilityAtLocation ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, float Longitude, float Latitude )


className: FGeoTrackingAvailabilityDelegate

code: class FGeoTrackingAvailabilityDelegate


description: Blueprint async task to check Geo tracking availability.

OnFailed

type: FGeoTrackingAva...


className: FGetGeoLocationDelegate

code: class FGetGeoLocationDelegate


description: Convert a position in UE4 world space into a Geo location.

code: static [UGetGeoLocationAsyncTaskBlueprintProxy](API\Runtime\AugmentedReality\UGetGeoLocationAsyncTaskBlueprin-) * GetGeoLocationAtWorldPosition ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, const FVector & WorldPosition )


className: UGetGeoLocationAsyncTaskBlueprintProxy

description: Blueprint async task to convert Geo location.

code: class UGetGeoLocationAsyncTaskBlueprintProxy : public [UARBaseAsyncTaskBlueprintProxy](API\Runtime\AugmentedReality\UARBaseAsyncTaskBlueprintProxy)

type: FGetGeoLocation...


module: AutomationMessages

code: int32 Compare ( const [FAutomationScreenshotMetadata](API\Runtime\AutomationMessages\FAutomationScreenshotMetadata) & OtherMetadata ) const


code: FAutomationScreenshotMetadata()


code: FAutomationScreenshotMetadata ( const [FAutomationScreenshotData](API\Runtime\Core\Misc\FAutomationScreenshotData) & Data )


className: FAutomationScreenshotMetadata

code: struct FAutomationScreenshotMetadata

bHasComparisonRules

type: bool

description: Comparison Requests.

Id

type: FGuid

MaximumGlobalError

type: float

ResolutionQuality

description: Quality Levels.

Rhi

description: RHI Details.

Vendor

description: Hardware Details.


description: Default constructor.

code: FAutomationWorkerFindWorkers()


description: Creates and initializes a new instance.

code: FAutomationWorkerFindWorkers ( int32 InChangelist, const [FString](API\Runtime\Core\Containers\FString) & InGameName, const [FString](API\Runtime\Core\Containers\FString) & InProcessName, const [FGuid](API\Runtime\Core\Misc\FGuid) & InSessionId )


className: FAutomationWorkerFindWorkers

description: Worker discovery messages Implements a message that is published to find automation workers.

code: struct FAutomationWorkerFindWorkers

Changelist

description: Holds the change list number to find workers for.

GameName

description: The name of the game.

ProcessName

description: The name of the process.

SessionId

description: Holds the session identifier to find workers for.


description: Default constructor.

code: FAutomationWorkerFindWorkersResponse()


className: FAutomationWorkerFindWorkersResponse

description: Implements a message that is sent in response toFAutomationWorkerFindWorkers.

CPUModelName

description: Holds the name of the CPU model.

DeviceName

description: Holds the name of the device that the worker is running on.

GPUName

description: Holds the name of the GPU.

InstanceName

description: Holds the name of the worker's application instance.

ModelName

description: Holds the name of the device model.

OSVersionName

description: Holds the name of the operating system version.

Platform

description: Holds the name of the platform that the worker is running on.

RAMInGB

description: Holds the amount of RAM this device has in gigabytes.

RenderModeName

description: Holds the name of the current render mode.

RHIName

description: Holds the name of the current RHI.

description: Holds the worker's application session identifier.


code: FAutomationWorkerImageComparisonResults ( [FGuid](API\Runtime\Core\Misc\FGuid) InUniqueId, bool InIsNew, bool InAreSimilar, double InMaxLocalDifference, double InGlobalDifference, [FString](API\Runtime\Core\Containers\FString) InErrorMessage )


className: FAutomationWorkerImageComparisonResults

description: Implements a message that is sent in containing a screen shot run during performance test.

bNew

description: Was this a new image we've never seen before and have no ground truth for?

bSimilar

description: Were the images similar? If they're not you should log an error.

GlobalDifference

type: double

UniqueId

description: The unique id for the comparison.


className: FAutomationWorkerPerformanceDataRequest

description: Implements a message to request the performance data for this hardware.

DataPoints

type: TArray< double ...


description: Implements a message that responds to PerformanceDataRequest.


className: FAutomationWorkerPing

code: struct FAutomationWorkerPing


className: FAutomationWorkerPong

code: struct FAutomationWorkerPong


description: Default constructor.


description: Creates and initializes a new instance.

code: FAutomationWorkerRequestNextNetworkCommand ( uint32 InExecutionCount )


description: Default constructor.

code: FAutomationWorkerRequestTests()


description: Creates and initializes a new instance.

code: FAutomationWorkerRequestTests ( bool InDeveloperDirectoryIncluded, uint32 InRequestedTestFlags )


description: Returns list of all tests

Tests

type: TArray<FAutoma...


className: FAutomationWorkerRequestTests

description: Implements a message for requesting available automation tests from a worker.

code: struct FAutomationWorkerRequestTests

DeveloperDirectoryIncluded

description: Holds a flag indicating whether the developer directory should be included.

RequestedTestFlags

description: Holds a flag indicating which tests we'd like to request.


className: FAutomationWorkerResetTests

code: struct FAutomationWorkerResetTests


description: Default constructor.

code: FAutomationWorkerRunTests()


description: Creates and initializes a new instance.

code: FAutomationWorkerRunTests ( uint32 InExecutionCount, int32 InRoleIndex, [FString](API\Runtime\Core\Containers\FString) InTestName, [FString](API\Runtime\Core\Containers\FString) InBeautifiedTestName, [FString](API\Runtime\Core\Containers\FString) InFullTestPath, bool InSendAnalytics )


className: FAutomationWorkerScreenImage

code: struct FAutomationWorkerScreenImage

FrameTrace

type: TArray< uint8 >

description: The frame trace data.

Metadata

type: FAutomationScre...

ScreenImage

description: The screen shot data.

ScreenShotName

description: The screen shot name.


className: FAutomationWorkerRunTestsReply

description: Implements a message that is sent in response toFAutomationWorkerRunTests.

code: struct FAutomationWorkerRunTestsReply

State

type: EAutomationStat...


className: FAutomationWorkerRunTests

description: Implements a message to request the running of automation tests on a worker.

code: struct FAutomationWorkerRunTests

BeautifiedTestName

description: Holds the name of the test to run.

bSendAnalytics

description: If true, send results to analytics when complete

FullTestPath

description: Holds the full test path of the test to run.

TestName

description: Holds the name of the test to run.


description: Default constructor.

code: FAutomationWorkerSingleTestReply()


description: Creates and initializes a new instance.

code: FAutomationWorkerSingleTestReply ( const [FAutomationTestInfo](API\Runtime\Core\Misc\FAutomationTestInfo) & InTestInfo )


className: FAutomationWorkerSingleTestReply

description: A single test reply, used byFAutomationWorkerRequestTestsReplyComplete

code: struct FAutomationWorkerSingleTestReply


className: FAutomationWorkerStopTests

code: struct FAutomationWorkerStopTests


className: FAutomationWorkerTelemetryData

description: Implements a message that contains telemetry data.

code: struct FAutomationWorkerTelemetryData


code: FAutomationWorkerTelemetryItem()


code: FAutomationWorkerTelemetryItem ( const [FAutomationTelemetryData](API\Runtime\Core\Misc\FAutomationTelemetryData) & InItem )


code: FAutomationWorkerTelemetryItem ( [FString](API\Runtime\Core\Containers\FString) & InDataPoint, double InMeasurement, [FString](API\Runtime\Core\Containers\FString) & InContext )


className: FAutomationWorkerTelemetryItem

description: Implements a message that contains telemetry data point.

code: struct FAutomationWorkerTelemetryItem


className: FAutomationWorkerTestDataRequest

description: Implements a message that handles both storing and requesting ground truth data. for the first time this test is run, it might need to store things, or get things.

code: struct FAutomationWorkerTestDataRequest

DataType

description: The category of the data, this is purely to bucket and separate the ground truth data we store into different directories.


className: FAutomationWorkerTestDataResponse

description: Implements a message that responds to TestDataRequests.


className: FAutomationWorkerWorkerOffline

description: Implements a message that notifies automation controllers that a worker went off-line.

code: struct FAutomationWorkerWorkerOffline


description: Has conditional exclusion

module: AutomationTest

code: bool HasConditions() const


description: Return true if the entry is not specific

code: bool IsEmpty() const


description: Return the number of RHI types that needs to be matched for exclusion

code: int8 NumRHIType() const


description: Remove exclusion conditions, return true if a condition was removed

code: bool RemoveConditions ( const [FAutomationTestExcludelistEntry](API\Runtime\AutomationTest\FAutomationTestExcludelistEntry) & Entry )


description: Reset entry to be un-specific

code: void Reset()


description: Determine if exclusion entry is propagated based on test name - used for management in test automation window

code: void SetPropagation ( const [FString](API\Runtime\Core\Containers\FString) & ForTestName )


code: FAutomationTestExcludelistEntry()


code: FAutomationTestExcludelistEntry ( const [FAutomationTestExcludeOptions](API\Runtime\AutomationTest\FAutomationTestExcludeOptions) & Options )


className: FAutomationTestExcludelistEntry

code: struct FAutomationTestExcludelistEntry

bIsPropagated

description: Is the entry comes from propagation

FullTestName

description: Hold full test name/path

Map

type: FName

description: Hold the name of the target functional test map

Reason

description: Reason to why the test is excluded

RHIs

type: TSet<FName>

description: Option to target specific RHI. Empty array means it should be applied to all RHI

Test

description: Hold the name of the target test - full test name is require here unless for functional tests

Warn

description: Should the Reason be reported as a warning in the log


code: template<typename EnumType> static [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetAllRHIOptionNames()


className: FAutomationTestExcludeOptions

code: struct FAutomationTestExcludeOptions

Reason

description: Reason to why the test is excluded

RHIs

description: Options to target specific RHI. No option means it should be applied to all RHIs

Test

description: Name of the target test


code: void AddToExcludeTest ( const [FString](API\Runtime\Core\Containers\FString) & TestName, const [FAutomationTestExcludelistEntry](API\Runtime\AutomationTest\FAutomationTestExcludelistEntry) & ExcludelistEntry )


code: static [UAutomationTestExcludelist](API\Runtime\AutomationTest\UAutomationTestExcludelist) * Get()


code: [FAutomationTestExcludelistEntry](API\Runtime\AutomationTest\FAutomationTestExcludelistEntry) * GetExcludeTestEntry ( const [FString](API\Runtime\Core\Containers\FString) & TestName, const [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > & )


code: bool IsTestExcluded ( const [FString](API\Runtime\Core\Containers\FString) & TestName, const [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > &, [FName](API\Runtime\Core\UObject\FName) * OutReason, bool * OutWarn )


description: It is called automatically when CDO is created, usually you don't need to call LoadConfig manually.

code: const void LoadConfig()


description: Allows Non-PerObjectConfig classes, to override the ini section name used for loading config settings

code: virtual void OverrideConfigSection ( [FString](API\Runtime\Core\Containers\FString) & SectionName )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


code: void RemoveFromExcludeTest ( const [FString](API\Runtime\Core\Containers\FString) & TestName )


code: UAutomationTestExcludelist()


className: UAutomationTestExcludelist

code: class UAutomationTestExcludelist : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Deserializes from a comma-delimited string created with MakeCommaDeliminedString

module: AutomationWorker

code: void FromCommaDelimitedString ( const [FString](API\Runtime\Core\Containers\FString) & CommaDelimitedString )


description: Serializes this structure into a simple comma-delimited string


className: FAutomationPerformanceSnapshot

description: Wraps up useful performance capture data for automation tests. These are usually triggered at specific intervals along a timeline inside an automation-specific cinematic asset.

code: struct FAutomationPerformanceSnapshot


description: Ticks the automation worker module.

code: void Tick()


description: Start a test

code: IAutomationWorkerModule()


className: FStopTestEvent

description: Called whenever a test is stopped

code: typedef TBaseDelegate_ThreeParams< void, bool, [FString](API\Runtime\Core\Containers\FString), class [FAutomationTestExecutionInfo](API\Runtime\Core\Misc\FAutomationTestExecutionInfo) const & > FStopTestEvent


className: IAutomationWorkerModule

description: Interface for AutomationWorker modules.

code: class IAutomationWorkerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


module: AVEncoder

code: namespace AVEncoder { enum ECodecType { Undefined, H264, MPEG4, VP8, } }


code: namespace AVEncoder { enum EH264Profile { UNKNOWN, CONSTRAINED_BASELINE, BASELINE, MAIN, CONSTRAINED_HIGH, HIGH, } }


code: namespace AVEncoder { enum EVideoFrameFormat { Undefined, YUV420P, D3D11_R8G8B8A8_UNORM, D3D12_R8G8B8A8_UNORM, CUDA_R8G8B8A8_UNORM, VULKAN_R8G8B8A8_UNORM, } }


code: namespace AVEncoder { enum EPacketType { Audio, Video, Invalid, } }


code: namespace AVEncoder { [FString](API\Runtime\Core\Containers\FString) AVEncoder::ToString ( [EVideoFrameFormat](API\Runtime\AVEncoder\AVEncoder__EVideoFrameFormat) Format ) }


className: FAudioByteBuffer

description: One sample - one sample byte * NumberBytesPerSample One frame - one sample * NumberChannels One second - one frame * SampleRate The number of samples per seconds - one sample byte * NumberBytesPerSample * NumberChannels * SampleRate

code: typedef [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8_t > FAudioByteBuffer


className: FAudioChannelSample

description: There is the declaration of the single audio sample

code: typedef int16_t FAudioChannelSample


className: FAudioCodecConfig

code: struct FAudioCodecConfig


className: FAudioCodec

code: struct FAudioCodec

AudioCodecConfig

type: FAudioCodecConf...

OnAudioDecodeCallback

type: OnAudioDecodeCa...

OnAudioEncodeCallback

type: OnAudioEncodeCa...


className: FAudioConfig

code: struct FAudioConfig

Codec

type: FString


code: void Encode ( const [FAudioFrame](API\Runtime\AVEncoder\FAudioFrame) & Frame )


code: bool Initialize ( const [FAudioConfig](API\Runtime\AVEncoder\FAudioConfig) & Config )


code: void OnEncodedAudioFrame ( const [FMediaPacket](API\Runtime\AVEncoder\FMediaPacket) & Packet )


code: virtual void RegisterListener ( [IAudioEncoderListener](API\Runtime\AVEncoder\IAudioEncoderListener) & Listener )


description: Shutdown MUST be called before destruction

code: void Shutdown()


code: virtual void UnregisterListener ( [IAudioEncoderListener](API\Runtime\AVEncoder\IAudioEncoderListener) & Listener )


className: FAudioEncoder

code: class FAudioEncoder


code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FAudioEncoder](API\Runtime\AVEncoder\FAudioEncoder) > CreateEncoder ( const [FString](API\Runtime\Core\Containers\FString) & Codec )


className: Factories

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FAudioEncoderFactory](API\Runtime\AVEncoder\FAudioEncoderFactory) * > Factories;


code: static [FAudioEncoderFactory](API\Runtime\AVEncoder\FAudioEncoderFactory) * FindFactory ( const [FString](API\Runtime\Core\Containers\FString) & Codec )


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FAudioEncoderFactory](API\Runtime\AVEncoder\FAudioEncoderFactory) * > GetAllFactories()


code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetSupportedCodecs() const


code: static void RegisterFactory ( [FAudioEncoderFactory](API\Runtime\AVEncoder\FAudioEncoderFactory) & Factory )


code: static void UnregisterFactory ( [FAudioEncoderFactory](API\Runtime\AVEncoder\FAudioEncoderFactory) & Factory )


code: virtual ~FAudioEncoderFactory()


className: FAudioEncoderFactory

code: class FAudioEncoderFactory


className: FAudioFrame

code: struct FAudioFrame

Duration

type: FTimespan


className: FAudioMuteInfo

code: struct FAudioMuteInfo

Reason

type: TOptional<EAud...


className: FAudioSampleBuffer

description: One frame - one sample * NumberChannels One second - one frame * SampleRate The number of samples per seconds - one sample byte * NumberBytesPerSample * NumberChannels * SampleRate

code: struct FAudioSampleBuffer

AudioSamples

type: TArrayView< con...

description: The sequence of audio samples

AudioStreamFormat

type: FAudioStreamFor...

description: The format of audio samples


className: FAudioStreamFormat

description: Describes the data format of the audio stream

code: struct FAudioStreamFormat

NumberChannels

description: The number of channels in the stream

SampleRate

description: The number of samples per seconds


code: static [FCodecPacket](API\Runtime\AVEncoder\FCodecPacket) Create ( const uint8 * InData, uint32 InDataSize )


className: FCodecPacket

description: No constructors are accessible with public or protected access.

code: class FCodecPacket

Data

type: TSharedPtr< uin...

IsKeyFrame

type: bool

Timings

type: FTimings


className: FTimings

description: Encoding/Decoding latency

code: struct FTimings


className: kDefaultStunServerUrl

code: static kDefaultStunServerUrl = TEXT("stun:stun.l.google.com:19302");


code: static [FData](API\Runtime\AVEncoder\FConfiguration\FData) & Get()


className: FConfiguration

code: struct FConfiguration


className: FData

code: struct FData

CustomAudioCodec

type: TOptional<FAud...


className: FFrameBufferOutPlaneDesc

description: Output buffer plane description.

code: struct FFrameBufferOutPlaneDesc

ByteOffsetBetweenPixels

description: Offset in bytes between two pixels.

ByteOffsetBetweenRows

description: Offset in bytes between the same column in the next row.

ByteOffsetToFirstPixel

description: Offset in bytes from the allocated buffer start address to the first pixel of this plane.

BytesPerPixel

description: Bytes per pixel.

Height

description: Height of the allocated buffer plane in pixels, including necessary padding.

Width

description: Width of the allocated buffer plane in pixels, including necessary padding.


className: FIncomingAudioChannelInfo

description: Information which is used to initialize the incoming audio channel

code: struct FIncomingAudioChannelInfo


className: FMediaPacket

code: struct FMediaPacket

type: union AVEncoder...

Data

type: TArray< uint8 >

Type

type: EPacketType


code: FMediaPacket ( [EPacketType](API\Runtime\AVEncoder\AVEncoder__EPacketType) TypeIn )


className: FOutgoingAudioChannelInfo

description: Information which is used to initialize the outgoing audio channel

code: struct FOutgoingAudioChannelInfo

bIsMuted

description: Initial muted state of the audio channel


code: EFrameBufferAllocReturn AllocateOutputFrameBuffer ( [FVideoDecoderAllocFrameBufferResult](API\Runtime\AVEncoder\FVideoDecoderAllocFrameBufferRes-) * OutBuffer, const [FVideoDecoderAllocFrameBufferParams](API\Runtime\AVEncoder\FVideoDecoderAllocFrameBufferPar-) * InAllocParams )


className: FVideoConfig

code: struct FVideoConfig


code: virtual void ClearOnDecodedFrame()


code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(void *, void **)> CreateDecoderAllocationInterfaceCallback


code: [EDecodeResult](API\Runtime\AVEncoder\FVideoDecoder\EDecodeResult) Decode ( const [FVideoDecoderInput](API\Runtime\AVEncoder\FVideoDecoderInput) * InInput )


code: bool CreateDecoderAllocationInterface()


className: FPlatformDecoderAllocInterface

code: struct FPlatformDecoderAllocInterface

AllocMethods

type: FVideoDecoderMe...

ClientData

type: void *


className: FInit

code: struct FInit

CreateDecoderAllocationInterface

type: CreateDecoderAl...

ReleaseDecoderAllocationInterface

type: ReleaseDecoderA...


code: void * GetAllocationInterfaceMethods()


className: EDecodeResult

code: enum EDecodeResult { Success, Failure, }


code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(void *, void **)> ReleaseDecoderAllocationInterfaceCallback


code: virtual void SetOnDecodedFrame ( [OnDecodedFrameCallback](API\Runtime\AVEncoder\FVideoDecoder\OnDecodedFrameCallback) InCallback )


description: Shuts the decoder down AND destroys it. Do not store a pointer to this decoder in a smart pointer!

code: void Shutdown()


description: Setup

code: bool Setup ( const [FInit](API\Runtime\AVEncoder\FVideoDecoder\FInit) & InInit )


className: OnDecodedFrameCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FVideoDecoderOutput](API\Runtime\AVEncoder\FVideoDecoderOutput) *)> OnDecodedFrameCallback


className: FVideoDecoder

code: class FVideoDecoder

OnDecodedFrame

type: OnDecodedFrameC...

PlatformDecoderAllocInterface

type: FPlatformDecode...


className: FVideoDecoderAllocFrameBufferParams

description: Video frame buffer allocation parameters.

AllocSize

description: Number of bytes to allocate with the specified alignment.

ExtraCustomParameters

type: void **

description: Extra custom parameters (platform specific)

FrameBufferType

type: EFrameBufferTyp...

description: Type of output frame buffer to allocate

Width

description: Dimensions to allocate raw buffer for.


className: FVideoDecoderAllocFrameBufferResult

description: Result structure to be filled in by the application.

AllocatedBuffer

description: The buffer the application has allocated.

AllocatedPlaneDesc

type: FFrameBufferOut...

AllocatedPlanesNum

description: Information of the allocated buffer planes, if applicable (depending on frame buffer type to allocate).

AllocatedSize

description: The actual buffer size the application has allocated.

CallbackValue

description: Buffer callback user value (a 'this' pointer to something within the application) for the retain and release callbacks.

ReleaseCallback

type: FReleaseFrameBu...

description: Callback within the application to release the allocated buffer.

RetainCallback

type: FRetainFrameBuf...

description: Callback within the application to retain the allocated buffer.


className: bDebugDontRegisterDefaultCodecs

code: static bool bDebugDontRegisterDefaultCodecs = false;


description: Decoder creation create a decoder instance. If not nullptr it must be destroyed through invoking its Shutdown() method!

code: [FVideoDecoder](API\Runtime\AVEncoder\FVideoDecoder) * Create ( uint32 InID, const FVideoDecoder::FInit & InInit )


className: CreateDecoderCallback

description: The callback type used to create a registered decoder

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [FVideoDecoder](API\Runtime\AVEncoder\FVideoDecoder) *()> CreateDecoderCallback


code: static [FVideoDecoderFactory](API\Runtime\AVEncoder\FVideoDecoderFactory) & Get()


description: Get a list of registered decoders

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FVideoDecoderInfo](API\Runtime\AVEncoder\FVideoDecoderInfo) > & GetAvailable() const


code: bool GetInfo ( uint32 InID, [FVideoDecoderInfo](API\Runtime\AVEncoder\FVideoDecoderInfo) & OutInfo ) const


className: NextID

code: static [FThreadSafeCounter](API\Runtime\Core\HAL\FThreadSafeCounter) NextID = 1;


description: Register a decoder so that it can be iterated and created

code: void Register ( const [FVideoDecoderInfo](API\Runtime\AVEncoder\FVideoDecoderInfo) & InInfo, const [CreateDecoderCallback](API\Runtime\AVEncoder\FVideoDecoderFactory\CreateDecoderCallback) & InCreateDecoder )


className: FVideoDecoderFactory

description: No destructors are accessible with public or protected access.

code: class FVideoDecoderFactory


className: FVideoDecoderInfo

code: struct FVideoDecoderInfo

CodecType

type: ECodecType


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoDecoderInput](API\Runtime\AVEncoder\FVideoDecoderInput) > Create ( const [FInputData](API\Runtime\AVEncoder\FVideoDecoderInput\FInputData) & InInputData )


className: FInputData

code: struct FInputData

bIsComplete

type: bool

EncodedData

type: const void *...


code: [FVideoDecoderInput](API\Runtime\AVEncoder\FVideoDecoderInput) & operator= ( const [FVideoDecoderInput](API\Runtime\AVEncoder\FVideoDecoderInput) & )


code: FVideoDecoderInput ( const [FVideoDecoderInput](API\Runtime\AVEncoder\FVideoDecoderInput) & )


className: FVideoDecoderInput

code: class FVideoDecoderInput


code: const [FVideoDecoderAllocFrameBufferResult](API\Runtime\AVEncoder\FVideoDecoderAllocFrameBufferRes-) * GetAllocatedBuffer() const


code: FVideoDecoderOutput ( const [FVideoDecoderOutput](API\Runtime\AVEncoder\FVideoDecoderOutput) & )


code: [FVideoDecoderOutput](API\Runtime\AVEncoder\FVideoDecoderOutput) & operator= ( const [FVideoDecoderOutput](API\Runtime\AVEncoder\FVideoDecoderOutput) & )


className: FVideoDecoderOutput

code: class FVideoDecoderOutput


code: virtual bool AddLayer ( [FLayerConfig](API\Runtime\AVEncoder\FVideoEncoder\FLayerConfig) const & config )


code: virtual [FLayer](API\Runtime\AVEncoder\FVideoEncoder\FLayer) * CreateLayer ( uint32 layerIdx, [FLayerConfig](API\Runtime\AVEncoder\FVideoEncoder\FLayerConfig) const & config )


code: virtual void DestroyLayer ( [FLayer](API\Runtime\AVEncoder\FVideoEncoder\FLayer) * layer )


code: virtual void Encode ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) > frame, [FEncodeOptions](API\Runtime\AVEncoder\FVideoEncoder\FEncodeOptions) const & options )


className: FEncodeOptions

code: struct FEncodeOptions

OnFrameEncoded

type: OnFrameEncodedC...


code: FLayerConfig const & GetConfig&40;&41; const


code: void UpdateConfig &40; FLayerConfig const & config &41;


code: FLayer &40; FLayerConfig const & layerConfig &41;


className: FLayer

code: class FLayer

ConfigMutex

type: FCriticalSectio...

CurrentConfig

type: FLayerConfig


code: bool operator&61;&61; &40; FLayerConfig const & other &41; const


code: bool operator&33;&61; &40; FLayerConfig const & other &41; const


className: FLayerConfig

code: struct FLayerConfig

MultipassMode

type: MultipassMode

RateControlMode

type: RateControlMode


code: [FLayerConfig](API\Runtime\AVEncoder\FVideoEncoder\FLayerConfig) GetLayerConfig ( uint32 layerIdx ) const


code: virtual uint32 GetMaxLayers() const


className: MultipassMode

code: enum MultipassMode { UNKNOWN, DISABLED, QUARTER, FULL, }


code: enum H264Profile { AUTO, CONSTRAINED_BASELINE, BASELINE, MAIN, CONSTRAINED_HIGH, HIGH, HIGH444, STEREO, SVC_TEMPORAL_SCALABILITY, PROGRESSIVE_HIGH, }


className: OnEncodedPacketCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(uint32, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) >, const [FCodecPacket](API\Runtime\AVEncoder\FCodecPacket) &)> OnEncodedPacketCallback


className: OnFrameEncodedCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) >)> OnFrameEncodedCallback


className: RateControlMode

code: enum RateControlMode { UNKNOWN, CONSTQP, VBR, CBR, }


code: void SetOnEncodedPacket ( [OnEncodedPacketCallback](API\Runtime\AVEncoder\FVideoEncoder\OnEncodedPacketCallback) callback )


code: virtual bool Setup ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) > input, [FLayerConfig](API\Runtime\AVEncoder\FVideoEncoder\FLayerConfig) const & config )


code: void UpdateLayerConfig ( uint32 layerIdx, [FLayerConfig](API\Runtime\AVEncoder\FVideoEncoder\FLayerConfig) const & config )


code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FVideoEncoder](API\Runtime\AVEncoder\FVideoEncoder) > Create ( uint32 InID, const FVideoEncoder::FLayerConfig & config )


className: FVideoEncoder

code: class FVideoEncoder

Layers

type: TArray<FLayer...

OnEncodedPacket

type: OnEncodedPacket...


code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FVideoEncoder](API\Runtime\AVEncoder\FVideoEncoder) > Create ( uint32 InID, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) > InInput, const FVideoEncoder::FLayerConfig & config )


className: CreateEncoderCallback

description: The callback type used to create a registered encoder

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FVideoEncoder](API\Runtime\AVEncoder\FVideoEncoder) >()> CreateEncoderCallback


code: static [FVideoEncoderFactory](API\Runtime\AVEncoder\FVideoEncoderFactory) & Get()


code: bool HasEncoderForCodec ( [ECodecType](API\Runtime\AVEncoder\AVEncoder__ECodecType) CodecType ) const


code: bool GetInfo ( uint32 InID, [FVideoEncoderInfo](API\Runtime\AVEncoder\FVideoEncoderInfo) & OutInfo ) const


code: static [FThreadSafeCounter](API\Runtime\Core\HAL\FThreadSafeCounter) NextID = 4711;


description: Register an encoder so that it can be iterated and created

code: void Register ( const [FVideoEncoderInfo](API\Runtime\AVEncoder\FVideoEncoderInfo) & InInfo, const [CreateEncoderCallback](API\Runtime\AVEncoder\FVideoEncoderFactory\CreateEncoderCallback) & InCreateEncoder )


description: Get a list of registered encoders

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FVideoEncoderInfo](API\Runtime\AVEncoder\FVideoEncoderInfo) > & GetAvailable() const


className: FVideoEncoderFactory

code: class FVideoEncoderFactory


className: FVideoEncoderInfo

code: struct FVideoEncoderInfo

SupportedInputFormats

type: TArray<EVideoF...


description: Create a user managed buffer

code: [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) * CreateBuffer ( [OnFrameReleasedCallback](API\Runtime\AVEncoder\FVideoEncoderInput\OnFrameReleasedCallback) InOnFrameReleased )


description: Create input for an encoder that encodes a CUarray

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) > CreateForCUDA ( void * InApplicationCudaContext, bool IsResizable )


description: Construct video encoder input based on expected input frame format

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) > CreateDummy ( bool isResizable )


description: Create input for an encoder that encodes a D3D11 texture

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) > CreateForD3D11 ( void * InApplicationD3D11Device, bool IsResizable, bool IsShared )


description: Create input for an encoder that encodes a D3D12 texture

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) > CreateForD3D12 ( void * InApplicationD3D12Device, bool IsResizable, bool IsShared )


description: Create input for an encoder that encodes a VkImage

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) > CreateForVulkan ( void * InApplicationVulkanData, bool IsResizable )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) > CreateForYUV420P ( uint32 InWidth, uint32 InHeight, bool isResizable )


description: Destroy user managed buffer

code: void DestroyBuffer ( [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) * Buffer )


description: Destroy/release any frames that are not currently in use

code: void Flush()


description: Get a list of supported video encoders

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FVideoEncoderInfo](API\Runtime\AVEncoder\FVideoEncoderInfo) > & GetAvailableEncoders()


code: CUcontext GetCUDAEncoderContext() const


description: Obtain a video frame that can be used as a buffer for input to a video encoder


className: OnFrameReleasedCallback

description: New packet callback prototype void(uint32 LayerIndex, const FCodecPacket& Packet)

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) *)> OnFrameReleasedCallback


code: [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) & operator= ( const [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) & )


description: Release (free) an input frame and make it available for future use

code: void ReleaseInputFrame ( [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) * InFrame )


description: Properties

code: virtual void SetMaxNumBuffers ( uint32 InMaxNumBuffers )


code: FVideoEncoderInput ( const [FVideoEncoderInput](API\Runtime\AVEncoder\FVideoEncoderInput) & )


className: FVideoEncoderInput

code: class FVideoEncoderInput

FrameFormat

type: EVideoFrameForm...


description: Clone frame - this will create a copy that references the original until destroyed.

code: const [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) * Clone ( [FCloneDestroyedCallback](API\Runtime\AVEncoder\FVideoEncoderInputFrame\FCloneDestroyedCallback) InCloneDestroyedCallback ) const


className: EUnderlyingRHI

code: enum EUnderlyingRHI { Undefined, D3D11, D3D12, Vulkan, }


className: FCloneDestroyedCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) *)> FCloneDestroyedCallback


className: FCUDA

description: CUDA

code: struct FCUDA

EncoderDevice

type: CUcontext

EncoderTexture

type: CUarray

SharedHandle

type: void *

UnderlyingRHI

type: EUnderlyingRHI


className: FReleaseCUDATextureCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(CUarray)> FReleaseCUDATextureCallback


code: const [FCUDA](API\Runtime\AVEncoder\FVideoEncoderInputFrame\FCUDA) & GetCUDA() const


description: Current format of frame


code: const [FYUV420P](API\Runtime\AVEncoder\FVideoEncoderInputFrame\FYUV420P) & GetYUV420P() const


description: Obtain (increase reference count) of this input frame.

code: const [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) * Obtain() const


description: Release (decrease reference count) of this input frame.

code: void Release() const


description: Height of frame buffer

code: void SetHeight ( uint32 InHeight )


code: void SetTexture ( CUarray InTexture, [EUnderlyingRHI](API\Runtime\AVEncoder\FVideoEncoderInputFrame\EUnderlyingRHI) UnderlyingRHI, void * SharedHandle, [FReleaseCUDATextureCallback](API\Runtime\AVEncoder\FVideoEncoderInputFrame\FReleaseCUDATextureCallback) InOnReleaseTexture )


code: void SetTimestampRTP ( int64 timestampRTP )


code: void SetTimestampUs ( int64 timestampUs )


description: Width of frame buffer

code: void SetWidth ( uint32 InWidth )


code: void SetYUV420P ( const uint8 * InDataY, const uint8 * InDataU, const uint8 * InDataV, uint32 InStrideY, uint32 InStrideU, uint32 InStrideV )


code: FVideoEncoderInputFrame ( const [FVideoEncoderInputFrame](API\Runtime\AVEncoder\FVideoEncoderInputFrame) & CloneFrom )


code: virtual ~FVideoEncoderInputFrame()


code: void OnEncodedAudioFrame ( const [FMediaPacket](API\Runtime\AVEncoder\FMediaPacket) & Packet )


className: FVideoEncoderInputFrame

description: TODO this should go elsewhere and be made cross platform.

code: class FVideoEncoderInputFrame

CUDA

type: FCUDA

NumReferences

type: FThreadSafeCoun...

OnReleaseCUDATexture

type: FReleaseCUDATex...

OnTextureEncode

type: TFunction< void...


className: IAudioEncoderListener

code: class IAudioEncoderListener


description: librtc

code: namespace LibRtc { enum EAudioMuteReason { Unsupported, Manual, NotListening, AdminDisabled, } }


className: OnAudioDecodeCallback

description: The undecoded audio byte buffer is not guaranteed to be available after callback finishes. The pointer of the decoded audio sample buffer should be valid until the next decode call will happen.

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FAudioByteBuffer](API\Runtime\AVEncoder\FAudioByteBuffer) &AudioBytes, const [FAudioSampleBuffer](API\Runtime\AVEncoder\FAudioSampleBuffer) &)> OnAudioDecodeCallback


className: OnAudioEncodeCallback

description: The unencoded audio sample buffer is not guaranteed to be available after callback finishes. The pointer of the encoded audio byte buffer should be valid until the next encode call will happen.

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FAudioSampleBuffer](API\Runtime\AVEncoder\FAudioSampleBuffer) &, const [FAudioByteBuffer](API\Runtime\AVEncoder\FAudioByteBuffer) &AudioBytes)> OnAudioEncodeCallback


description: Create a new avi writer from the specified options

module: AVIWriter

code: static [FAVIWriter](API\Runtime\AVIWriter\FAVIWriter) * CreateInstance ( const [FAVIWriterOptions](API\Runtime\AVIWriter\FAVIWriterOptions) & InOptions )


code: void DropFrames ( int32 NumFramesToDrop )


description: Access captured frame data. Safe to be called from any thread.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) > GetFrameData ( uint32 WaitTimeMs ) const


description: Retrieve the number of oustanding frames we have not processed yet

code: int32 GetNumOutstandingFrames() const


code: void Update ( double FrameTimeSeconds, [TArray](API\Runtime\Core\Containers\TArray)< [FColor](API\Runtime\Core\Math\FColor) > FrameData )


description: Protected constructor to avoid abuse.

code: FAVIWriter ( const [FAVIWriterOptions](API\Runtime\AVIWriter\FAVIWriterOptions) & InOptions )


description: Public destruction

code: virtual ~FAVIWriter()


className: FAVIWriter

description: Class responsible for writing frames out to an AVI file

code: class FAVIWriter

bCapturing

type: FThreadSafeBool

description: Whether we are capturing or not

CapturedFrames

type: TUniquePtr<FCa...

description: Container that manages frames that we have already captured

FrameNumber

description: The current frame number

Options

type: FAVIWriterOptio...

description: Creation options


className: FAVIWriterOptions

description: Creation options for the AVI writer

code: struct FAVIWriterOptions

bSynchronizeFrames

type: bool

description: When true, the game thread will block until captured frames have been processed by the avi writer

CaptureFramerateDenominator

description: The denominator of the captured video, ie (30/1) will capture at 30 frames per second.

CaptureFramerateNumerator

description: The numerator of the captured video, ie (30/1) will capture at 30 frames per second.

CodecName

type: FString

description: Optional codec to use for compression

CompressionQuality

type: TOptional< floa...

description: Optional compression quality, as a value between 0 and 1

OutputFilename

description: Output filename


code: [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) & operator= ( [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) && In )


code: FCapturedFrame ( double InStartTimeSeconds, double InEndTimeSeconds, uint32 InFrameIndex, [TArray](API\Runtime\Core\Containers\TArray)< [FColor](API\Runtime\Core\Math\FColor) > InFrameData )


code: FCapturedFrame ( [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) && In )


className: FCapturedFrame

description: Data structure representing a captured frame

code: struct FCapturedFrame

EndTimeSeconds

type: double

description: The End time of this frame

FrameData

type: TArray<FColor...

description: The frame data itself (empty for a dropped frame)

FrameIndex

description: The frame index of this frame in the stream

FrameProcessedEvent

type: FEvent*

description: Triggered when the frame has been processed

StartTimeSeconds

description: The start time of this frame


description: Add a captured frame to this container. Only to be called from the owner tasread.

code: void Add ( [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) Frame )


description: Read frames from this container (potentially from a thread)

code: [TArray](API\Runtime\Core\Containers\TArray)< [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) > ReadFrames ( uint32 WaitTimeMs )


description: Construct from a directory to place archives in, and a maximum number of frames we can hold in

code: FCapturedFrames ( const [FString](API\Runtime\Core\Containers\FString) & InArchiveDirectory, int32 InMaxInMemoryFrames )


className: FCapturedFrames

description: Container for managing captured frames. Temporarily archives frames to the file system when capture rate drops.

code: struct FCapturedFrames


description: Create the compression format dependent decoder object.

module: BinkAudioDecoder

code: virtual bool CreateDecoder()


description: Decode the input compressed frame data into output PCMData buffer.

code: virtual [FDecodeResult](API\Runtime\Engine\FDecodeResult) Decode ( const uint8 * CompressedData, const int32 CompressedDataSize, uint8 * OutPCMData, const int32 OutputPCMDataSize )


description: Return the size of the current compression frame

code: virtual int32 GetFrameSize()