UVirtualCameraClipsMetaData

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

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVirtualCameraClipsMetaData

References

Module

VirtualCamera

Header

/Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/VirtualCameraClipsMetaData.h

Include

#include "VirtualCameraClipsMetaData.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UVirtualCameraClipsMetaData :
    public UObject,
    public ILevelSequenceMetaData

Remarks

Clips meta-data that is stored on ULevelSequence assets that are recorded through the virtual camera. Meta-data is retrieved through ULevelSequence::FindMetaData<UVirtualCameraClipsMetaData>()

Constructors

Name Description

Public function

UVirtualCameraClipsMetaData

(
    const FObjectInitializer& ObjInit
)

Functions

Name Description

Public function UFunction BlueprintCallable, Category

FFrameRate

 

GetDisplayRate()

Public function Const UFunction BlueprintCallable, Category

float

 

GetFocalLength()

Public function Const UFunction BlueprintCallable, Category

int

 

GetFrameCountEnd()

Public function Const UFunction BlueprintCallable, Category

int

 

GetFrameCountStart()

Public function Const UFunction BlueprintCallable, Category

bool

 

GetIsACineCameraRecording()

Public function UFunction BlueprintCallable, Category

int

 

GetLengthInFrames()

Public function Const UFunction BlueprintCallable, Category

FString

 

GetRecordedLevelName()

Public function Const UFunction BlueprintCallable, Category

bool

 

GetSelected()

Public function UFunction BlueprintCallable, Category

void

 

SetDisplayRate

(
    FFrameRate InDisplayRate
)

Set the DisplayRate of the clip used for AssetData calculations.

Public function UFunction BlueprintCallable, Category

void

 

SetFocalLength

(
    float InFocalLength
)

Set the focal length associated with this clip.

Public function UFunction BlueprintCallable, Category

void

 

SetFrameCountEnd

(
    int InFrame
)

Set the final frame of the clip used for calculating duration.

Public function UFunction BlueprintCallable, Category

void

 

SetFrameCountStart

(
    int InFrame
)

Set the initial frame of the clip used for calculating duration.

Public function UFunction BlueprintCallable, Category

void

 

SetIsACineCameraRecording

(
    bool bInIsACineCameraRecording
)

Set if the clip was recorded by a CineCameraActor

Public function UFunction BlueprintCallable, Category

void

 

SetLengthInFrames

(
    int InLength
)

Set the length in frames of the clip used for AssetData calculations.

Public function UFunction BlueprintCallable, Category

void

 

SetRecordedLevelName

(
    FString InLevelName
)

Set the name of the level that the clip was recorded in.

Public function UFunction BlueprintCallable, Category

void

 

SetSelected

(
    bool bInSelected
)

Set if this clip is 'selected'

Overridden from ILevelSequenceMetaData

Name Description

Public function Virtual Const

void

 

ExtendAssetRegistryTagMetaData

(
    TMap< FName, FAssetRegistryTagMetad...
)

Called from ULevelSequence::GetAssetRegistryTagMetadata in order to extend its default set of tag meta-data to include any from this meta-data object.

Public function Virtual Const

void

 

ExtendAssetRegistryTags

(
    TArray< FAssetRegistryTag >& OutTa...
)

Extend the default ULevelSequence asset registry tags

Constants

Name

Description

AssetRegistryTag_bIsACineCameraRecording

The asset registry tag that contains whether the clip was recorded with a CineCamera for this meta-data

AssetRegistryTag_bIsSelected

The asset registry tag that contains if the selected state for this meta-data

AssetRegistryTag_DisplayRate

The asset registry tag that contains the FrameCountEnd out for this meta-data

AssetRegistryTag_FocalLength

The asset registry tag that contains the focal length for this meta-data

AssetRegistryTag_FrameCountEnd

The asset registry tag that contains the FrameCountEnd out for this meta-data

AssetRegistryTag_FrameCountStart

The asset registry tag that contains the FrameCountStart in for this meta-data

AssetRegistryTag_LengthInFrames

The asset registry tag that contains the LengthInFrames out for this meta-data

AssetRegistryTag_RecordedLevelName

The asset registry tag that contains the recorded level name 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