1. Epic GamesDeveloper
  3. UTakeRecorder

UTakeRecorder

API > API/Plugins > API/Plugins/TakeRecorder

   
Name UTakeRecorder
Type class
Header File /Engine/Plugins/VirtualProduction/Takes/Source/TakeRecorder/Public/Recorder/TakeRecorder.h
Include Path #include "Recorder/TakeRecorder.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UTakeRecorder : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UTakeRecorder ( const FObjectInitializer& ObjInit
)

   Recorder/TakeRecorder.h  

Constants

Name Type Remarks Include Path
OnRecordingInitializedEvent FOnTakeRecordingInitialized Event to trigger when a new recording is initialized Recorder/TakeRecorder.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedAllowEditsMode EAllowEditsMode   Recorder/TakeRecorder.h  
CachedAutoChangeMode EAutoChangeMode   Recorder/TakeRecorder.h  
CachedClockSource EUpdateClockSource   Recorder/TakeRecorder.h  
CachedPlaybackRange TRange< FFrameNumber >   Recorder/TakeRecorder.h  
CompileSuppression TUniquePtr< UE::MovieScene::FScopedVolatilityManagerSuppression >   Recorder/TakeRecorder.h  
CountdownSeconds float The number of seconds remaining before Start() should be called Recorder/TakeRecorder.h  
CurrentFrameTime FFrameTime FFrameTime in MovieScene Resolution we are at Recorder/TakeRecorder.h  
ManifestSerializer FManifestSerializer   Recorder/TakeRecorder.h  
NumberOfTicksAfterPre int32 Due a few ticks after the pre so we are set up with asset creation Recorder/TakeRecorder.h  
OnFrameModifiedEvent FOnStartPlayFrameModified Triggered when the movie scene is adjusted. Recorder/TakeRecorder.h  
OnRecordingCancelledEvent FOnTakeRecordingCancelled Triggered when this recorder is cancelled Recorder/TakeRecorder.h  
OnRecordingFinishedEvent FOnTakeRecordingFinished Triggered when this recorder finishes Recorder/TakeRecorder.h  
OnRecordingPreInitializeEvent FOnTakeRecordingPreInitialize Triggered before the recorder is initialized Recorder/TakeRecorder.h  
OnRecordingStartedEvent FOnTakeRecordingStarted Triggered when this recorder starts Recorder/TakeRecorder.h  
OnRecordingStoppedEvent FOnTakeRecordingStopped Triggered when this recorder is stopped Recorder/TakeRecorder.h  
OnStopCleanup TArray< TFunction< void()> > Anonymous array of cleanup functions to perform when a recording has finished Recorder/TakeRecorder.h  
OnTickRecordingEvent FOnTickRecording Triggered when this recorder ticks Recorder/TakeRecorder.h  
OverlayWidget TObjectPtr< UTakeRecorderOverlayWidget > The overlay widget for this recording Recorder/TakeRecorder.h
  • Transient
Parameters FTakeRecorderParameters Parameters for the recorder - marked up as a uproperty to support reference collection Recorder/TakeRecorder.h  
SequenceAsset TObjectPtr< ULevelSequence > The asset that we should output recorded data into Recorder/TakeRecorder.h
  • Transient
State ETakeRecorderState The state of this recorder instance Recorder/TakeRecorder.h  
StopRecordingFrame TOptional< FFrameNumber > Optional frame to stop recording at Recorder/TakeRecorder.h  
TimecodeAtStart FTimecode Timecode at the start of recording Recorder/TakeRecorder.h  
WeakSequencer TWeakPtr< ISequencer > Sequencer ptr that controls playback of the destination asset during the recording Recorder/TakeRecorder.h  
WeakWorld TWeakObjectPtr< UWorld > The world that we are recording within Recorder/TakeRecorder.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Cancel()

 Called to cancel the recording Recorder/TakeRecorder.h  

float GetCountdownSeconds()

 Access the number of seconds remaining before this recording will start Recorder/TakeRecorder.h
  • BlueprintCallable
  • Category="Take Recorder"

ULevelSequence * GetSequence()

 Access the sequence asset that this recorder is recording into Recorder/TakeRecorder.h
  • BlueprintCallable
  • Category="Take Recorder"

ETakeRecorderState GetState()

 Get the current state of this recorder Recorder/TakeRecorder.h
  • BlueprintCallable
  • Category="Take Recorder"

bool Initialize ( ULevelSequence* LevelSequenceBase,
UTakeRecorderSources* Sources,
UTakeMetaData* MetaData,
const FTakeRecorderParameters& InParameters,
FText* OutError
)

 Initialize a new recording with the specified parameters. Recorder/TakeRecorder.h  

FOnTakeRecordingCancelled & OnRecordingCancelled()

 Retrieve a multi-cast delegate that is triggered when this recording is cancelled Recorder/TakeRecorder.h  

FOnTakeRecordingFinished & OnRecordingFinished()

 Retrieve a multi-cast delegate that is triggered when this recording finishes Recorder/TakeRecorder.h  

FOnTakeRecordingPreInitialize & OnRecordingPreInitialize()

 Retrieve a multi-cast delegate that is triggered before initialization occurs (ie. when the recording button is pressed and before the countdown starts) Recorder/TakeRecorder.h  

FOnTakeRecordingStarted & OnRecordingStarted()

 Retrieve a multi-cast delegate that is triggered when this recording starts Recorder/TakeRecorder.h  

FOnTakeRecordingStopped & OnRecordingStopped()

 Retrieve a multi-cast delegate that is triggered when this recording is stopped Recorder/TakeRecorder.h  

FOnStartPlayFrameModified & OnStartPlayFrameModified()

 Retrieve a multi-cast delegate that is triggered when a delta time has been applied to the Movie Scene Recorder/TakeRecorder.h  

FOnTickRecording & OnTickRecording()

 Retrieve a multi-cast delegate that is triggered when this recording ticks Recorder/TakeRecorder.h  

void SetCountdown ( float InSeconds
)

 Sets the current countdown time in seconds. Recorder/TakeRecorder.h
  • BlueprintCallable
  • Category="Take Recorder"

void SetDisableSaveTick ( bool
)

 Disable saving data on tick event. This make the TakeRecord a no-op. Recorder/TakeRecorder.h  

void Stop()

 Called to stop the recording Recorder/TakeRecorder.h  

Static

Name Remarks Include Path Unreal Specifiers

static UTakeRecorder * GetActiveRecorder()

 Retrieve the currently active take recorder instance Recorder/TakeRecorder.h  

static FOnTakeRecordingInitialized & OnRecordingInitialized()

 Retrieve a multi-cast delegate that is triggered when a new recording begins Recorder/TakeRecorder.h  

static bool SetActiveRecorder ( UTakeRecorder* NewActiveRecorder
)

 Set the currently active take recorder instance Recorder/TakeRecorder.h  

static FTakeRecorderParameterOverride & TakeInitializeParameterOverride()

 On take initialization overrides provide a mechanism to adjust parameter values when a new take is initialized. Recorder/TakeRecorder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page