Navigation
API > API/Plugins > API/Plugins/TakeRecorder > API/Plugins/TakeRecorder/Recorder
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UTakeRecorder
References
| Module | TakeRecorder |
| Header | /Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorder/Public/Recorder/TakeRecorder.h |
| Include | #include "Recorder/TakeRecorder.h" |
Syntax
UCLASS&40;BlueprintType&41;
class UTakeRecorder : public UObject
Constructors
| Type | Name | Description | |
|---|---|---|---|
UTakeRecorder
(
const FObjectInitializer& ObjInit |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Cancel () |
Called to cancel the recording | |
| UTakeRecorder * | Retrieve the currently active take recorder instance | ||
| float | Access the number of seconds remaining before this recording will start | ||
| ULevelSequence * | GetSequence () |
Access the sequence asset that this recorder is recording into | |
| ETakeRecorderState | GetState () |
Get the current state of this recorder | |
| bool | Initialize
(
ULevelSequence* LevelSequenceBase, |
Initialize a new recording with the specified parameters. | |
| FOnTakeRecordingCancelled & | Retrieve a multi-cast delegate that is triggered when this recording is cancelled | ||
| FOnTakeRecordingFinished & | Retrieve a multi-cast delegate that is triggered when this recording finishes | ||
| FOnTakeRecordingInitialized & | Retrieve a multi-cast delegate that is triggered when a new recording begins | ||
| FOnTakeRecordingPreInitialize & | Retrieve a multi-cast delegate that is triggered before initialization occurs (ie. when the recording button is pressed and before the countdown starts) | ||
| FOnTakeRecordingStarted & | Retrieve a multi-cast delegate that is triggered when this recording starts | ||
| FOnTakeRecordingStopped & | Retrieve a multi-cast delegate that is triggered when this recording is stopped | ||
| FOnStartPlayFrameModified & | Retrieve a multi-cast delegate that is triggered when a delta time has been applied to the Movie Scene | ||
| void | SetDisableSaveTick
(
bool |
Disable saving data on tick event. This make the TakeRecord a no-op. | |
| void | Stop () |
Called to stop the recording | |
| FTakeRecorderParameterOverride & | On take initialization overrides provide a mechanism to adjust parameter values when a new take is initialized. |
Constants
| Name | Description |
|---|---|
| OnRecordingInitializedEvent | Event to trigger when a new recording is initialized |