UTakeRecorderSources

A list of sources to record for any given take.

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UTakeRecorderSources

References

Module

TakesCore

Header

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

Include

#include "TakeRecorderSources.h"

Syntax

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

Remarks

A list of sources to record for any given take. Stored as meta-data on ULevelSequence through ULevelSequence::FindMetaData<UTakeRecorderSources>

Constructors

Name Description

Public function

UTakeRecorderSources

(
    const FObjectInitializer& ObjInit
)

Functions

Name Description

Public function UFunction BlueprintCallable, Category, Meta

UTakeRecorde...

 

AddSource

(
    TSubclassOf< UTakeRecorderSource > ...
)

Add a new source to this source list of the templated type

Public function

SourceType &...

 

AddSource()

Add a new source to this source list of the templated type

Public function

FFrameTime

 

AdvanceTime

(
    float DeltaTime
)

Moves time forward by given DeltaTime

Public function

FDelegateHan...

 

BindSourcesChanged

(
    const FSimpleDelegate& Handler
)

Bind a callback for when this source list changes

Public function Static

ULevelSequen...

 

CreateSubSequenceForSource

(
    ULevelSequence* InMasterSequen...,
    const FString& SubSequenceTrackNam...,
    const FString& SubSequenceAssetNam...
)

Static functions used by other parts of the take systemCreates a sub-sequence asset for the specified sub sequence name based on the given master sequence.

Public function Const

FTakeRecorde...

 

GetSettings()

Sources settings from the user and project parameters

Public function Const

TArrayView< ...

 

GetSources()

Access all the sources stored in this list

Public function Const UFunction BlueprintPure, Category displayname

TArray< UTak...

 

GetSourcesCopy()

Retrieves a copy of the list of sources that are being recorded.

Public function Const

uint32

 

GetSourcesSerialNumber()

Retrieve the serial number that is incremented when a source is added or removed from this list.

Public function

void

 

PreRecording

(
    ULevelSequence* InSequence,
    FManifestSerializer* InManifes...
)

Pre recording pass

Public function UFunction BlueprintCallable, Category

void

 

RemoveSource

(
    UTakeRecorderSource* InSource
)

Remove the specified source from this list

Public function

void

 

SetCachedAssets

(
    ULevelSequence* InSequence,
    FManifestSerializer* InManifes...
)

Cache assets needed for sequencer.

Public function

void

 

SetSettings

(
    FTakeRecorderSourcesSettings& InSe...
)

Public function

void

 

StartRecording

(
    ULevelSequence* InSequence,
    const FTimecode& InTimecodeSource,
    FManifestSerializer* InManifes...
)

Start recording pass

Public function UFunction BlueprintCallable, Category

void

 

StartRecordingSource

(
    TArray< UTakeRecorderSource* >...,
    const FTimecode& CurrentTiimecode
)

Calls the recording initialization flows on each of the specified sources.

Public function

void

 

StopRecording

(
    ULevelSequence* InSequence
)

Stop recording pass

Public function

FFrameTime

 

TickRecording

(
    ULevelSequence* InSequence,
    const FTimecode& InTimecodeSource,
    float DeltaTime
)

Tick recording pass

Public function

void

 

UnbindSourcesChanged

(
    FDelegateHandle Handle
)

Unbind a previously bound handler for when this source list changes

Typedefs

Name

Description

FOnSourcesChanged

A list of handlers to invoke when the sources list changes

Constants

Name

Description

RecordedTimes

Array of pairs - key time and the corresponding timecode

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss