UMetaHumanCaptureSource | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/MetaHumanCaptureSource

Capture Source Asset

An asset representing a physical device or an archive that can be used to import the footage data into Unreal Editor.

A footage of live performance, in combination with a Skeletal Mesh obtained through MetaHuman Identity asset toolkit. Used in MetaHuman Performance asset to generate an Animation Sequence by automatically tracking facial features of the actor in the performance


Name	UMetaHumanCaptureSource
Type	class
Header File	/Engine/Plugins/MetaHuman/MetaHumanAnimator/Source/MetaHumanCaptureSource/Public/MetaHumanCaptureSource.h
Include Path	#include "MetaHumanCaptureSource.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 UMetaHumanCaptureSource : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UMetaHumanCaptureSource

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
CaptureSourceType	PRAGMA_DISABLE_DEPRECATION_WARNINGS EMetaHumanCaptureSourceType		MetaHumanCaptureSource.h	EditAnywhere Category="Capture Source"
CopyImagesToProject	bool		MetaHumanCaptureSource.h	EditAnywhere Category="Capture Source" Meta=(EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::HMCArchives \|\| CaptureSourceType == EMetaHumanCaptureSourceType::MonoArchives", EditConditionHides)
DeviceControlPort	uint16		MetaHumanCaptureSource.h	EditAnywhere Category="Capture Source" Meta=(EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceConnection", EditConditionHides)
DeviceIpAddress	PRAGMA_DISABLE_DEPRECATION_WARNINGSFDeviceAddress		MetaHumanCaptureSource.h	EditAnywhere DisplayName="Device Address" Category="Capture Source" Meta=(EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceConnection", EditConditionHides)
meta			MetaHumanCaptureSource.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)
meta	PRAGMA_DISABLE_DEPRECATION_WARNINGS		MetaHumanCaptureSource.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::MonoArchives \|\| CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceArchivesRGB ", EditConditionHides)
ShouldCompressDepthFiles	bool	TODO: Expose this parameter once uncompressed EXR's are supported.	MetaHumanCaptureSource.h
StoragePath	FDirectoryPath		MetaHumanCaptureSource.h	EditAnywhere Category="Capture Source" Meta=(EditCondition="CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceArchives \|\| CaptureSourceType == EMetaHumanCaptureSourceType::HMCArchives \|\| CaptureSourceType == EMetaHumanCaptureSourceType::LiveLinkFaceArchivesRGB \|\| CaptureSourceType == EMetaHumanCaptureSourceType::MonoArchives", EditConditionHides)

Functions

Deprecated Variables

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