Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > TakesCore > UTakeRecorderSource

Light Theme

Dark Theme

UTakeRecorderSource

Base class for all sources that can be recorded with the Take Recorder.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UTakeRecorderSource

References

Module	TakesCore
Header	/Engine/Plugins/VirtualProduction/Takes/Source/TakesCore/Public/TakeRecorderSource.h
Include	#include "TakeRecorderSource.h"

Syntax

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

Remarks

Base class for all sources that can be recorded with the Take Recorder. Custom recording sources can be created by inheriting from this class and implementing the Start/Tick/Stop recording functions. The level sequence that the recording is being placed into is provided so that the take can decide to store the data directly in the resulting level sequence, but sources are not limited to generating data in the specified Level Sequence. The source should be registered with the ITakeRecorderModule for it to show up in the Take Recorder UI. If creating a recording setup via code you can just add instances of your Source to the UTakeRecorderSources instance you're using to record and skip registering them with the module.

Sources should reset their state before recording as there is not a guarantee that the object will be newly created for each recording.

Variables

	Name	Description
bool	bEnabled	True if this source is cued for recording or not
int32	TakeNumber
FTimecode	TimecodeSource	Timecode source when recording is started via StartRecording.
FColor	TrackTint

Constructors

	Name	Description
	UTakeRecorderSource ( const FObjectInitializer& ObjInit )

Functions

	Name	Description
void	AddContentsToFolder ( UMovieSceneFolder* InFolder )	If you are not recording into a sub-sequence then this will be called after PreRecording is called and will specify the folder that this Source should add itself to.
bool	CanAddSource ( UTakeRecorderSources* InSource... )	Whether this source can be added (some sources should only exist once)
TArray< UObj...	GetAdditionalSettingsObjects()	This allows a Source to return an array of dynamically spawned settings objects for that source.
FText	GetCategoryText()	Get the optional category text to display on the Take Recorder source list for this source
FText	GetDescriptionText()	A very brief text summary of what is going to be recorded for this source
const FSlate...	GetDisplayIcon()	Get the icon to display on the Take Recorder source list for this source
FText	GetDisplayText()	Get the text to display on the Take Recorder source list for this source
FString	GetSubsceneAssetName ( ULevelSequence* InSequence )	When recorded to a Subscenes track, what should the sub level sequence asset name be? By default, returns the name of the track
FString	GetSubsceneTrackName ( ULevelSequence* InSequence )	When recorded to a Subscenes track, what should the subscene track name of the Section be?
bool	IsValid()	If the source is Valid and ready to be recorded.
TArray< UTak...	PostRecording ( ULevelSequence* InSequence, ULevelSequence* InMasterSequen... )	This is called on all sources after recording is stopped.
TArray< UTak...	PreRecording ( ULevelSequence* InSequence, FMovieSceneSequenceID InSequenceID, ULevelSequence* InMasterSequen..., FManifestSerializer* InManifes... )	This is called on all sources before recording is started.
void	StartRecording ( const FTimecode& InSectionStartTim..., const FFrameNumber& InSectionFirst..., ULevelSequence* InSequence )	This is called when the UTakeRecorderSources starts a recording, after all sources have had PreRecording called on them.
void	StopRecording ( ULevelSequence* InSequence )	This is called when the UTakeRecorderSources stops recording.
bool	SupportsSubscenes()	Supports recording into subscenes
bool	SupportsTakeNumber()	Whether or the source can be referenced via take number
void	TickRecording ( const FQualifiedFrameTime& Current... )	This is called each frame and allows the source to record any new information from the current frame.

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

Take our survey

Dismiss