Navigation
API > API/Plugins > API/Plugins/TakeRecorder
UTakeRecorderSubsystem Subsystem for Take Recorder. SetTargetSequence() needs to be called at least once prior to use. This will perform additional initialization and register the subsystem as tickable currently required to cache level metadata.
| Name | UTakeRecorderSubsystem |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorder/Public/Recorder/TakeRecorderSubsystem.h |
| Include Path | #include "Recorder/TakeRecorderSubsystem.h" |
Syntax
UCLASS ()
class UTakeRecorderSubsystem :
public UEngineSubsystem ,
public ITakeRecorderSubsystemInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEngineSubsystem → UTakeRecorderSubsystem
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| TakeRecorderCancelled | FTakeRecorderCancelled | Called when take recorder is cancelled | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderFinished | FTakeRecorderFinished | Called when take recorder has finished | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderInitialized | FTakeRecorderInitialized | Called when take recorder is initializing. | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderMarkedFrameAdded | FTakeRecorderMarkedFrameAdded | Called when a marked frame is added to take recorder | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderPreInitialize | FTakeRecorderPreInitialize | Called before initialization occurs (ie. when the recording button is pressed and before the countdown starts) | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderSlateChanged | FTakeRecorderSlateChanged | Called when a take recorder slate changes. | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderSourceAdded | FOnTakeRecorderSourceAddedDynamic | Multicast delegate when any source has been added. | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderSourceRemoved | FOnTakeRecorderSourceRemovedDynamic | Multicast delegate when any source has been removed. | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderStarted | FTakeRecorderStarted | Called when take recorder is started | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderStopped | FTakeRecorderStopped | Called when take recorder is stopped | Recorder/TakeRecorderSubsystem.h |
|
| TakeRecorderTakeNumberChanged | FTakeRecorderTakeNumberChanged | Called when a take recorder take number changes. | Recorder/TakeRecorderSubsystem.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Implementation | TScriptInterface< ITakeRecorderSubsystemInterface > | The actual Take Recorder Subsystem implementation. | Recorder/TakeRecorderSubsystem.h | |
| OnRecordingCancelledEvent | FOnTakeRecordingCancelled | Multicast delegate for when a recording has been cancelled. For native binding. | Recorder/TakeRecorderSubsystem.h | |
| OnRecordingFinishedEvent | FOnTakeRecordingFinished | Multicast delegate for when a recording has finished. For native binding. | Recorder/TakeRecorderSubsystem.h | |
| OnRecordingPreInitializeEvent | FOnTakeRecordingPreInitialize | These native delegates are declared elsewhere throughout Take Recorder and we reuse them here. | Recorder/TakeRecorderSubsystem.h | |
| OnRecordingSourceAddedEvent | UTakeRecorderSources::FOnSourceAdded | Multicast delegate when any source has been added. For native binding. | Recorder/TakeRecorderSubsystem.h | |
| OnRecordingSourceRemovedEvent | UTakeRecorderSources::FOnSourceRemoved | Multicast delegate when any source has been added. For native binding. | Recorder/TakeRecorderSubsystem.h | |
| OnRecordingStartedEvent | FOnTakeRecordingStarted | Multicast delegate for when a recording is started. For native binding. | Recorder/TakeRecorderSubsystem.h | |
| OnRecordingStoppedEvent | FOnTakeRecordingStopped | Multicast delegate for when a recording has stopped. For native binding. | Recorder/TakeRecorderSubsystem.h | |
| ORecordingInitializedEvent | FOnTakeRecordingInitialized | Multicast delegate when recording is initialized. For native binding. | Recorder/TakeRecorderSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOnTakeRecordingCancelled & GetOnRecordingCancelledEvent() |
Retrieve a multi-cast delegate that is triggered when a recording is cancelled. | Recorder/TakeRecorderSubsystem.h | |
FOnTakeRecordingFinished & GetOnRecordingFinishedEvent() |
Retrieve a multi-cast delegate that is triggered when a recording finishes | Recorder/TakeRecorderSubsystem.h | |
FOnTakeRecordingInitialized & GetOnRecordingInitializedEvent() |
Retrieve a multi-cast delegate that is triggered when a recording initializes | Recorder/TakeRecorderSubsystem.h | |
FOnTakeRecordingInitialized & GetOnRecordingPreInitializedEvent() |
Retrieve a multi-cast delegate that is triggered when a recording pre-initializes | Recorder/TakeRecorderSubsystem.h | |
UTakeRecorderSources::FOnSourceAdded & GetOnRecordingSourceAddedEvent() |
Retrieve a multi-cast delegate that is triggered when a source is added. | Recorder/TakeRecorderSubsystem.h | |
UTakeRecorderSources::FOnSourceRemoved & GetOnRecordingSourceRemovedEvent() |
Retrieve a multi-cast delegate that is triggered when a source is removed. | Recorder/TakeRecorderSubsystem.h | |
FOnTakeRecordingStarted & GetOnRecordingStartedEvent() |
Retrieve a multi-cast delegate that is triggered when a recording starts | Recorder/TakeRecorderSubsystem.h | |
FOnTakeRecordingStopped & GetOnRecordingStoppedEvent() |
Retrieve a multi-cast delegate that is triggered when a recording is stopped | Recorder/TakeRecorderSubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
Recorder/TakeRecorderSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
Recorder/TakeRecorderSubsystem.h |
Overridden from ITakeRecorderSubsystemInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UTakeRecorderSource * AddSource
(
const TSubclassOf< UTakeRecorderSource > InSourceClass |
~Begin Sources | Recorder/TakeRecorderSubsystem.h |
|
virtual void AddSourceForActor
(
AActor* InActor, |
Add an actor as a source. | Recorder/TakeRecorderSubsystem.h |
|
virtual void CancelRecording
(
bool bShowConfirmMessage |
Cancel an in-progress recording. | Recorder/TakeRecorderSubsystem.h |
|
virtual bool CanReviewLastRecording() |
Can we review the last recording? | Recorder/TakeRecorderSubsystem.h |
|
virtual void ClearPendingTake() |
Clear the pending take. | Recorder/TakeRecorderSubsystem.h |
|
virtual void ClearSources() |
Remove all sources from the current sequence. | Recorder/TakeRecorderSubsystem.h |
|
virtual TArrayView< UTakeRecorderSource *const > GetAllSources() |
Retrieve all sources for the current sequence. | Recorder/TakeRecorderSubsystem.h | |
virtual TArray< UTakeRecorderSource * > GetAllSourcesCopy () |
Retrieves a copy of the list of sources that are being recorded. | Recorder/TakeRecorderSubsystem.h |
|
virtual FFrameRate GetFrameRate() |
Access the frame rate for this take | Recorder/TakeRecorderSubsystem.h |
|
virtual FTakeRecorderParameters GetGlobalRecordSettings() |
Retrieve the global take recorder settings. | Recorder/TakeRecorderSubsystem.h |
|
virtual ULevelSequence * GetLastRecordedLevelSequence() |
Retrieve the Last Recorded Level Sequence if it exists. | Recorder/TakeRecorderSubsystem.h |
|
virtual ULevelSequence * GetLevelSequence() |
Return the level sequence we are using. | Recorder/TakeRecorderSubsystem.h |
|
virtual UTakeRecorderNamingTokensData * GetNamingTokensData() |
Retrieve relevant Naming Tokens data for Take Recorder. | Recorder/TakeRecorderSubsystem.h | |
virtual int32 GetNextTakeNumber
(
const FString& InSlate |
Compute the next take number given a slate. | Recorder/TakeRecorderSubsystem.h |
|
virtual void GetNumberOfTakes
(
const FString& InSlate, |
Find both the current maximum take value and the total number of takes for a given slate. | Recorder/TakeRecorderSubsystem.h |
|
virtual UTakePreset * GetPendingTake() |
Retrieve the pending take. This may be null. | Recorder/TakeRecorderSubsystem.h |
|
virtual ULevelSequence * GetRecordingLevelSequence() |
Retrieve the Recording Level Sequence if it exists. | Recorder/TakeRecorderSubsystem.h | |
virtual ULevelSequence * GetRecordIntoLevelSequence() |
Retrieve the Record Into Level Sequence if it exists. | Recorder/TakeRecorderSubsystem.h | |
virtual TArray< FAssetData > GetSlates
(
FName InPackagePath |
Retrieve all slates. | Recorder/TakeRecorderSubsystem.h |
|
virtual AActor * GetSourceActor
(
UTakeRecorderSource* InSource |
Retrieve the actor from a source, if applicable. | Recorder/TakeRecorderSubsystem.h |
|
virtual UTakeRecorderSource * GetSourceByClass
(
const TSubclassOf< UTakeRecorderSource > InSourceClass |
Retrieve the first source of the given class. | Recorder/TakeRecorderSubsystem.h |
|
| Retrieve additional settings objects from a source. | Recorder/TakeRecorderSubsystem.h |
|
|
virtual UTakeRecorderSources * GetSources() |
Retrieve the sources. | Recorder/TakeRecorderSubsystem.h |
|
virtual ETakeRecorderState GetState() |
Retrieve the current take recorder state. | Recorder/TakeRecorderSubsystem.h |
|
virtual ULevelSequence * GetSuppliedLevelSequence() |
Retrieve the Supplied Level Sequence if it exists. | Recorder/TakeRecorderSubsystem.h | |
virtual UTakeMetaData * GetTakeMetaData() |
Retrieve the current meta data. | Recorder/TakeRecorderSubsystem.h |
|
virtual ETakeRecorderMode GetTakeRecorderMode() |
The current take recorder mode. | Recorder/TakeRecorderSubsystem.h |
|
virtual UTakePreset * GetTransientPreset() |
Retrieve the transient preset the subsystem is using. | Recorder/TakeRecorderSubsystem.h | |
virtual bool HasPendingChanges() |
Recorder/TakeRecorderSubsystem.h | ||
virtual void ImportPreset
(
const FAssetData& InPreset |
Import a preset to the transient preset. | Recorder/TakeRecorderSubsystem.h | |
virtual bool IsRecording() |
If Take Recorder is currently recording. | Recorder/TakeRecorderSubsystem.h |
|
virtual bool IsReviewing() |
If Take Recorder is currently reviewing. | Recorder/TakeRecorderSubsystem.h |
|
virtual bool MarkFrame() |
Mark the current frame. | Recorder/TakeRecorderSubsystem.h |
|
virtual void RemoveActorFromSources
(
AActor* InActor |
Remove an actor from available sources. | Recorder/TakeRecorderSubsystem.h |
|
virtual void RemoveSource
(
UTakeRecorderSource* InSource |
Remove a given source. | Recorder/TakeRecorderSubsystem.h |
|
virtual void ResetToPendingTake() |
Reset to the pending take. | Recorder/TakeRecorderSubsystem.h |
|
virtual void RevertChanges() |
Revert any changes restoring the preset origin. | Recorder/TakeRecorderSubsystem.h |
|
virtual bool ReviewLastRecording() |
Supply the last recording if it exists. | Recorder/TakeRecorderSubsystem.h |
|
virtual void SetFrameRate
(
FFrameRate InFrameRate |
Set the frame rate for this take | Recorder/TakeRecorderSubsystem.h |
|
virtual void SetFrameRateFromTimecode() |
Set if the frame rate is set from the Timecode frame rate | Recorder/TakeRecorderSubsystem.h |
|
virtual void SetGlobalRecordSettings
(
const FTakeRecorderParameters& InParameters |
Set the global take recorder settings. | Recorder/TakeRecorderSubsystem.h |
|
virtual void SetRecordIntoLevelSequence
(
ULevelSequence* LevelSequence |
Set the record into level sequence. | Recorder/TakeRecorderSubsystem.h | |
virtual void SetSequenceCountdown
(
float InSeconds |
Sets the current sequence's countdown. | Recorder/TakeRecorderSubsystem.h |
|
virtual void SetSlateName
(
const FString& InSlateName, |
Directly set the slate name. | Recorder/TakeRecorderSubsystem.h |
|
virtual void SetTakeNumber
(
int32 InNewTakeNumber, |
Directly set the take number. | Recorder/TakeRecorderSubsystem.h |
|
virtual void SetTargetSequence
(
const FTakeRecorderSequenceParameters& InData |
Provide sequence data for this take recorder. | Recorder/TakeRecorderSubsystem.h |
|
virtual bool StartRecording
(
bool bOpenSequencer, |
Begin a new recording. | Recorder/TakeRecorderSubsystem.h |
|
virtual void StopRecording() |
Stop an existing recording. | Recorder/TakeRecorderSubsystem.h |
|
virtual bool TryGetSequenceCountdown
(
float& OutValue |
Retrieve the current sequence's countdown. | Recorder/TakeRecorderSubsystem.h |
|