Navigation
API > API/Plugins > API/Plugins/TakesCore
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.
| Name | UTakeRecorderSource |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Takes/Source/TakesCore/Public/TakeRecorderSource.h |
| Include Path | #include "TakeRecorderSource.h" |
Syntax
UCLASS (MinimalAPI, Abstract, Blueprintable, BlueprintType)
class UTakeRecorderSource : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UTakeRecorderSource
Derived Classes
UTakeRecorderSource derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UTakeRecorderSource
(
const FObjectInitializer& ObjInit |
TakeRecorderSource.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnabled | bool | True if this source is cued for recording or not | TakeRecorderSource.h |
|
| TakeNumber | int32 | TakeRecorderSource.h |
|
|
| TrackTint | FColor | TakeRecorderSource.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual 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. | TakeRecorderSource.h | |
virtual bool CanAddSource
(
UTakeRecorderSources* InSources |
Whether this source can be added (some sources should only exist once) | TakeRecorderSource.h | |
virtual void FinalizeRecording () |
This is called on all sources after post recording. | TakeRecorderSource.h | |
virtual TArray< UObject * > GetAdditionalSettingsObjects () |
This allows a Source to return an array of dynamically spawned settings objects for that source. | TakeRecorderSource.h | |
FText GetAddSourceDisplayText() |
Get the text to display on the add source menu for this source | TakeRecorderSource.h | |
FText GetCategoryText() |
Get the optional category text to display on the Take Recorder source list for this source | TakeRecorderSource.h | |
FText GetDescriptionText() |
A very brief text summary of what is going to be recorded for this source | TakeRecorderSource.h | |
const FSlateBrush * GetDisplayIcon() |
Get the icon to display on the Take Recorder source list for this source | TakeRecorderSource.h | |
FText GetDisplayText() |
Get the text to display on the Take Recorder source list for this source | TakeRecorderSource.h | |
virtual 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 | TakeRecorderSource.h | |
virtual FString GetSubsceneTrackName
(
ULevelSequence* InSequence |
When recorded to a Subscenes track, what should the subscene track name of the Section be? | TakeRecorderSource.h | |
virtual void Initialize () |
Gives the Source object an opportunity to perform additional initialization outside of the constructor. | TakeRecorderSource.h | |
virtual bool IsValid () |
If the source is Valid and ready to be recorded. | TakeRecorderSource.h | |
virtual TArray< UTakeRecorderSource * > PostRecording
(
ULevelSequence* InSequence, |
This is called on all sources after recording is stopped. | TakeRecorderSource.h | |
virtual TArray< UTakeRecorderSource * > PreRecording
(
ULevelSequence* InSequence, |
This is called on all sources before recording is started. | TakeRecorderSource.h | |
virtual void StartRecording
(
const FTimecode& InSectionStartTimecode, |
This is called when the UTakeRecorderSources starts a recording, after all sources have had PreRecording called on them. | TakeRecorderSource.h | |
virtual void StopRecording
(
ULevelSequence* InSequence |
This is called when the UTakeRecorderSources stops recording. | TakeRecorderSource.h | |
virtual bool SupportsSubscenes() |
Supports recording into subscenes | TakeRecorderSource.h | |
virtual bool SupportsTakeNumber() |
Whether or the source can be referenced via take number | TakeRecorderSource.h | |
virtual void TickRecording
(
const FQualifiedFrameTime& CurrentSequenceTime |
This is called each frame and allows the source to record any new information from the current frame. | TakeRecorderSource.h |