1. Epic GamesDeveloper
  3. UTakeMetaData

UTakeMetaData

Take meta-data that is stored on [ULevelSequence](API\Runtime\LevelSequence\ULevelSequence) assets that are recorded through the Take Recorder.

Unreal Engine C++ API Reference > Plugins > TakesCore

Inheritance Hierarchy

References

   
Module TakesCore
Header /Engine/Plugins/VirtualProduction/Takes/Source/TakesCore/Public/TakeMetaData.h
Include #include "TakeMetaData.h"

Syntax

UCLASS&40;Config&61;EditorSettings, PerObjectConfig, BlueprintType&41;  
class UTakeMetaData :  
    public UObject,  
    public IMovieSceneMetaDataInterface

Remarks

Take meta-data that is stored on ULevelSequence assets that are recorded through the Take Recorder. Meta-data is retrieved through ULevelSequence::FindMetaData()

Constructors

  Type Name Description
Public function  

UTakeMetaData ( const FObjectInitializer& ObjInit
)

  

Functions

  Type Name Description
Public function Static UTakeMetaData *

CreateFromDefaults ( UObject* Outer,
FName Name
)

 Create a new meta-data object from the project defaults
Public function Const UFunction BlueprintCallable, Category FString

GenerateAssetPath ( const FString& PathFormatString
)

 Generate the desired asset path for this take meta-data
Public function Static UTakeMetaData * Access the global config instance that houses default settings for take meta data for a given project
Public function Const UFunction BlueprintCallable, Category FString  
Public function Const UFunction BlueprintCallable, Category FFrameTime  
Public function UFunction BlueprintCallable, Category FFrameRate  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category ULevel *  
Public function Const UFunction BlueprintCallable, Category FString  
Public function Const UFunction BlueprintCallable, Category UTakePreset *  
Public function Const UFunction BlueprintCallable, Category const FString &  
Public function Const UFunction BlueprintCallable, Category int32  
Public function Const UFunction BlueprintCallable, Category FTimecode  
Public function Const UFunction BlueprintCallable, Category FTimecode  
Public function Const UFunction BlueprintCallable, Category FDateTime  
Public function Const UFunction BlueprintCallable, Category bool Check whether this take is locked
Public function UFunction BlueprintCallable, Category void

Lock ()

 Lock this take, causing it to become read-only
Public function Const UFunction BlueprintCallable, Category bool Check if this take was recorded (as opposed to being setup for recording)
Public function UFunction BlueprintCallable, Category void

SetDescription ( FString InDescription
)

 Set this take's user-provided description : Only valid for takes that have not been locked
Public function UFunction BlueprintCallable, Category void

SetDuration ( FFrameTime InDuration
)

 Set this take's duration : Only valid for takes that have not been locked
Public function UFunction BlueprintCallable, Category void

SetFrameRate ( FFrameRate InFrameRate
)

 Set this take's frame-rate : Only valid for takes that have not been locked
Public function UFunction BlueprintCallable, Category void

SetFrameRateFromTimecode ( bool InFromTimecode
)

 Set if we get frame rate from time code
Public function UFunction BlueprintCallable, Category void

SetLevelOrigin ( ULevel* InLevelOrigin
)

 Set the map used to create this recording
Public function UFunction BlueprintCallable, Category void

SetPresetOrigin ( UTakePreset* InPresetOrigin
)

 Set the preset on which the take is based : Only valid for takes that have not been locked
Public function UFunction BlueprintCallable, Category void

SetSlate ( FString InSlate,
bool bEmitChanged
)

 Set the slate for this take and reset its take number to 1
Public function UFunction BlueprintCallable, Category void

SetTakeNumber ( int32 InTakeNumber,
bool bEmitChanged
)

 Set this take's take number.
Public function UFunction BlueprintCallable, Category void

SetTimecodeIn ( FTimecode InTimecodeIn
)

 Set this take's timecode in : Only valid for takes that have not been locked
Public function UFunction BlueprintCallable, Category void

SetTimecodeOut ( FTimecode InTimecodeOut
)

 Set this take's timecode out : Only valid for takes that have not been locked
Public function UFunction BlueprintCallable, Category void

SetTimestamp ( FDateTime InTimestamp
)

 Set this take's timestamp : Only valid for takes that have not been locked
Public function UFunction BlueprintCallable, Category void

Unlock ()

 Unlock this take if it is read-only, allowing it to be modified once again

Overridden from IMovieSceneMetaDataInterface

  Type Name Description
Public function Virtual Const void Extend the default ULevelSequence asset registry tag meta-data
Public function Virtual Const void Extend the default ULevelSequence asset registry tags

Constants

Name Description
AssetRegistryTag_Description The asset registry tag that contains the user-description for this meta-data
AssetRegistryTag_LevelPath The asset registry tag that contains the level-path for this meta-data
AssetRegistryTag_Slate The asset registry tag that contains the slate for this meta-data
AssetRegistryTag_TakeNumber The asset registry tag that contains the take number for this meta-data
AssetRegistryTag_TimecodeIn The asset registry tag that contains the timecode in for this meta-data
AssetRegistryTag_TimecodeOut The asset registry tag that contains the timecode out for this meta-data
AssetRegistryTag_Timestamp The asset registry tag that contains the timestamp for this meta-data

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page