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.

API > API/Plugins > API/Plugins/TakesCore

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

   
Name UTakeMetaData
Type class
Header File /Engine/Plugins/VirtualProduction/Takes/Source/TakesCore/Public/TakeMetaData.h
Include Path #include "TakeMetaData.h"

Syntax

UCLASS (MinimalAPI, Config=EditorSettings, PerObjectConfig, BlueprintType)  
class UTakeMetaData :  
    public UObject ,  
    public IMovieSceneMetaDataInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UTakeMetaData ( const FObjectInitializer& ObjInit
)

   TakeMetaData.h  

Typedefs

Name Type Remarks Include Path
FOnTakeNumberChanged TMulticastDelegate_TwoParams< void, int32 TakeNumber, UTakeMetaData *TakeMetaData >   TakeMetaData.h
FOnTakeSlateChanged TMulticastDelegate_TwoParams< void, const FString &SlateName, UTakeMetaData *TakeMetaData >   TakeMetaData.h

Constants

Name Type Remarks Include Path
AssetRegistryTag_Description const FName The asset registry tag that contains the user-description for this meta-data TakeMetaData.h
AssetRegistryTag_LevelPath const FName The asset registry tag that contains the level-path for this meta-data TakeMetaData.h
AssetRegistryTag_Slate const FName The asset registry tag that contains the slate for this meta-data TakeMetaData.h
AssetRegistryTag_TakeNumber const FName The asset registry tag that contains the take number for this meta-data TakeMetaData.h
AssetRegistryTag_TimecodeIn const FName The asset registry tag that contains the timecode in for this meta-data TakeMetaData.h
AssetRegistryTag_TimecodeOut const FName The asset registry tag that contains the timecode out for this meta-data TakeMetaData.h
AssetRegistryTag_Timestamp const FName The asset registry tag that contains the timestamp for this meta-data TakeMetaData.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bFrameRateFromTimecode bool Whether or not we get or frame rate from Timecode, default to true TakeMetaData.h  
bIsLocked bool Whether the take is locked TakeMetaData.h  
Description FString A user-provided description for the take TakeMetaData.h
  • Config
Duration FFrameTime The desired duration for the take TakeMetaData.h
  • Config
FrameRate FFrameRate The frame rate the take was recorded at. We default to 60fps. TakeMetaData.h  
LevelOrigin TSoftObjectPtr< ULevel > The level map used to create this recording TakeMetaData.h  
PresetOrigin TSoftObjectPtr< UTakePreset > The preset that the take was based off TakeMetaData.h
  • Config
Slate FString The user-provided slate information for the take TakeMetaData.h
  • Config
TakeNumber int32 The take number TakeMetaData.h  
TimecodeIn FTimecode The timecode at the start of recording TakeMetaData.h  
TimecodeOut FTimecode The timecode at the end of recording TakeMetaData.h  
Timestamp FDateTime The timestamp at which the take was initiated TakeMetaData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ExtendAssetRegistryTagMetaData ( TMap< FName, FAssetRegistryTagMetadata >& OutMetadata
) const

 Extend the default ULevelSequence asset registry tag meta-data TakeMetaData.h  

virtual void ExtendAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   TakeMetaData.h  

FString GenerateAssetPath ( const FString& PathFormatString,
UTakeRecorderNamingTokensContext* InContext
) const

 Generate the desired asset path for this take meta-data TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

FString GetDescription()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

FFrameTime GetDuration()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

FFrameRate GetFrameRate()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

bool GetFrameRateFromTimecode()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

ULevel * GetLevelOrigin()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

FString GetLevelPath()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

UTakePreset * GetPresetOrigin()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

const FString & GetSlate()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

int32 GetTakeNumber()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

FTimecode GetTimecodeIn()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

FTimecode GetTimecodeOut()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

FDateTime GetTimestamp()

   TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

bool IsLocked()

 Check whether this take is locked TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void Lock()

 Lock this take, causing it to become read-only TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

FNamingTokenResultData ProcessTokens ( const FText& InText,
UTakeRecorderNamingTokensContext* InContext
) const

 Process TakeRecorder Naming Tokens. TakeMetaData.h  

bool Recorded()

 Check if this take was recorded (as opposed to being setup for recording) TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetDescription ( FString InDescription
)

 Set this take's user-provided description : Only valid for takes that have not been locked TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetDuration ( FFrameTime InDuration
)

 Set this take's duration : Only valid for takes that have not been locked TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetFrameRate ( FFrameRate InFrameRate
)

 Set this take's frame-rate : Only valid for takes that have not been locked TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetFrameRateFromTimecode ( bool InFromTimecode
)

 Set if we get frame rate from time code TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetLevelOrigin ( ULevel* InLevelOrigin
)

 Set the map used to create this recording TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetPresetOrigin ( UTakePreset* InPresetOrigin
)

 Set the preset on which the take is based : Only valid for takes that have not been locked TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetSlate ( FString InSlate,
bool bEmitChanged
)

 Set the slate for this take and reset its take number to 1 TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetTakeNumber ( int32 InTakeNumber,
bool bEmitChanged
)

 Set this take's take number. TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetTimecodeIn ( FTimecode InTimecodeIn
)

 Set this take's timecode in : Only valid for takes that have not been locked TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetTimecodeOut ( FTimecode InTimecodeOut
)

 Set this take's timecode out : Only valid for takes that have not been locked TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

void SetTimestamp ( FDateTime InTimestamp
)

 Set this take's timestamp : Only valid for takes that have not been locked TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

bool TryGenerateRootAssetPath ( const FString& PathFormatString,
FString& OutGeneratedAssetPath,
FText* OutErrorMessage,
UTakeRecorderNamingTokensContext* InContext
) const

 Attempt to generate the root asset path. TakeMetaData.h  

void Unlock()

 Unlock this take if it is read-only, allowing it to be modified once again TakeMetaData.h
  • BlueprintCallable
  • Category="Take"

Overridden from IMovieSceneMetaDataInterface

Name Remarks Include Path Unreal Specifiers

virtual void ExtendAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

 Extend the default ULevelSequence asset registry tags TakeMetaData.h  

Static

Name Remarks Include Path Unreal Specifiers

static UTakeMetaData * CreateFromDefaults ( UObject* Outer,
FName Name
)

 Create a new meta-data object from the project defaults TakeMetaData.h  

static UTakeMetaData * GetConfigInstance()

 Access the global config instance that houses default settings for take meta data for a given project TakeMetaData.h  

static UTakeMetaData * GetMostRecentMetaData()

 Retrieve the most recent or active take metadata. TakeMetaData.h  

static FOnTakeNumberChanged & OnTakeNumberChanged()

 Multicast delegate emitted when take number is changed. TakeMetaData.h  

static FOnTakeSlateChanged & OnTakeSlateChanged()

 Multicast delegate emitted when the slate is changed. TakeMetaData.h  

static void SetMostRecentMetaData ( UTakeMetaData* InMetaData
)

 Update the most recent accessed metadata. TakeMetaData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page