1. Epic GamesDeveloper
  3. UMovieSceneCapture

UMovieSceneCapture

Class responsible for capturing scene data

Unreal Engine C++ API Reference > Runtime > MovieSceneCapture

Inheritance Hierarchy

References

   
Module MovieSceneCapture
Header /Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCapture.h
Include #include "MovieSceneCapture.h"

Syntax

class UMovieSceneCapture :  
    public UObject,  
    public IMovieSceneCaptureInterface,  
    public ICaptureProtocolHost

Remarks

Class responsible for capturing scene data

Variables

  Type Name Description
Public variable FString AdditionalCommandLineArguments Additional command line arguments to pass to the external process when capturing
Public variable TObjectPtr< UMovieSceneAudioCaptureProtocolBase > AudioCaptureProtocol  
Public variable FSoftClassPath AudioCaptureProtocolType The type of capture protocol to use for audio data.
Protected variable bool bCapturing Whether we have started capturing or not
Public variable bool bCloseEditorWhenCaptureStarts When enabled, the editor will shutdown when the capture starts
Protected variable bool bFinalizeWhenReady Whether we should automatically attempt to capture frames every tick or not
Protected variable bool bIsAudioCapturePass If we're currently doing an audio pass or not
Public variable bool bUseSeparateProcess Whether to capture the movie in a separate process or not
Protected variable FCachedMetrics CachedMetrics Cached metrics for this capture operation
Protected variable Scalability::FQualityLevels CachedQualityLevels Cached quality levels
Protected variable TSharedPtr< ICaptureStrategy > CaptureStrategy Strategy used for capture (real-time/fixed-time-step)
Protected variable TMap< FString, FStringFormatArg > FormatMappings Format mappings used for generating filenames
Protected variable int32 FrameNumberOffset Frame number index offset when saving out frames.
Protected variable FMovieSceneCaptureHandle Handle Our unique handle, used for external representation without having to link to the MovieSceneCapture module
Public variable TObjectPtr< UMovieSceneImageCaptureProtocolBase > ImageCaptureProtocol Capture protocol responsible for actually capturing frame data
Public variable FSoftClassPath ImageCaptureProtocolType The type of capture protocol to use for image data
Public variable FString InheritedCommandLineArguments Command line arguments inherited from this process
Protected variable TOptional< FCaptureProtocolInitSettings > InitSettings The settings we will use to set up the capture protocol
Protected variable FOnCaptureFinished OnCaptureFinishedDelegate Event that is triggered when capturing has finished
Public variable FMovieSceneCaptureSettings Settings Settings that define how to capture

Constructors

  Type Name Description
Public function  

UMovieSceneCapture ( const FObjectInitializer& Initializer
)

  

Functions

  Type Name Description
Protected function Virtual Const void

AddFormatMappings ( TMap< FString, FStringFormatArg >& OutFormatMappings,
const FFrameMetrics& FrameMetrics
)

 Add additional format mappings to be used when generating filenames
Public function void

CaptureThisFrame ( float DeltaSeconds
)

 Indicate that this frame should be captured - must be called before the movie scene capture is ticked
Protected function Virtual void Custom, additional json deserialization
Public function void

DeserializeJson ( const FJsonObject& Object
)

 Deserialize additional json data for this capture
Public function void Finalize the capturing process, assumes all frames have been processed.
Public function void Automatically finalizes the capture when all currently pending frames are dealt with
Protected function void  
Public function UMovieSceneCaptureProtocolBase *  
Public function UMovieSceneCaptureProtocolBase * Access the capture protocol we are using
Public function Const const FCachedMetrics & Access this object's cached metrics
Protected function void Initialize the settings structure for the current capture type
Protected function Virtual Const bool Returns true if this is currently the audio pass, or if an audio pass is not needed.
Public function Virtual void Load save from config helpers
Public function FOnCaptureFinished &  
Protected function Virtual void

OnTick ( float DeltaSeconds
)

 Called at the end of a frame, before a frame is presented by slate
Public function Virtual void  
Protected function Virtual void Custom, additional json serialization
Public function void Serialize additional json data for this capture
Public function void  
Public function void  
Public function Const bool Check whether we should automatically finalize this capture
Public function void Initialize the capture so that it is able to start capturing frames
Public function void Starts warming up.
Public function void

Tick ( float DeltaSeconds
)

 Called at the end of a frame, before a frame is presented by slate

Overridden from UObject

  Type Name Description
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from IMovieSceneCaptureInterface

  Type Name Description
Public function Virtual void

Close ()

 Shut down this movie capture
Public function Virtual Const const int32 Access Frame Number Offset
Public function Virtual Const FMovieSceneCaptureHandle Get a unique handle to this object
Public function Virtual Const const FMovieSceneCaptureSettings & Access specific movie scene capture settings
Public function Virtual void

Initialize ( TSharedPtr< FSceneViewport > Viewport,
int32 PIEInstance
)

 Initialize this capture object by binding it to the specified viewport
Public function Virtual void Instruct this capture to start capturing frames

Overridden from ICaptureProtocolHost

  Type Name Description
Public function Virtual Const FFrameRate Get the capture frequency
Public function Virtual Const const ICaptureStrategy & Access the host's capture strategy
Public function Virtual Const double Estimate how long our duration is going to be for pre-allocation purposes.
Public function Virtual Const FString

ResolveFileFormat ( const FString& Format,
const FFrameMetrics& FrameMetrics
)

 Resolve the specified format using the user supplied formatting rules.

Classes

  Type Name Description
Public class FOnCaptureFinished Event that is fired after we've finished capturing  

Constants

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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page