Navigation
API > API/Plugins > API/Plugins/CacheTrackRecorder
| Name | UCacheTrackRecorder |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Takes/Source/CacheTrackRecorder/Public/Recorder/CacheTrackRecorder.h |
| Include Path | #include "Recorder/CacheTrackRecorder.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UCacheTrackRecorder : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCacheTrackRecorder
Structs
| Name | Remarks |
|---|---|
| FSavedState |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedClockSource | EUpdateClockSource | Recorder/CacheTrackRecorder.h | ||
| CachedPlaybackRange | TRange< FFrameNumber > | Recorder/CacheTrackRecorder.h | ||
| CachedViewRange | TRange< double > | Recorder/CacheTrackRecorder.h | ||
| CacheTracks | TArray< FCachedTrackSource > | Recorder/CacheTrackRecorder.h | ||
| CurrentFrameTime | FFrameTime | FFrameTime in MovieScene Resolution we are at | Recorder/CacheTrackRecorder.h | |
| NumberOfTicksAfterPre | int32 | Due a few ticks after the pre so we are set up with asset creation | Recorder/CacheTrackRecorder.h | |
| OnStopCleanup | TArray< TFunction< void()> > | Anonymous array of cleanup functions to perform when a recording has finished | Recorder/CacheTrackRecorder.h | |
| Parameters | FCacheRecorderParameters | Parameters for the recorder - marked up as a uproperty to support reference collection | Recorder/CacheTrackRecorder.h | |
| SavedState | FSavedState | Recorder/CacheTrackRecorder.h | ||
| SequenceAsset | TObjectPtr< ULevelSequence > | The asset that we should output recorded data into | Recorder/CacheTrackRecorder.h |
|
| State | ECacheTrackRecorderState | The state of this recorder instance | Recorder/CacheTrackRecorder.h | |
| StopRecordingFrame | TOptional< FFrameNumber > | Optional frame to stop recording at | Recorder/CacheTrackRecorder.h | |
| TimecodeAtStart | FTimecode | Timecode at the start of recording | Recorder/CacheTrackRecorder.h | |
| WeakSequencer | TWeakPtr< ISequencer > | Sequencer ptr that controls playback of the desination asset during the recording | Recorder/CacheTrackRecorder.h | |
| WeakWorld | TWeakObjectPtr< UWorld > | The world that we are recording within | Recorder/CacheTrackRecorder.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Cancel() |
Called to cancel the recording | Recorder/CacheTrackRecorder.h | |
FQualifiedFrameTime GetRecordTime() |
The time at which to record. Taken from the Sequencer global time, otherwise based on timecode | Recorder/CacheTrackRecorder.h | |
ULevelSequence * GetSequence() |
Access the sequence asset that this recorder is recording into | Recorder/CacheTrackRecorder.h |
|
ECacheTrackRecorderState GetState() |
Get the current state of this recorder | Recorder/CacheTrackRecorder.h |
|
bool Initialize
(
ULevelSequence* RootLevelSequence, |
Initialize a new recording with the specified parameters. | Recorder/CacheTrackRecorder.h | |
void Stop() |
Called to stop the recording | Recorder/CacheTrackRecorder.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UCacheTrackRecorder * GetActiveRecorder() |
Retrieve the currently active take recorder instance | Recorder/CacheTrackRecorder.h | |
static void RecordCacheTrack
(
IMovieSceneCachedTrack* Track, |
Utility method to record a single cache track | Recorder/CacheTrackRecorder.h | |
static void RecordCacheTracks
(
const TArray< IMovieSceneCachedTrack* >& CacheTracks, |
Utility method to record several cache tracks at once | Recorder/CacheTrackRecorder.h | |
static void RecordSelectedTracks
(
TSharedPtr< ISequencer > Sequencer, |
Utility method to record all the cache tracks selected in sequencer | Recorder/CacheTrackRecorder.h | |
static bool SetActiveRecorder
(
UCacheTrackRecorder* NewActiveRecorder |
Set the currently active take recorder instance | Recorder/CacheTrackRecorder.h |