1. Epic GamesDeveloper
  3. UMetaHumanCaptureSourceSync

UMetaHumanCaptureSourceSync

API > API/Plugins > API/Plugins/MetaHumanCaptureSource

   
Name UMetaHumanCaptureSourceSync
Type class
Header File /Engine/Plugins/MetaHuman/MetaHumanAnimator/Source/MetaHumanCaptureSource/Public/MetaHumanCaptureSourceSync.h
Include Path #include "MetaHumanCaptureSourceSync.h"

Syntax

UCLASS (MinimalAPI, BlueprintType,  
       Meta=(Deprecated="5.7", DeprecationMessage="MetaHumanAnimator/MetaHumanCaptureSource is deprecated. This functionality is now available in the CaptureManager/CaptureManagerDevices module"))  
class UMetaHumanCaptureSourceSync : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  MetaHumanCaptureSourceSync.h  
  MetaHumanCaptureSourceSync.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UMetaHumanCaptureSourceSync()

   MetaHumanCaptureSourceSync.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CaptureSourceType PRAGMA_DISABLE_DEPRECATION_WARNINGS EMetaHumanCaptureSourceType   MetaHumanCaptureSourceSync.h
  • EditAnywhere
  • Category="Capture Source"
CopyImagesToProject bool   MetaHumanCaptureSourceSync.h
  • EditAnywhere
  • Category="Capture Source"
  • Meta=(EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::HMCArchives", EditConditionHides)
DeviceControlPort uint16   MetaHumanCaptureSourceSync.h
  • EditAnywhere
  • Category="Capture Source"
  • Meta=(EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceConnection", EditConditionHides)
DeviceIpAddress PRAGMA_DISABLE_DEPRECATION_WARNINGSFDeviceAddress   MetaHumanCaptureSourceSync.h
  • EditAnywhere
  • DisplayName="Device Address"
  • Category="Capture Source"
  • Meta=(EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceConnection", EditConditionHides)
meta PRAGMA_DISABLE_DEPRECATION_WARNINGS   MetaHumanCaptureSourceSync.h
  • EditAnywhere
  • Category="Capture Source"
  • Meta=(ToolTip="Precision of the calculated depth data. Full precision is more accurate, but requires more disk space to store.", EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::HMCArchives || CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceArchivesRGB || CaptureSourceType == EMetaHumanCaptureSourceType::MonoArchives", EditConditionHides)
meta     MetaHumanCaptureSourceSync.h
  • EditAnywhere
  • Category="Capture Source"
  • Meta=(ToolTip="The minimum cm from the camera expected for valid depth information.\n Depth information closer than this will be ignored to help filter out noise.", ClampMin="0.0", ClampMax="200.0", UIMin="0.0", UIMax="200.0", EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::HMCArchives", EditConditionHides)
ShouldCompressDepthFiles bool TODO: Expose this parameter once uncompressed EXR's are supported. MetaHumanCaptureSourceSync.h  
StoragePath FDirectoryPath   MetaHumanCaptureSourceSync.h
  • EditAnywhere
  • Category="Capture Source"
  • Meta=(EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceArchives || CaptureSourceType == EMetaHumanCaptureSourceType::HMCArchives || CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceArchivesRGB || CaptureSourceType == EMetaHumanCaptureSourceType::MonoArchives", EditConditionHides)

Protected

Name Type Remarks Include Path Unreal Specifiers
Ingester PRAGMA_DISABLE_DEPRECATION_WARNINGSTUniquePtr< UE::MetaHuman::FIngester >   MetaHumanCaptureSourceSync.h  
MetaHumanCaptureSource TObjectPtr< UMetaHumanCaptureSource > Do not expose this property to the editor or blueprints, it is only for garbage collection purposes. MetaHumanCaptureSourceSync.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanCancel()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

void CancelProcessing ( const TArray< int32 >& InTakeIdList
)

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

bool CanIngestTakes()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

bool CanStartup()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

int32 GetNumTakes()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

TArray< int32 > GetTakeIds()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

PRAGMA_DISABLE_DEPRECATION_WARNINGSbool GetTakeInfo ( int32 InTakeId,
FMetaHumanTakeInfo& OutTakeInfo
) const

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

TArray< FMetaHumanTake > GetTakes ( const TArray< int32 >& InTakeIdList
)

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

bool IsCancelling()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

bool IsProcessing()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FMetaHumanTakeInfo > Refresh()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

void SetTargetPath ( const FString& InTargetIngestDirectory,
const FString& InTargetFolderAssetPath
)

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

void Shutdown()

   MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

void Startup()

 Startup the MetaHuman|Footage Ingest API. Get information on the available takes based on the type of this Capture Source. MetaHumanCaptureSourceSync.h
  • BlueprintCallable
  • Category="MetaHuman|Footage Ingest API"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

   MetaHumanCaptureSourceSync.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DeviceAddress_DEPRECATED FString   MetaHumanCaptureSourceSync.h
  • Meta=(DeprecatedProperty, DeprecationMessage="This property has changed its type")
ExportListeningPort_DEPRECATED uint16   MetaHumanCaptureSourceSync.h
  • Meta=(DeprecatedProperty, DeprecationMessage="This property isn't used anymore as the port is being provided automatically by the OS")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page