| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCapture.h |
Include |
#include "MovieSceneCapture.h" |
class UMovieSceneCapture :
public UObject,
public IMovieSceneCaptureInterface,
public ICaptureProtocolHost
Class responsible for capturing scene data
Name | Description | ||
---|---|---|---|
|
AdditionalCommandLineArguments |
Additional command line arguments to pass to the external process when capturing |
|
|
AudioCaptureProtocol |
||
|
AudioCaptureProtocolType |
The type of capture protocol to use for audio data. |
|
|
bCapturing |
Whether we have started capturing or not |
|
|
bCloseEditorWhenCaptureStarts |
When enabled, the editor will shutdown when the capture starts |
|
|
bFinalizeWhenReady |
Whether we should automatically attempt to capture frames every tick or not |
|
|
bIsAudioCapturePass |
If we're currently doing an audio pass or not |
|
|
bUseSeparateProcess |
Whether to capture the movie in a separate process or not |
|
|
CachedMetrics |
Cached metrics for this capture operation |
|
|
CachedQualityLevels |
Cached quality levels |
|
|
TSharedPtr< ICa... |
CaptureStrategy |
Strategy used for capture (real-time/fixed-time-step) |
|
FormatMappings |
Format mappings used for generating filenames |
|
|
FrameNumberOffset |
Frame number index offset when saving out frames. |
|
|
Handle |
Our unique handle, used for external representation without having to link to the MovieSceneCapture module |
|
|
ImageCaptureProtocol |
Capture protocol responsible for actually capturing frame data |
|
|
ImageCaptureProtocolType |
The type of capture protocol to use for image data |
|
|
InheritedCommandLineArguments |
Command line arguments inherited from this process |
|
|
InitSettings |
The settings we will use to set up the capture protocol |
|
|
OnCaptureFinishedDelegate |
Event that is triggered when capturing has finished |
|
|
Settings |
Settings that define how to capture |
Name | Description | |
---|---|---|
|
UMovieSceneCapture ( |
Name | Description | ||
---|---|---|---|
|
AddFormatMappings ( |
Add additional format mappings to be used when generating filenames |
|
|
CaptureThisFrame ( |
Indicate that this frame should be captured - must be called before the movie scene capture is ticked |
|
|
DeserializeAdditionalJson ( |
Custom, additional json deserialization |
|
|
DeserializeJson ( |
Deserialize additional json data for this capture |
|
|
Finalize() |
Finalize the capturing process, assumes all frames have been processed. |
|
|
FinalizeWhenReady() |
Automatically finalizes the capture when all currently pending frames are dealt with |
|
|
ForciblyReinitializeCaptureProtocols() |
||
|
UMovieSceneC... |
GetAudioCaptureProtocol() |
|
|
UMovieSceneC... |
GetImageCaptureProtocol() |
Access the capture protocol we are using |
|
const FCache... |
GetMetrics() |
Access this object's cached metrics |
|
InitializeCaptureProtocols() |
Initialize the settings structure for the current capture type |
|
|
IsAudioPassIfNeeded() |
Returns true if this is currently the audio pass, or if an audio pass is not needed. |
|
|
LoadFromConfig() |
Load save from config helpers |
|
|
FOnCaptureFi... |
OnCaptureFinished() |
|
|
OnTick ( |
Called at the end of a frame, before a frame is presented by slate |
|
|
SaveToConfig() |
||
|
SerializeAdditionalJson ( |
Custom, additional json serialization |
|
|
SerializeJson ( |
Serialize additional json data for this capture |
|
|
SetAudioCaptureProtocolType |
||
|
SetImageCaptureProtocolType |
||
|
ShouldFinalize() |
Check whether we should automatically finalize this capture |
|
|
StartCapture() |
Initialize the capture so that it is able to start capturing frames |
|
|
StartWarmup() |
Starts warming up. |
|
|
Tick ( |
Called at the end of a frame, before a frame is presented by slate |
Name | Description | ||
---|---|---|---|
|
IsDestructionThreadSafe() |
Called during garbage collection to determine if an object can have its destructor called on a worker thread. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
Name | Description | ||
---|---|---|---|
|
Close() |
Shut down this movie capture |
|
|
const int32 |
GetFrameNumberOffset() |
Access Frame Number Offset |
|
FMovieSceneC... |
GetHandle() |
Get a unique handle to this object |
|
const FMovie... |
GetSettings() |
Access specific movie scene capture settings |
|
Initialize ( |
Initialize this capture object by binding it to the specified viewport |
|
|
StartCapturing() |
Instruct this capture to start capturing frames |
Name | Description | ||
---|---|---|---|
|
GetCaptureFrameRate() |
Get the capture frequency |
|
|
const ICaptu... |
GetCaptureStrategy() |
Access the host's capture strategy |
|
double |
GetEstimatedCaptureDurationSeconds() |
Estimate how long our duration is going to be for pre-allocation purposes. |
|
ResolveFileFormat ( |
Resolve the specified format using the user supplied formatting rules. |
Name |
Description |
|
---|---|---|
|
FOnCaptureFinished |
Event that is fired after we've finished capturing |
Name |
Description |
---|---|
MovieSceneCaptureUIName |
This name is used by the UI to save/load a specific instance of the settings from config that doesn't affect the CDO which would affect scripting environments. |