1. Epic GamesDeveloper
  3. UTakeRecorderSources

UTakeRecorderSources

A list of sources to record for any given take.

API > API/Plugins > API/Plugins/TakesCore

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

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

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable)  
class UTakeRecorderSources : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UTakeRecorderSources ( const FObjectInitializer& ObjInit
)

   TakeRecorderSources.h  

Typedefs

Name Type Remarks Include Path
FOnSourceAdded TMulticastDelegate_OneParam< void, UTakeRecorderSource *Source >   TakeRecorderSources.h
FOnSourceRemoved TMulticastDelegate_OneParam< void, UTakeRecorderSource *Source >   TakeRecorderSources.h
FOnSourcesChanged TMulticastDelegate_NoParams< void > A list of handlers to invoke when the sources list changes TakeRecorderSources.h

Constants

Name Type Remarks Include Path
RecordedTimes TArray< TPair< FQualifiedFrameTime, FQualifiedFrameTime > > Array of pairs - key time and the corresponding timecode TakeRecorderSources.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveSubSections TArray< TObjectPtr< class UMovieSceneSubSection > > List of sub-sections that we're recording into. TakeRecorderSources.h
  • Transient
bIsRecording bool Are we currently in a recording pass and should be ticking our Sources? TakeRecorderSources.h  
CachedFrameTime FQualifiedFrameTime The last frame time during tick recording TakeRecorderSources.h  
CachedLevelSequence ULevelSequence * Level Sequence that we are recording into. TakeRecorderSources.h  
CachedManifestSerializer FManifestSerializer * Manifest Serializer that we are recording into. TakeRecorderSources.h  
CreatedManifestSerializers TArray< TSharedPtr< FManifestSerializer > > Array of Allocated Serializers created for each sub sequence. TakeRecorderSources.h  
OnSourcesChangedEvent FOnSourcesChanged   TakeRecorderSources.h  
PreRecordedSources TArray< UTakeRecorderSource * > All sources after PreRecord TakeRecorderSources.h  
Settings FTakeRecorderSourcesSettings Sources settings TakeRecorderSources.h  
Sources TArray< TObjectPtr< UTakeRecorderSource > > The array of all sources contained within this list TakeRecorderSources.h
  • Instanced
SourcesSerialNumber uint32 Non-serialized serial number that is used for updating UI when the source list changes TakeRecorderSources.h  
SourceSubSequenceMap TMap< TObjectPtr< UTakeRecorderSource >, TObjectPtr< ULevelSequence > > Maps each source to the level sequence that was created for that source, or to the root source if a subsequence was not created. TakeRecorderSources.h
  • Transient
TargetLevelSequenceDisplayRate FFrameRate What Display Rate is the target level sequence we're recording into? Used to convert seconds into FrameNumbers. TakeRecorderSources.h  
TargetLevelSequenceTickResolution FFrameRate What Tick Resolution is the target level sequence we're recording into? Used to convert seconds into FrameNumbers. TakeRecorderSources.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

SourceType * AddSource ()

 Add a new source to this source list of the templated type TakeRecorderSources.h  
Add a new source to this source list of the templated type TakeRecorderSources.h
  • BlueprintCallable
  • Category="Take Recorder"
  • Meta=(DeterminesOutputType="InSourceType")

FFrameTime AdvanceTime ( const FQualifiedFrameTime& CurrentFrameTime,
float DeltaTime
)

 Moves time forward by given DeltaTime TakeRecorderSources.h  

FDelegateHandle BindSourcesChanged ( const FSimpleDelegate& Handler
)

 Bind a callback for when this source list changes TakeRecorderSources.h  

FQualifiedFrameTime GetCachedFrameTime()

   TakeRecorderSources.h  
Sources settings from the user and project parameters TakeRecorderSources.h  

TArrayView< UTakeRecorderSource *const > GetSources()

 Access all the sources stored in this list TakeRecorderSources.h  
Retrieves a copy of the list of sources that are being recorded. TakeRecorderSources.h
  • BlueprintPure
  • DisplayName="Get Sources (Copy)"
  • Category="Take Recorder"
Retrieve the serial number that is incremented when a source is added or removed from this list. TakeRecorderSources.h  

void PreRecording ( ULevelSequence* InSequence,
const FQualifiedFrameTime& InCurrentFrameTime,
FManifestSerializer* InManifestSerializer
)

 Pre recording pass TakeRecorderSources.h  

void RemoveSource ( UTakeRecorderSource* InSource
)

 Remove the specified source from this list TakeRecorderSources.h
  • BlueprintCallable
  • Category="Take Recorder"

void SetCachedAssets ( ULevelSequence* InSequence,
FManifestSerializer* InManifestSerializer
)

 Cache assets needed for sequencer. TakeRecorderSources.h  

void SetSettings ( FTakeRecorderSourcesSettings& InSettings
)

   TakeRecorderSources.h  

void StartRecording ( ULevelSequence* InSequence,
const FQualifiedFrameTime& InCurrentFrameTime,
FManifestSerializer* InManifestSerializer
)

 Start recording pass TakeRecorderSources.h  

void StartRecordingSource ( TArray< UTakeRecorderSource* > InSources,
const FQualifiedFrameTime& CurrentFrameTime
)

 Calls the recording initialization flows on each of the specified sources. TakeRecorderSources.h
  • BlueprintCallable
  • Category="Take Recorder"

void StopRecording ( ULevelSequence* InSequence,
const bool bCancelled
)

 Stop recording pass TakeRecorderSources.h  

FFrameTime TickRecording ( ULevelSequence* InSequence,
const FQualifiedFrameTime& CurrentFrameTime,
float DeltaTime
)

 Tick recording pass TakeRecorderSources.h  

void UnbindSourcesChanged ( FDelegateHandle Handle
)

 Unbind a previously bound handler for when this source list changes TakeRecorderSources.h  

Static

Name Remarks Include Path Unreal Specifiers

static ULevelSequence * CreateSubSequenceForSource ( ULevelSequence* InRootSequence,
const FString& SubSequenceTrackName,
const FString& SubSequenceAssetName,
const FTakeRecorderSourcesSettings& InSettings
)

 Static functions used by other parts of the take system Creates a sub-sequence asset for the specified sub sequence name based on the given root sequence. TakeRecorderSources.h  

static FOnSourceAdded & OnSourceAdded()

 Multicast delegate for when any source is added. TakeRecorderSources.h  

static FOnSourceRemoved & OnSourceRemoved()

 Multicast delegate for when any source is removed. TakeRecorderSources.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page