UTakeMetaData

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

TakesCore

Header

/Engine/Plugins/VirtualProduction/Takes/Source/TakesCore/Public/TakeMetaData.h

Include

#include "TakeMetaData.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=EditorSettings, PerObjectConfig, BlueprintType)
class UTakeMetaData :
    public UObject,
    public ILevelSequenceMetaData

Remarks

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

Constructors

Name Description

Public function

UTakeMetaData

(
    const FObjectInitializer& ObjInit
)

Functions

Name Description

Public function Static

UTakeMetaDat...

 

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

UTakeMetaDat...

 

GetConfigInstance()

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

Public function Const UFunction BlueprintCallable, Category

FString

 

GetDescription()

Public function Const UFunction BlueprintCallable, Category

FFrameTime

 

GetDuration()

Public function UFunction BlueprintCallable, Category

FFrameRate

 

GetFrameRate()

Public function Const UFunction BlueprintCallable, Category

bool

 

GetFrameRateFromTimecode()

Public function Const UFunction BlueprintCallable, Category

ULevel *

 

GetLevelOrigin()

Public function Const UFunction BlueprintCallable, Category

FString

 

GetLevelPath()

Public function Const UFunction BlueprintCallable, Category

UTakePreset ...

 

GetPresetOrigin()

Public function Const UFunction BlueprintCallable, Category

const FStrin...

 

GetSlate()

Public function Const UFunction BlueprintCallable, Category

int32

 

GetTakeNumber()

Public function Const UFunction BlueprintCallable, Category

FTimecode

 

GetTimecodeIn()

Public function Const UFunction BlueprintCallable, Category

FTimecode

 

GetTimecodeOut()

Public function Const UFunction BlueprintCallable, Category

FDateTime

 

GetTimestamp()

Public function Const UFunction BlueprintCallable, Category

bool

 

IsLocked()

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

 

Recorded()

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 @note Only valid for takes that have not been locked

Public function UFunction BlueprintCallable, Category

void

 

SetDuration

(
    FFrameTime InDuration
)

Set this take's duration @note Only valid for takes that have not been locked

Public function UFunction BlueprintCallable, Category

void

 

SetFrameRate

(
    FFrameRate InFrameRate
)

Set this take's frame-rate @note 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 @note 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. Take numbers are always clamped to be >= 1.

Public function UFunction BlueprintCallable, Category

void

 

SetTimecodeIn

(
    FTimecode InTimecodeIn
)

Set this take's timecode in @note Only valid for takes that have not been locked

Public function UFunction BlueprintCallable, Category

void

 

SetTimecodeOut

(
    FTimecode InTimecodeOut
)

Set this take's timecode out @note Only valid for takes that have not been locked

Public function UFunction BlueprintCallable, Category

void

 

SetTimestamp

(
    FDateTime InTimestamp
)

Set this take's timestamp @note 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 ILevelSequenceMetaData

Name Description

Public function Virtual Const

void

 

ExtendAssetRegistryTagMetaData

(
    TMap< FName, FAssetRegistryTagMetad...
)

Extend the default ULevelSequence asset registry tag meta-data

Public function Virtual Const

void

 

ExtendAssetRegistryTags

(
    TArray< FAssetRegistryTag >& OutTa...
)

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
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss